List automations

GET

https://api.mailchimp.com/3.0/automations

GET

/3.0/automations

curl https://api.mailchimp.com/3.0/automations \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "automations": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "create_time": "2024-01-15T09:30:00Z",
      "emails_sent": 1,
      "id": "string",
      "recipients": {
        "list_id": "string",
        "list_is_active": true,
        "list_name": "string",
        "segment_opts": [
          {
            "condition_type": "Aim",
            "field": "aim",
            "op": "open",
            "value": "any"
          }
        ],
        "store_id": "1a2df69xxx"
      },
      "report_summary": {
        "click_rate": 1.1,
        "clicks": 1,
        "open_rate": 1.1,
        "opens": 1,
        "subscriber_clicks": 1,
        "unique_opens": 1
      },
      "settings": {
        "authenticate": true,
        "auto_footer": true,
        "from_name": "string",
        "inline_css": true,
        "reply_to": "string",
        "title": "string",
        "to_name": "string",
        "use_conversation": true
      },
      "start_time": "2024-01-15T09:30:00Z",
      "status": "save",
      "tracking": {
        "capsule": {
          "notes": true
        },
        "clicktale": "string",
        "ecomm360": true,
        "goal_tracking": true,
        "google_analytics": "string",
        "html_clicks": true,
        "opens": true,
        "salesforce": {
          "campaign": true,
          "notes": true
        },
        "text_clicks": true
      },
      "trigger_settings": {
        "workflow_type": "abandonedBrowse",
        "runtime": {
          "days": [
            "sunday"
          ],
          "hours": {
            "type": "send_asap"
          }
        },
        "workflow_emails_count": 1,
        "workflow_title": "string"
      }
    }
  ],
  "total_items": 1
}

Get a summary of an account’s classic automations.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Query parameters

countintegerOptional<=1000Defaults to 10

The number of records to return. Default value is 10. Maximum value is 1000

offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

before_create_timedatetimeOptional

Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_create_timedatetimeOptional

Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_start_timedatetimeOptional

Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_start_timedatetimeOptional

Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.

statusenumOptional

Restrict the results to automations with the specified status.

Allowed values:

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

automationslist of objectsOptional

An array of objects, each representing an Automation workflow.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.