Pular para o conteúdo

GET /v1/sequences/{id}/enrollments

GET
/v1/sequences/{id}/enrollments
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).

id
required
string
status
string
Allowed values: active completed exited com_falha

Com_falha: enrollments with a failed or held step, or that failed

cursor
string

Opaque pagination cursor

limit
number
>= 1 <= 200

Page size (default 50, max 200)

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
contactId
required
string
contactName
required
string
nullable
contactPhone
required
string
nullable
contactProfilePicUrl
required

Presigned url for the contact’s whatsapp profile photo

string
nullable
currentStep
required
number
stepCount
required
number
status
required
string
exitReason
required
string
nullable
sendAfter
required
string format: date-time
nullable
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
nullable
nextCursor
required
string
nullable

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"
}