pipelines.get
Obtém um funil ativo com etapas e agregados.
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 |
|---|---|---|---|---|
id | integer | Obrigatório | Identificador numérico do registro. | 101 |
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.get' \
--header 'Content-Type: application/json' \
--data '{"id":10}'Corpo JSON
{
"id": 10
}Resposta HTTP 200
{
"ok": true,
"method": "pipelines.get",
"result": {
"found": true,
"pipeline": {
"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
| HTTP | Código | Condição |
|---|---|---|
| 400 | PIPELINE_ID_REQUIRED | id ausente ou diferente de inteiro positivo. |
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.
- Resposta singular {found,pipeline}, não {total,pipelines}.
- Ausente, inativo ou fora da empresa (exceto global): {found:false,pipeline:null}.