GET /v1/flows
GET
/v1/flows
const url = 'https://seu-endereco-da-api/v1/flows?status=rascunho';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/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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”status
string
folderId
string format: uuid
q
string
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
name
required
string
status
required
string
folderId
required
string
triggerType
required
string
triggerKeyword
required
string
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
publishedAt
required
string format: date-time
ownerUserId
required
Who receives the notice when the flow holds or fails messages
string
ownerName
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nodeCount
number
warnings
Array<object>
object
nextCursor
required
string
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"}