List all automations a contact is in

List the automations contacts are in, optionally filtered by automation, contact, run status or entry date.

Each record represents one contact's run through one automation. contact is the contact ID, seriesid is the automation ID, and status is 1 while the run is in progress and 2 once it has ended.

{
    "contactAutomations": [
        {
            "contact": "10003",
            "seriesid": "1",
            "startid": "0",
            "status": "2",
            "batchid": null,
            "adddate": "2018-11-16T02:32:33-06:00",
            "remdate": "2018-11-16T02:32:33-06:00",
            "timespan": "0",
            "lastblock": "1",
            "lastlogid": "0",
            "lastdate": "2018-11-16T02:32:33-06:00",
            "completedElements": "0",
            "totalElements": "1",
            "completed": 1,
            "completeValue": 100,
            "links": {
                "automation": "https://:account.api-us1.com/api/:version/contactAutomations/1/automation",
                "contact": "https://:account.api-us1.com/api/:version/contactAutomations/1/contact",
                "contactGoals": "https://:account.api-us1.com/api/:version/contactAutomations/1/contactGoals"
            },
            "id": "1",
            "automation": "1"
        }
    ],
    "meta": {
        "total": "1",
        "showcase_stats": []
    }
}
Query Params
int32

Filter by the automation the contact is in. Supported operators: eq, gt, gte, lt, lte, in. Example: filters[seriesid][gt]=3

int32

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

int32

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

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

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

string
enum

Order by the date the contact entered the automation

Allowed:
string
enum

Order by run status

Allowed:
string
enum

Order by automation ID

Allowed:
string
enum

Order by contact ID

Allowed:
int32
Defaults to 20

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

int32
Defaults to 0

Offset index of records to return.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json