API · Automations

Retrieve Automation

Retrieve an automation (requires full access).

GET/automations/{automation_id}Full access

Request parameters

Parameter	Type	Description
`automation_id` path · required	`string`	The ID of the automation.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/automations/YOUR_automation_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "automation",
  "id": "YOUR_ID",
  "name": "example",
  "status": "enabled",
  "created_at": "2023-10-06 23:47:56.678+00",
  "updated_at": "2023-10-06 23:47:56.678+00",
  "steps": [
    {
      "key": "example",
      "type": "trigger",
      "config": {}
    }
  ],
  "connections": [
    {
      "from": "example",
      "to": "example",
      "type": "default"
    }
  ]
}

Behavior and errors

The response includes steps and connections in the REST wire format. Runs snapshot this definition when they start.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.