Automations

List enrollments

GET
/api/v1/automations/{id}/runs

One row per contact-run, newest first: where it is in the tree and what it's waiting on.

Authorization

bearerAuth write
headerAuthorizationBearer <token>

An API key from the dashboard under Settings → API keys, sent as Authorization: Bearer aem_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see messages, contacts and metrics. Changes nothing, and cannot send.
  • write — everything read does, plus managing templates, contacts, automations, segments and suppressions. This is what editing a template needs.
  • admin — everything write does, plus sending configuration: domains, senders, webhook registration, kill switch, daily cap, brand.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Delivering mail to a real inbox needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

Give your application the lowest tier that works. Most need write and the grant — the dashboard mints that combination as Send + manage; Manage only is the same rung with the grant withheld.

Scope: write

Path Parameters

id*string

Automation id or exact name.

Query Parameters

status?string

Filter by run status (active, completed, exited, canceled, failed).

limit?integer

Max rows (1–100, default 50).

cursor?string

Opaque — pass the previous page's next_cursor to fetch the next page. A malformed cursor is refused, never treated as page one.

Response Body

Runs.

application/json
  1. response
data*array<>
has_more*boolean

More rows exist after this page.

object*"list"
Value in"list"
next_cursor*|

Pass as ?cursor= for the next page. Null on the last page.

Example Request
curl -X GET 'https://sendandretain.com/api/v1/automations/string/runs'
Example Response
{  "data": [    {      "id": "string",      "status": "active",      "contact_email": "string",      "current_step_id": "string",      "next_step_at": "2019-08-24T14:15:22Z",      "waiting_for_event": "string",      "wait_until": "2019-08-24T14:15:22Z",      "exit_step_id": "string",      "variant_assignments": {},      "cancel_reason": "string",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "object": "list",  "next_cursor": "string"}