Skip to main content
GET
/
sequence-manager
/
sequences
/
{id}
cURL
curl --request GET \
  --url https://api.clarionhealth.com/v1/sequence-manager/sequences/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "status": "in-progress",
  "ended_reason": "<string>",
  "ended_reason_v2": "<string>",
  "current_step": 123,
  "next_activity": "2023-11-07T05:31:56Z",
  "organization_id": 123,
  "patient_id": 123,
  "type": "appointment_reminder",
  "steps": [
    {
      "id": "<string>",
      "type": "voice",
      "inputs": [
        {}
      ],
      "status": "pending",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "voicemail_message": "<string>",
      "source_number": "<string>",
      "destination_number": "<string>",
      "voice_assistant_id": 123,
      "post_actions": [
        {}
      ]
    }
  ],
  "sequence_definition_id": 123,
  "inputs": [
    {
      "id": "<string>",
      "value": "<string>",
      "name": "<string>",
      "type": "text"
    }
  ],
  "outcome": "<string>",
  "was_contact_reached": true,
  "claimed_at": "2023-11-07T05:31:56Z",
  "is_test_mode": true,
  "last_updated": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

The sequence ID

Response

Sequence object

id
integer

Unique identifier for the sequence

status
enum<string>

Current status of the sequence

Available options:
in-progress,
completed,
failed,
cancelled,
queued,
paused
ended_reason
string | null

Reason why the sequence ended

ended_reason_v2
string | null

Updated reason why the sequence ended

current_step
integer

Current step number in the sequence

next_activity
string<date-time> | null

When the next activity is scheduled

organization_id
integer

ID of the organization this sequence belongs to

patient_id
integer

ID of the patient this sequence is for

type
enum<string>

Type of sequence

Available options:
appointment_reminder,
follow_up,
other
steps
object[]

List of steps in the sequence

sequence_definition_id
integer

ID of the sequence definition this sequence is based on

inputs
object[]

Input values for the sequence

outcome
string | null

Final outcome of the sequence

was_contact_reached
boolean

Whether the contact was successfully reached

claimed_at
string<date-time> | null

When the sequence was claimed

is_test_mode
boolean

Whether this sequence is running in test mode

last_updated
string<date-time>

When the sequence was last updated