Listar Pipelines
GET/external/v1/pipelinesRetorna os pipelines (funis) da sua conta, cada um com suas etapas ordenadas. Use para escolher o pipeline_id / stage_id que você envia em Criar oportunidade e Atualizar estágio, e para resolver em nomes os ids que os endpoints de oportunidades devolvem.
Endpoints relacionados
Buscar pipeline traz um pipeline pelo id. Etapas do pipeline traz as etapas de um pipeline com a quantidade e o valor dos cards em cada uma.
Autenticação
Requer permissão pipelines:read.
Parâmetros de Query
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
is_active | boolean | - | true retorna só os pipelines ativos, false só os inativos. Sem ele, os dois vêm (veja is_active em cada item). |
project_id | string | - | Só os pipelines deste projeto (veja Listar projetos). Passe null para os pipelines sem projeto. |
Visibilidade
No CRM do GetRaze os pipelines ficam agrupados por projeto, e um pipeline sem projeto não aparece no produto. Este endpoint segue a mesma regra: quando a conta tem pelo menos um pipeline com projeto, os sem projeto ficam de fora. Uma conta cujos pipelines não têm projeto nenhum recebe a lista inteira. Passar project_id (inclusive project_id=null) desliga a regra e devolve exatamente o que você pediu.
Pipelines inativos (is_active: false) vêm na lista a menos que você os filtre. Eles ainda aceitam oportunidades pela API, mas o time não os vê, então prefira um ativo.
Requisição
curl --request GET \
--url "https://app.getraze.com/external/v1/pipelines?is_active=true" \
--header "X-API-Key: YOUR_API_KEY"const axios = require('axios');
const response = await axios.get('https://app.getraze.com/external/v1/pipelines', {
headers: { 'X-API-Key': 'YOUR_API_KEY' },
params: { is_active: true }
});
console.log(response.data);import requests
response = requests.get(
'https://app.getraze.com/external/v1/pipelines',
headers={'X-API-Key': 'YOUR_API_KEY'},
params={'is_active': 'true'}
)
print(response.json())Resposta
{
"success": true,
"data": [
{
"id": "pipe_01",
"name": "Vendas",
"description": null,
"color": "blue",
"icon": "target",
"is_default": true,
"is_active": true,
"project_id": "proj_01",
"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 | Descrição |
|---|---|---|
id | string | Identificador do pipeline |
name | string | Nome do pipeline |
description | string | Descrição opcional (nullable) |
color / icon | string | Dicas de apresentação para UI |
is_default | boolean | Se é o pipeline padrão (para onde vão as oportunidades criadas sem pipeline_id) |
is_active | boolean | Se o pipeline está ativo |
project_id | string | Projeto do pipeline (nullable, veja Listar projetos) |
display_order | integer | Ordenação do pipeline |
stages | array | Etapas ordenadas do pipeline |
stages[].position | integer | Ordem da etapa dentro do pipeline (a primeira recebe as oportunidades criadas sem stage_id) |
stages[].is_win_stage | boolean | Etapa conta como ganho |
stages[].is_loss_stage | boolean | Etapa conta como perda |
Erros
| Status | Código | Descrição |
|---|---|---|
| 400 | VALIDATION_ERROR | project_id não é um UUID (nem null) |
| 403 | INSUFFICIENT_PERMISSIONS | A chave não tem pipelines:read |