--- title: "List automated emails" method: GET path: "/3.0/automations/{workflow_id}/emails" tags: ["automations"] --- # List automated emails `GET /3.0/automations/{workflow_id}/emails` ## Request - Base URL: `https://api.mailchimp.com` - URL: `https://api.mailchimp.com/3.0/automations/{workflow_id}/emails` - Auth: one of: - HTTP bearer - OAuth 2 - Authorization code: `https://login.mailchimp.com/oauth2/authorize` - Token URL: `https://login.mailchimp.com/oauth2/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Get a summary of the emails in a classic automation workflow. ## Path parameters - `workflow_id` string, required ## Response `200` - object: A summary of the emails in an Automation workflow. - `_links` array[]: A list of link types and descriptions for the API schema documents. - object[]: A list of link types and descriptions for the API schema documents. - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'. - `rel` string: As with an HTML 'rel' attribute, this describes the type of link. - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to. - `emails` object[]: An array of objects, each representing an email in an Automation workflow. - `_links` object[]: A list of link types and descriptions for the API schema documents. - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'. - `rel` string: As with an HTML 'rel' attribute, this describes the type of link. - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to. - `archive_url` string: The link to the campaign's archive version in ISO 8601 format. - `content_type` string: How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url'). - `create_time` string, date-time: The date and time the campaign was created in ISO 8601 format. - `delay` object: The delay settings for an Automation email. - `action` 'previous_campaign_sent' | 'previous_campaign_opened' | 'previous_campaign_not_opened' | 'previous_campaign_clicked_any' | 'previous_campaign_not_clicked_any' | 'previous_campaign_specific_clicked' | 'ecomm_bought_any' | 'ecomm_bought_product' | 'ecomm_bought_category' | 'ecomm_not_bought_any' | 'ecomm_abandoned_cart' | 'campaign_sent' | 'opened_email' | 'not_opened_email' | 'clicked_email' | 'not_clicked_email' | 'campaign_specific_clicked' | 'manual' | 'signup' | 'merge_changed' | 'group_add' | 'group_remove' | 'mandrill_sent' | 'mandrill_opened' | 'mandrill_clicked' | 'mandrill_any' | 'api' | 'goal' | 'annual' | 'birthday' | 'date' | 'date_added' | 'tag_add': The action that triggers the delay of an Automation email. - `action_description` string: The user-friendly description of the action that triggers an Automation email. - `amount` integer: The delay amount for an Automation email. - `direction` 'before' | 'after': Whether the delay settings describe before or after the delay action of an Automation email. - `full_description` string: The user-friendly description of the delay and trigger action settings for an Automation email. - `type` 'now' | 'day' | 'hour' | 'week': The type of delay for an Automation email. - `emails_sent` integer: The total number of emails sent for this campaign. - `has_logo_merge_tag` boolean: Determines if the campaign contains the *|BRAND:LOGO|* merge tag. - `id` string: A string that uniquely identifies the Automation email. - `needs_block_refresh` boolean: Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor. - `position` integer: The position of an Automation email in a workflow. - `recipients` object: List settings for the campaign. - `list_id` string: The unique list id. - `list_is_active` boolean: The status of the list used, namely if it's deleted or disabled. - `list_name` string: The name of the list. - `recipient_count` integer: Count of the recipients on the associated list. Formatted as an integer. - `segment_opts` object: An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options. - `conditions` union[]: Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas). - union - object: Segment by interaction with a specific campaign. - … - object: Segment by interaction with an Automation workflow. - … - object: Segment by poll activity. - … - object: Segment by interaction with a campaign via Conversations. - … - object: Segment by a specific date field. - … - object: Segment by use of a particular email client. - … - object: Segment by language. - … - object: Segment by member rating. - … - object: Segment by signup source. - … - object: Segment by interaction with a SurveyMonkey survey. - … - object: Segment by VIP status. - … - object: Segment by an interest group merge field. - … - object: Segment by purchases in specific items or categories. - … - object: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. - … - object: Segment by whether someone has purchased anything. - … - object: Segment by amount spent on a single order or across all orders. - … - object: Segment by purchases from a specific store. - … - object: Segment by Goal activity. - … - object: Segment by most recent interaction with a website. - … - object: Segment by similar subscribers. - … - object: Segment by a given static segment. - … - object: Segment by a specific country or US state. - … - object: Segment by a specific geographic region. - … - object: Segment by a specific US ZIP code. - … - object: Segment members whose location information is unknown. - … - object: Segment by a specific US ZIP code. - … - object: Segment by age ranges in Social Profiles data. - … - object: Segment by listed gender in Social Profiles data. - … - object: Segment by influence rating in Social Profiles data. - … - object: Segment by social network in Social Profiles data. - … - object: Segment by social network in Social Profiles data. - … - object: Segment by an address-type merge field. - … - object: Segment by an address-type merge field within a given distance. - … - object: Segment by a contact's birthday. - … - object: Segment by a given date merge field. - … - object: An individual segment condition - … - object: Segment by a given text or number merge field. - … - object: Segment by email address. - … - object: Segment by predicted gender. - … - object: Segment by predicted age. - … - object: Segment by when people subscribed. - … - `match` 'any' | 'all': Segment match type. - `prebuilt_segment_id` string: The prebuilt segment id, if a prebuilt segment has been designated for this campaign. - `saved_segment_id` union: The id for an existing saved segment. - integer - string - `segment_text` string: A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML. - `report_summary` object: For sent campaigns, a summary of opens and clicks. - `click_rate` number: The number of unique clicks divided by the total number of successful deliveries. - `clicks` integer: The total number of clicks for an campaign. - `open_rate` number: The number of unique opens divided by the total number of successful deliveries. - `opens` integer: The total number of opens for a campaign. - `subscriber_clicks` integer: The number of unique clicks. - `unique_opens` integer: The number of unique opens. - `send_time` string, date-time: The date and time a campaign was sent in ISO 8601 format - `settings` object: Settings for the campaign including the email subject, from name, and from email address. - `authenticate` boolean: Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`. - `auto_fb_post` string[]: An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to. - `auto_footer` boolean: Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign. - `auto_tweet` boolean: Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent. - `drag_and_drop` boolean: Whether the campaign uses the drag-and-drop editor. - `fb_comments` boolean: Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`. - `from_name` string: The 'from' name on the campaign (not an email address). - `inline_css` boolean: Automatically inline the CSS included with the campaign content. - `preview_text` string: The preview text for the campaign. - `reply_to` string: The reply-to email address for the campaign. - `subject_line` string: The subject line for the campaign. - `template_id` integer: The id for the template used in this campaign. - `title` string: The title of the campaign. - `social_card` object: The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/). - `description` string: A short summary of the campaign to display. - `image_url` string: The url for the header image for the card. - `title` string: The title for the card. Typically the subject line of the campaign. - `start_time` string, date-time: The date and time the campaign was started in ISO 8601 format. - `status` 'save' | 'paused' | 'sending': The current status of the campaign. - `tracking` object: The tracking options for a campaign. - `capsule` object: Deprecated - `notes` boolean: Update contact notes for a campaign based on a subscriber's email address. - `clicktale` string: The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes). - `ecomm360` boolean: Whether to enable e-commerce tracking. - `goal_tracking` boolean: Deprecated - `google_analytics` string: The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes). - `html_clicks` boolean: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. - `opens` boolean: Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. - `salesforce` object: Deprecated - `campaign` boolean: Create a campaign in a connected Salesforce account. - `notes` boolean: Update contact notes for a campaign based on a subscriber's email address. - `text_clicks` boolean: Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. - `trigger_settings` object: Available triggers for Automation workflows. - `runtime` object: A workflow's runtime settings for an Automation. - `days` string[]: The days an Automation workflow can send. - `hours` object: The hours an Automation workflow can send. - `type` 'send_asap' | 'send_between' | 'send_at', required: When to send the Automation email. - `workflow_emails_count` integer: The number of emails in the Automation workflow. - `workflow_title` string: The title of the workflow type. - `workflow_type` 'abandonedBrowse' | 'abandonedCart' | 'api' | 'bestCustomers' | 'categoryFollowup' | 'dateAdded' | 'emailFollowup' | 'emailSeries' | 'groupAdd' | 'groupRemove' | 'mandrill' | 'productFollowup' | 'purchaseFollowup' | 'recurringEvent' | 'specialEvent' | 'visitUrl' | 'welcomeSeries', required: The type of Automation workflow. - `web_id` integer: The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. - `workflow_id` string: A string that uniquely identifies an Automation workflow. - `total_items` integer: The total number of items matching the query regardless of pagination. ## Other responses - `default`: An error generated by the Mailchimp API. --- [API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)