Funis

GET    {BASE_URL}/api-v1-pipelines  # lista

Use os endereços acima — são os que respondem hoje. A API está migrando para um endereço único ({BASE_URL}/api-v1/pipelines), que ainda não foi publicado: enquanto isso, qualquer chamada para ele devolve 404 not_found. Quando entrar no ar, esta página muda junto, e os endereços acima continuam valendo.

Escopo: pipelines:read (somente leitura).

Só funis ativos e só etapas ativas. Sem paginação — a lista é curta por natureza.

Campos

Campo	Tipo	Notas
`id`	uuid
`workspace_id`	uuid	Sempre o workspace da chave de API usada na chamada.
`name`	string
`is_default`	boolean
`is_active`	boolean
`created_at`	datetime
`stages`	lista de objetos	Etapas ativas, ordenadas por posição numérica crescente. Campo montado pela API (não é coluna direta). Cada item traz: `id` (uuid), `name` (string), `position` (number), `type` (string), `is_active` (boolean).

Listar funis

GET {BASE_URL}/api-v1-pipelines

Ordenação: created_at crescente. Esta listagem não pagina — devolve a lista inteira.

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

{
  "data": [ /* registros */ ]
}

Erros

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`.
`405`	`method_not_allowed`	Método não suportado neste endereço.
`500`	`internal_error`	Falha interna.

Catálogo completo em Erros.

Exemplo de resposta

{
  "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 }
      ]
    }
  ]
}

Ordem dos blocos

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.