List Pipelines
GET/external/v1/pipelinesReturns the pipelines of your account, each with its ordered stages. Use it to pick the pipeline_id / stage_id you send to Create opportunity and Update stage, and to resolve the ids returned by the opportunities endpoints into names.
Related endpoints
Get pipeline fetches one pipeline by id. Pipeline stages returns the stages of a pipeline with the number and value of the cards in each one.
Authentication
Requires pipelines:read permission.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
is_active | boolean | - | true returns only active pipelines, false only inactive ones. Without it both are returned (check is_active on each item). |
project_id | string | - | Only the pipelines of this project (see List Projects). Pass null for the pipelines that belong to no project. |
Visibility
Pipelines are grouped by project in the GetRaze CRM, and a pipeline without a project is not shown in the product. This endpoint applies the same rule: when the account has at least one pipeline with a project, the pipelines without one are left out. An account whose pipelines all have no project gets the full list. Passing project_id (including project_id=null) turns the rule off and returns exactly what you asked for.
Inactive pipelines (is_active: false) are returned unless you filter them out. They still accept opportunities through the API, but the team does not see them, so prefer an active one.
Request
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())Response
{
"success": true,
"data": [
{
"id": "pipe_01",
"name": "Sales",
"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": "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 (where opportunities created without pipeline_id go) |
is_active | boolean | Whether the pipeline is active |
project_id | string | Project the pipeline belongs to (nullable, see List Projects) |
display_order | integer | Ordering of the pipeline |
stages | array | Ordered stages of the pipeline |
stages[].position | integer | Stage order within the pipeline (the first stage is where opportunities created without stage_id go) |
stages[].is_win_stage | boolean | Stage counts as a win |
stages[].is_loss_stage | boolean | Stage counts as a loss |
Errors
| Status | Code | Description |
|---|---|---|
| 400 | VALIDATION_ERROR | project_id is not a UUID (nor null) |
| 403 | INSUFFICIENT_PERMISSIONS | The API key lacks pipelines:read |