POST

`stages.list`

Lista as etapas de um funil da empresa, por sort_order e id.

Grupo: EtapasRevisão: 2026-10-02Escopo recomendado: stages.list

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

Parâmetros aceitos por stages.list
Campo	Tipo	Obrigatoriedade	Descrição	Exemplo fictício
`pipeline_id`	integer	Obrigatório	Funil pertencente à empresa do token.	`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/stages.list' \
  --header 'Content-Type: application/json' \
  --data '{"pipeline_id":10}'

Corpo JSON

{
  "pipeline_id": 10
}

Resposta HTTP 200

{
  "ok": true,
  "method": "stages.list",
  "result": {
    "total": 1,
    "stages": [
      {
        "id": 11,
        "pipeline_id": 10,
        "name": "Em andamento",
        "slug": "em-andamento-exemplo",
        "type": "process",
        "color": "#3b82f6",
        "sort_order": 10
      }
    ]
  }
}

Erros

Condições de erro específicas de stages.list
HTTP	Código	Condição
400	`BAD_REQUEST`	Parâmetro obrigatório ausente ou valor inválido.
404	`PIPELINE_NOT_FOUND`	Funil não encontrado ou não pertence à empresa do token (inclui funil global).

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. O método não aceita funil global, mesmo quando pipelines.list o apresenta.