Automations

Get an automation

GET
/api/v1/automations/{id}

Trigger, filter, settings, and the full ordered step tree.

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.

Response Body

Automation.

application/json
  1. response
id?string
name?string
status?string
trigger_event?string
trigger_filter?array<any>||null
priority?integer
exclusive?boolean
exit_events?array<string>
exit_event?string|null
allow_reenrollment?boolean
created_at?string
Formatdate-time
updated_at?string
Formatdate-time
steps?array<>
Example Request
curl -X GET 'https://sendandretain.com/api/v1/automations/string'
Example Response
{  "id": "string",  "name": "string",  "status": "paused",  "trigger_event": "string",  "trigger_filter": [],  "priority": 100,  "exclusive": true,  "exit_events": [    "string"  ],  "exit_event": "string",  "allow_reenrollment": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "steps": [    {      "id": "string",      "position": 1,      "parent_step_id": "string",      "lane_key": "string",      "type": "send",      "delay_seconds": 0,      "template_slug": "string",      "config": {}    }  ]}