API · Automations

List Automations

List automations for your team (requires full access).

GET/automationsFull access

Request parameters

Parameter	Type	Description
`status` query · optional	`"enabled" \| "disabled"`	Filter automations by status.
`limit` query · optional	`integer` 1–100 Default: 20	Number of results to return. See Pagination.
`after` query · optional	`string`	Resource ID for the next page. Cannot be combined with before. See Pagination.
`before` query · optional	`string`	Resource ID for the previous page. Cannot be combined with after. See Pagination.

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" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

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

json

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "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"
    }
  ]
}

Behavior and errors

Filter by enabled or disabled and use the standard ID pagination parameters.

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