Listar Pipelines

GET /external/v1/pipelines

Retorna todos os pipelines da sua conta, cada um com suas etapas ordenadas. Use para resolver os valores pipeline_id / stage_id retornados pelos endpoints de oportunidades.

Autenticacao

Requer permissao pipelines:read.

Requisicao

cURL

curl --request GET \
  --url "https://app.getraze.com/external/v1/pipelines" \
  --header "X-API-Key: YOUR_API_KEY"

Node.js

const axios = require('axios');

const response = await axios.get('https://app.getraze.com/external/v1/pipelines', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});

console.log(response.data);

Python

import requests

response = requests.get(
    'https://app.getraze.com/external/v1/pipelines',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)

print(response.json())

Resposta

{
  "success": true,
  "data": [
    {
      "id": "pipe_01",
      "name": "Vendas",
      "description": null,
      "color": "blue",
      "icon": "target",
      "is_default": true,
      "is_active": true,
      "display_order": 0,
      "created_at": "2026-01-10T08:00:00Z",
      "updated_at": "2026-01-10T08:00:00Z",
      "stages": [
        {
          "id": "stg_new",
          "pipeline_id": "pipe_01",
          "name": "Novo",
          "color": "gray",
          "position": 0,
          "is_win_stage": false,
          "is_loss_stage": false
        },
        {
          "id": "stg_won",
          "pipeline_id": "pipe_01",
          "name": "Ganho",
          "color": "green",
          "position": 5,
          "is_win_stage": true,
          "is_loss_stage": false
        }
      ]
    }
  ]
}

Campos de Resposta

Campo	Tipo	Descricao
id	string	Identificador do pipeline
name	string	Nome do pipeline
description	string	Descricao opcional (nullable)
color / icon	string	Dicas de apresentacao para UI
is_default	boolean	Se e o pipeline padrao
is_active	boolean	Se o pipeline esta ativo
display_order	integer	Ordenacao do pipeline
stages	array	Etapas ordenadas do pipeline
stages[].position	integer	Ordem da etapa dentro do pipeline
stages[].is_win_stage	boolean	Etapa conta como ganho
stages[].is_loss_stage	boolean	Etapa conta como perda