List Pipelines
GET/external/v1/pipelinesReturns all pipelines in your account, each with its ordered stages. Use this to resolve pipeline_id / stage_id values returned by the opportunities endpoints.
Authentication
Requires pipelines:read permission.
Request
bash
curl --request GET \
--url "https://app.getraze.com/external/v1/pipelines" \
--header "X-API-Key: YOUR_API_KEY"javascript
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())Response
json
{
"success": true,
"data": [
{
"id": "pipe_01",
"name": "Sales",
"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": "New",
"color": "gray",
"position": 0,
"is_win_stage": false,
"is_loss_stage": false
},
{
"id": "stg_won",
"pipeline_id": "pipe_01",
"name": "Won",
"color": "green",
"position": 5,
"is_win_stage": true,
"is_loss_stage": false
}
]
}
]
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Pipeline identifier |
name | string | Pipeline name |
description | string | Optional description (nullable) |
color / icon | string | UI presentation hints |
is_default | boolean | Whether this is the default pipeline |
is_active | boolean | Whether the pipeline is active |
display_order | integer | Ordering of the pipeline |
stages | array | Ordered stages of the pipeline |
stages[].position | integer | Stage order within the pipeline |
stages[].is_win_stage | boolean | Stage counts as a win |
stages[].is_loss_stage | boolean | Stage counts as a loss |