Buscar Pipeline
GET/external/v1/pipelines/:idRetorna um pipeline com suas etapas ordenadas. Diferente de Listar pipelines, este endpoint resolve qualquer pipeline da sua conta, inclusive os inativos e os escondidos pela regra de visibilidade, para que um pipeline_id vindo de uma oportunidade, do histórico dela ou de um webhook sempre resolva.
Autenticação
Requer permissão pipelines:read.
Parâmetros de Path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID do pipeline |
Requisição
bash
curl --request GET \
--url "https://app.getraze.com/external/v1/pipelines/pipe_01" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const response = await axios.get('https://app.getraze.com/external/v1/pipelines/pipe_01', {
headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
console.log(response.data);python
import requests
response = requests.get(
'https://app.getraze.com/external/v1/pipelines/pipe_01',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Resposta
json
{
"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_proposal",
"pipeline_id": "pipe_01",
"name": "Proposta",
"color": "blue",
"position": 1,
"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
}
]
}
}Os campos são os mesmos de Listar pipelines.
Erros
| Status | Código | Descrição |
|---|---|---|
| 400 | VALIDATION_ERROR | id não é um UUID |
| 403 | INSUFFICIENT_PERMISSIONS | A chave não tem pipelines:read |
| 404 | NOT_FOUND | Nenhum pipeline com este id na sua conta |