Pular para o conteúdo

GET /v1/sequences

GET
/v1/sequences
curl --request GET \
--url 'https://seu-endereco-da-api/v1/sequences?status=draft' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler sequências (sequences:read), ou Criar e mover negócios (deals:manage).

status
string
Allowed values: draft active paused archived
stageId
string format: uuid

Only sequences with a deal_stage trigger on this stage

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
name
required
string
status
required
string
steps
required
Array<object>
object
flowId
required
string
delayValue
required
number
delayUnit
required
string
enrollTriggers
required
Array<object>
object
exitGoals
required
Array<object>
object
dailyCap
required
number
nullable
companionAgentId
required

Agente de IA que criou a sequência junto com ele, quando veio de uma IA pronta

string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
counts
required
object
active
required
number
completed
required
number
exited
required
number
failed
required

Enrollments whose step could not run and stopped the sequence

number
withFailure
required

Enrollments with at least one step whose message failed or got held, or that failed

number
total
required
number
nextCursor
required
string
nullable

Example generated

{
"items": [
{
"id": "example",
"name": "example",
"status": "example",
"steps": [
{
"flowId": "example",
"delayValue": 1,
"delayUnit": "example"
}
],
"enrollTriggers": [
{}
],
"exitGoals": [
{}
],
"dailyCap": 1,
"companionAgentId": "example",
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z",
"counts": {
"active": 1,
"completed": 1,
"exited": 1,
"failed": 1,
"withFailure": 1,
"total": 1
}
}
],
"nextCursor": "example"
}