Skip to main content
GET
/
sequence-manager
/
sequence-definitions
cURL
curl --request GET \
  --url https://api.clarionhealth.com/v1/sequence-manager/sequence-definitions \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "status": "active",
      "steps_definition": [
        {
          "id": "<string>",
          "type": "voice",
          "order": 123,
          "delay_hours": 123,
          "voice_assistant_id": 123,
          "messaging_assistant_id": 123,
          "inputs": [
            {
              "id": "<string>",
              "name": "<string>",
              "type": "text",
              "required": true
            }
          ]
        }
      ],
      "inputs_definition": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "text",
          "required": true
        }
      ],
      "outreach_schedule": {
        "timezone": "America/New_York",
        "business_hours": {
          "start": "09:00",
          "end": "17:00"
        },
        "days_of_week": [
          "monday"
        ]
      },
      "voice_assistant_id": 123,
      "organization_id": 123,
      "ehr_action": "has-ehr-file",
      "created_at": "2023-11-07T05:31:56Z",
      "is_archived": true,
      "allow_repeat_contact": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Array of sequence definitions

success
boolean

Indicates if the request was successful

data
object[]

Array of sequence definitions