Pipelines

GET {BASE_URL}/api-v1-pipelines

Retorna todos os pipelines ativos do workspace, cada um com suas etapas (stages) embutidas e ordenadas. Útil para descobrir os pipeline_id e stage_id que você usa nos demais endpoints (criar negócio, mover de etapa, etc.).

Escopo necessário: pipelines:read.

pipelines:read não é um escopo selecionável na criação de chaves — hoje só chaves com acesso total (*) conseguem ler pipelines. Como pipeline_id e stage_id são estáticos, o caminho seguro é: crie uma chave * temporária, leia os pipelines uma vez, anote os ids e revogue essa chave; deixe a chave permanente da integração só com os escopos operacionais. Veja Chaves e escopos.

Este endpoint não pagina — retorna a lista completa de uma vez.

Exemplo

curl "{BASE_URL}/api-v1-pipelines" \
  -H "X-API-Key: vnd_sua_chave_aqui"

{
  "data": [
    {
      "id": "7b6a...",
      "workspace_id": "44c1...",
      "name": "Funil de Vendas",
      "is_default": true,
      "is_active": true,
      "created_at": "2026-01-10T09:00:00.000Z",
      "stages": [
        { "id": "0f1e...", "name": "Novo", "position": 1, "type": "pre-venda", "is_active": true },
        { "id": "2a3b...", "name": "Qualificado", "position": 2, "type": "venda", "is_active": true },
        { "id": "4c5d...", "name": "Ganho", "position": 3, "type": "won", "is_active": true }
      ]
    }
  ]
}

Formato

Pipeline: id, workspace_id, name, is_default, is_active, created_at, stages[]. Pipelines vêm ordenados por data de criação (mais antigo primeiro).
Etapa (stage): id, name, position (número, ordem da etapa no funil), type (ex.: pre-venda, venda, won, lost), is_active. As etapas vêm ordenadas por position crescente.

Erros possíveis

HTTP	`code`	Quando
`401`	`missing_api_key` / `invalid_api_key` / `revoked_api_key`	Autenticação.
`403`	`insufficient_scope`	A chave não tem `pipelines:read` (precisa de `*`).
`405`	`method_not_allowed`	Método diferente de `GET`.
`500`	`internal_error`	Falha interna.

Pipelines

Exemplo

Formato

Erros possíveis

Nesta página