ReferênciaFunis
Listar funis
GET /pipelines — lista os funis da organização com suas etapas em ordem.
GET
/pipelinesBetaEscopo necessário: deals:read
Lista os funis da organização (resolvida pela API key) em ordem de posição, cada um com suas etapas também em ordem. Os id de funil e de etapa são os valores de pipeline_id e stage_id em GET /deals. Não há parâmetros nem paginação.
Endpoint
GET https://crm.oficinamartech.com/api/v1/pipelinesExemplo
curl -s "https://crm.oficinamartech.com/api/v1/pipelines" \
-H "Authorization: Bearer crm_live_SEU_PREFIXO_SEU_SEGREDO"Resposta 200
{
"data": [
{
"id": "11111111-2222-3333-4444-555555555555",
"name": "Comercial",
"category": "vendas",
"position": 1,
"is_active": true,
"stages": [
{
"id": "66666666-7777-8888-9999-aaaaaaaaaaaa",
"name": "Novo",
"position": 1,
"probability": 10,
"is_won": false,
"is_lost": false
},
{
"id": "77777777-8888-9999-aaaa-bbbbbbbbbbbb",
"name": "Ganho",
"position": 2,
"probability": 100,
"is_won": true,
"is_lost": false
}
]
}
]
}is_won e is_lost marcam as etapas de fechamento. probability é null quando a etapa não tem probabilidade definida.
Erros
| Status | Código | Quando |
|---|---|---|
401 | missing_api_key / invalid_api_key | API key ausente, inválida, expirada ou revogada. |
403 | missing_scope | A chave não tem o escopo deals:read. |
429 | rate_limited | Acima de 120 req/min por chave ou por organização. |
500 | — | Erro interno. |