Skip to main content
GET
cURL
Returns a single sequence by ID. Pass ?includeMetrics=true to receive the sequence together with its outreach array (calls and SMS encounters with analysis). Without the flag, the response is the sequence record only.

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

Query Parameters

includeMetrics
boolean

When true, the response includes the outreach array with per-step call and SMS metrics.

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