GET /v1/sequences/{id}/enrollments
GET
/v1/sequences/{id}/enrollments
const url = 'https://seu-endereco-da-api/v1/sequences/example/enrollments?status=active';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://seu-endereco-da-api/v1/sequences/example/enrollments?status=active' \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler sequências (sequences:read).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Query Parameters
Seção intitulada “Query Parameters”status
string
Com_falha: enrollments with a failed or held step, or that failed
cursor
string
Opaque pagination cursor
limit
number
Page size (default 50, max 200)
Responses
Seção intitulada “Responses”Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
contactId
required
string
contactName
required
string
contactPhone
required
string
contactProfilePicUrl
required
Presigned url for the contact’s whatsapp profile photo
string
currentStep
required
number
stepCount
required
number
status
required
string
exitReason
required
string
sendAfter
required
string format: date-time
enrolledAt
required
string format: date-time
failedSteps
required
Steps whose message failed or got held, or whose run failed; each step counts once
number
lastFailureAt
required
string format: date-time
nextCursor
required
string
Example generated
{ "items": [ { "id": "example", "contactId": "example", "contactName": "example", "contactPhone": "example", "contactProfilePicUrl": "example", "currentStep": 1, "stepCount": 1, "status": "example", "exitReason": "example", "sendAfter": "2026-04-15T12:00:00Z", "enrolledAt": "2026-04-15T12:00:00Z", "failedSteps": 1, "lastFailureAt": "2026-04-15T12:00:00Z" } ], "nextCursor": "example"}