Skip to the documentation
API

People in an automation

The people who entered an automation, newest first, with the step each one is on. One enrollment read by id also carries every step it ran.

GET/automations/{id}/enrollments

Runs any of 2 calls on your workspace.

GET /automations/{id}/enrollments

The people who entered an automation, newest first, with the step each one is on. One enrollment read by id also carries every step it ran.

Example

Needs automations:read. status is active, completed or exited, stepKey narrows the list to the people on one step, and q searches names and addresses. limit goes up to 200 and defaults to 50.

curl
curl "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/enrollments?status=active" -H "$AUTH"curl "$OE/automations/aut_7c2e9a1f4b8d30c65e1a9f27/enrollments/aen_2d8f1b6c9e3a47d05b1c8e62" -H "$AUTH"
Response
{  "object": "list",  "data": [{      "object": "automation_enrollment",      "id": "aen_2d8f1b6c9e3a47d05b1c8e62",      "automationId": "aut_7c2e9a1f4b8d30c65e1a9f27",      "version": 2,      "contact": { "id": "5b0e7c1a-2f4d-4c8b-9a36-1e7d0c5f8b24", "email": "[email protected]", "name": "Ana Lima" },      "status": "active",      "source": "trigger",      "stepKey": "pause",      "waiting": true,      "waitingForEvent": null,      "heldFor": null,      "nextRunAt": "2026-10-14T08:02:11.000Z",      "exitReason": null,      "lastError": null,      "startedAt": "2026-10-11T08:02:03.000Z",      "finishedAt": null,      "updatedAt": "2026-10-11T08:02:11.000Z"    }],  "hasMore": false,  "nextCursor": null}

waiting is true while the person sits in a wait step, and nextRunAt is when they move on. waitingForEvent names the event a wait is listening for.

heldFor says why a due step has not run yet: window for the send window, quota for the plan’s sending allowance, lane while marketing mail is paused for the workspace, or retry after a failure.

A single enrollment adds runs: each step it ran, with the outcome and, for an email, the emailId of the message.

Reference