MAmailchimp
automations

List automations

Get a summary of an account's classic automations.

get/3.0/automations

Request

Query parameters

countinteger

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

offsetinteger

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

fieldsstring[]

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

exclude_fieldsstring[]

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

before_create_timestring date-time

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

since_create_timestring date-time

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

before_start_timestring date-time

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

since_start_timestring date-time

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

status'save' | 'paused' | 'sending'

Restrict the results to automations with the specified status.

Response

total_itemsinteger

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

Example response

{
  "automations": [
    {
      "recipients": {
        "segment_opts": [
          {
            "field": "aim",
            "op": "open",
            "value": "any"
          }
        ],
        "store_id": "1a2df69xxx"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.