Sequences
List Enrollments
The sequence's enrollments, newest first (cursor pagination), each with a compact `lead` summary (null once the lead is deleted).
API key access
Needs the
sequences:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/sequences/{sequence_id}/enrollmentsAuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Path Parameters
sequence_idstring
Format
uuidQuery Parameters
state?array<EnrollmentState> | null
Repeat to match any of
lead_id?string | null
Format
uuidsort?EnrollmentSortField | null
Sort by this field instead of newest first (then by id); the cursor of a sorted page only continues that sort
order?SortOrder
Direction of sort (default asc; nulls last)
Value in
"asc" | "desc"cursor?string | null
next_cursor of the previous page (at most 64 characters without sort)
Length
length <= 2048limit?integer
Format
int64Range
1 <= value <= 200Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/sequences/497f6eca-6276-4993-bfeb-53cbbbba6f08/enrollments?state=active&lead_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&order=asc&cursor=string&limit=1" \ -H "X-Workspace-Id: string"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f",
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"state": "active",
"current_step": 0,
"next_run_at": "2019-08-24T14:15:22Z",
"last_step_at": "2019-08-24T14:15:22Z",
"stop_reason": "string",
"enrolled_by_id": "35cb1567-1670-45ae-aef9-039b6c19e8e8",
"finished_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"lead": {}
}
],
"next_cursor": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}