Skip to main content
GET
/
api
/
automations
List Tenant Automations
curl --request GET \
  --url https://api.embedreach.com/api/automations
{
  "success": true,
  "message": "<string>"
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Query Parameters

​
cursor
string

The cursor to start from

​
limit
number | null

The limit of items to return, default is 100

​
status
enum<string>

[Deprecated please uses statusFilter]The status of the automation. By default we return all EXCEPT archived

Available options:
draft,
active,
completed,
archived
​
statusFilter
string

The status(es) of the automation. Accepts a comma-separated list. By default we return all EXCEPT archived. Valid values are: draft, active, running, sending, completed, failed, cancelled, partially_cancelled, archived. 'scheduled' and 'deactivated' are accepted for backwards compatibility but return no results (statuses were removed).

​
search
string

An optional search query based on the name of the automation

​
triggerTypes
string

The types of triggers for the automation (e.g. one-time versus trigger-based), An array of values in the format of 'one_time,trigger_based,date_based'

Response

Status 200 response

​
success
boolean
required
​
message
string
​
data
object