List all contacts in an automation

get

https://{youraccountname}.api-us1.com/api/3/automations/{seriesId}/contactAutomations

List the contacts currently in, or that have run through, a single automation. This is a paginated equivalent of filtering /api/3/contactAutomations by filters[seriesid].

Path Params

seriesId

int32

required

ID of the automation to receive contacts for

Query Params

filters[subscriberid]

int32

Filter by contact ID. Supported operators: eq, gt, gte, lt, lte, in. Example: filters[subscriberid][gt]=10

filters[status]

int32

Filter by run status: 1 = in progress, 2 = ended. Supported operators: eq, gt, gte, lt, lte, in. Example: filters[status][gt]=1

filters[lastblock]

int32

Filter by the ID of the last automation block the contact reached. Supported operators: eq, gt, gte, lt, lte, in. Example: filters[lastblock][gt]=5

filters[adddate]

string

Filter by the date the contact entered the automation. Accepts YYYY-MM-DD (matches the whole day) or YYYY-MM-DD HH:MM:SS. Supported operators: eq, gt, gte, lt, lte, in. Example: filters[adddate][gt]=2026-01-01

orders[adddate]

string

enum

Order by the date the contact entered the automation

Allowed:

orders[status]

string

enum

Order by run status

Allowed:

orders[seriesid]

string

enum

Order by automation ID

Allowed:

orders[subscriberid]

string

enum

Order by contact ID

Allowed:

limit

int32

Defaults to 20

The number of records to return per request. Defaults to 20 and is capped at 100.

offset

int32

Defaults to 0

Offset index of records to return.

Response

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

200200