pipelines.list
Lista funis ativos da empresa e globais, com etapas e agregados dos negócios da empresa.
Exemplos seguros e fictícios. O domínio
example.invalid e a credencial demonstrativa abaixo não funcionam. Use o token real somente no servidor da sua integração e nunca o inclua em páginas públicas.Parâmetros
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplo fictício |
|---|---|---|---|---|
pipeline_id | integer | Opcional | Filtro opcional por um funil. Valor inválido é ignorado. | 10 |
Exemplos fictícios
Os exemplos documentam o formato; eles não executam nenhuma operação.
Requisição
cURL demonstrativo
curl --request POST \
'https://example.invalid/api/v1/CREDENCIAL_FICTICIA_SEM_VALOR/pipelines.list' \
--header 'Content-Type: application/json' \
--data '{"pipeline_id":10}'
Corpo JSON
{
"pipeline_id": 10
}Resposta HTTP 200
{
"ok": true,
"method": "pipelines.list",
"result": {
"total": 1,
"pipelines": [
{
"id": 10,
"name": "Funil Exemplo",
"slug": "funil-exemplo",
"is_default": false,
"type": "sales",
"color": "#2684FF",
"sort_order": 100,
"total_deals": 1,
"total_value": 1500,
"stages": [
{
"id": 11,
"name": "Em andamento",
"slug": "em-andamento-exemplo",
"type": "process",
"color": "#3b82f6",
"sort_order": 10,
"deals_count": 1,
"open_count": 1,
"deals_value": 1500
}
]
}
]
}
}Erros
Não há uma condição de erro específica publicada para este método. Os erros globais de autenticação, permissão, limite e falha interna continuam aplicáveis.
Consulte também os erros globais e limites.
Observações
- Exemplos ilustrativos e parciais: os registros podem retornar outros campos; não representam dados reais.
- Não possui paginação. total é a quantidade de funis retornados.
- deals_count inclui negócios abertos e encerrados com archived=false; open_count restringe is_closed=false. Valores archived NULL não entram no agregado atual.
- total_value/deals_value são números; total_value arredondado a duas casas.