List all automations the contact is in

The automation runs this contact has been in, one entry per time the contact entered an automation. status 1 means the contact is still moving through the automation; 2 means the run has ended. adddate is when the contact entered and remdate when the run ended. By default every run comes back in one response. Pass limit to page; offset then applies and defaults to 0. Without limit, offset is ignored. orders[lastdate]=ASC or DESC sorts by the last activity in the run; any other direction is rejected with 422. Returns 404 if the contact does not exist. To list runs across contacts, use GET /contactAutomations. The contactAutomations link on a contact sends limit=2500 and orders[lastdate]=DESC.

{
    "contactAutomations": [
        {
            "contact": "6",
            "seriesid": "2",
            "startid": "0",
            "status": "2",
            "batchid": "completed",
            "adddate": "2022-03-01T08:51:57-06:00",
            "remdate": "2022-03-01T08:51:58-06:00",
            "timespan": "1",
            "lastblock": "5",
            "lastlogid": "0",
            "lastdate": "2022-03-01T08:51:58-06:00",
            "in_als": "3",
            "completedElements": 0,
            "totalElements": 3,
            "completed": 1,
            "completeValue": 100,
            "links": {
                "automation": "https://:account.api-us1.com/api/3/contactAutomations/6/automation",
                "contact": "https://:account.api-us1.com/api/3/contactAutomations/6/contact",
                "contactGoals": "https://:account.api-us1.com/api/3/contactAutomations/6/contactGoals",
                "automationLogs": "https://:account.api-us1.com/api/3/contactAutomations/6/automationLogs"
            },
            "id": "6",
            "automation": "2"
        }
    ]
}
Path Params
int32
required

ID of the contact to receive automations for

Query Params
string
^(?:[aA][sS][cC]|[dD][eE][sS][cC])$

Order the rows by lastdate, the most recent time something happened to the contact in that automation. Use asc or desc in any letter case (asc, ASC, desc, DESC, Desc are all accepted; the value is upper-cased before it is checked); any other value is rejected with a 422 error. Without it the order is not guaranteed.

Responses

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