Pular para o conteúdo

GET /v1/flows

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

Permissão que a Chave de acesso precisa: Ler fluxos (flows:read), ou Criar e mover negócios (deals:manage), ou Enviar mensagem e atender (conversations:write).

status
string
Allowed values: rascunho ativo pausado
folderId
string format: uuid
q
string
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
folderId
required
string
nullable
triggerType
required
string
triggerKeyword
required
string
nullable
triggerChannel
required
string
triggerAccounts
required

Ids dos canais do gatilho; vazio atende todos os canais

Array<string>
version
required
number
origin
required
string
companionAgentId
required

Agente de IA que criou o fluxo junto com ele, quando veio de uma IA pronta

string
nullable
publishedAt
required
string format: date-time
nullable
ownerUserId
required

Who receives the notice when the flow holds or fails messages

string
nullable
ownerName
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nodeCount
number
warnings
Array<object>
object
nextCursor
required
string
nullable

Example generated

{
"items": [
{
"id": "example",
"name": "example",
"status": "example",
"folderId": "example",
"triggerType": "example",
"triggerKeyword": "example",
"triggerChannel": "example",
"triggerAccounts": [
"example"
],
"version": 1,
"origin": "example",
"companionAgentId": "example",
"publishedAt": "2026-04-15T12:00:00Z",
"ownerUserId": "example",
"ownerName": "example",
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z",
"nodeCount": 1,
"warnings": [
{}
]
}
],
"nextCursor": "example"
}