Get automation info

GET

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

GET

/3.0/automations/:workflow_id

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

200Retrieved

{
  "_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"
  }
}

Get a summary of an individual classic automation workflow’s settings and content. The trigger_settings object returns information for the first email in the workflow.

Authentication

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

Path parameters

workflow_idstringRequired

The unique id for the Automation workflow.

Query parameters

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.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

create_timedatetimeOptionalRead-only

The date and time the Automation was created in ISO 8601 format.

emails_sentintegerOptionalRead-only

The total number of emails sent for the Automation.

idstringOptionalRead-only

A string that identifies the Automation.

recipientsobjectOptional

List settings for the Automation.

report_summaryobjectOptional

A summary of opens and clicks for sent campaigns.

settingsobjectOptional

The settings for the Automation workflow.

start_timedatetimeOptionalRead-only

The date and time the Automation was started in ISO 8601 format.

statusenumOptionalRead-only

The current status of the Automation.

Allowed values:

trackingobjectOptional

The tracking options for the Automation.

trigger_settingsobjectOptional

Available triggers for Automation workflows.