GET
/
api
/
automations
/
{id}
Get Tenant Automation
curl --request GET \
  --url https://api.embedreach.com/api/automations/{id}
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "triggerMetadata": {
      "triggerType": "one_time",
      "scheduledAt": "<string>",
      "timezone": "<string>"
    },
    "triggerType": "one_time",
    "actionData": [
      {
        "actionType": "send_communication",
        "actionMetadata": {
          "currentActionId": "<string>",
          "nextActionId": "<string>",
          "actionType": "send_communication",
          "communicationGroupId": "<string>"
        }
      }
    ],
    "businessId": "<string>",
    "status": "draft",
    "automationType": "managed",
    "includeSegmentIds": [
      "<string>"
    ],
    "excludeSegmentIds": [
      "<string>"
    ],
    "derivedRevenue": 123,
    "derivedOrders": 123,
    "extraMergeFieldsInUse": [
      {
        "id": "<string>",
        "type": "static",
        "templateName": "<string>",
        "displayName": "<string>",
        "staticValue": "<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.

Path Parameters

id
string
required

The id of the automation

Response

200
application/json

Status 200 response

The response is of type object.