GET
/
api
/
automations
List Tenant Automations
curl --request GET \
  --url https://api.embedreach.com/api/automations
{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "results": [
          {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "status": "draft",
            "emailsSent": 123,
            "smsSent": 123,
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "deactivatedAt": "<string>",
            "triggerMetadata": "<any>",
            "triggerType": "one_time",
            "actionData": "<any>",
            "businessId": "<string>",
            "includeSegmentIds": [
              "<string>"
            ],
            "excludeSegmentIds": [
              "<string>"
            ],
            "derivedRevenue": 123,
            "automationType": "managed",
            "extraMergeFieldsInUse": [
              {
                "id": "<string>",
                "type": "static",
                "templateName": "<string>",
                "displayName": "<string>",
                "staticValue": "<string>"
              }
            ]
          }
        ],
        "pagination": {
          "total": 123,
          "hasNextPage": true,
          "cursor": "<string>"
        }
      }
    ],
    "pagination": {
      "total": 123,
      "hasNextPage": true,
      "cursor": "<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,
deactivated,
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, scheduled, sending, completed, failed, deactivated, cancelled, partially_cancelled, archived

​
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

200
application/json

Status 200 response

The response is of type object.