Skip to main content
GET
List a sequence's contacts

Authorizations

Authorization
string
header
required

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

Path Parameters

sequence_id
string<uuid>
required

Query Parameters

status
enum<string> | null

Where one contact stands in one sequence.

ACTIVE rows carry a due_at and are what the tick claims; CLAIMED is the in-flight guard between claim and outcome. PAUSED (SEQ-30) is a deliberate per-contact hold: unclaimable because the tick claims strictly on ACTIVE, yet still LIVE — it keeps its step and its one-live-sequence slot, and a compliance stop (reply, unsubscribe) reaches it. Everything else is settled: COMPLETED walked off the end; STOPPED was halted (reply, unsubscribe, bounce, manual, company pause); FAILED is terminal per the phase-1 ruling; SUPPRESSED was on the do-not-contact list; SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the reason visible in the grid.

Available options:
active,
claimed,
paused,
completed,
stopped,
failed,
suppressed,
skipped_duplicate
sort
enum<string>
default:created_desc
Available options:
created_desc,
created_asc,
status
created_from
string<date-time> | null
created_to
string<date-time> | null
limit
integer
default:100
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

enrolments
EnrolmentReadSchema · object[]
required
total
integer
required