List Projects
GET/external/v1/projectsReturns the CRM projects of your account: the groups pipelines are organised in. Use it to resolve the project_id returned by List pipelines, or as the value of its project_id filter.
Authentication
Requires projects:read permission.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
is_active | boolean | - | true returns only active projects, false only inactive ones |
Request
bash
curl --request GET \
--url "https://app.getraze.com/external/v1/projects" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const response = await axios.get('https://app.getraze.com/external/v1/projects', {
headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
console.log(response.data);python
import requests
response = requests.get(
'https://app.getraze.com/external/v1/projects',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Response
json
{
"success": true,
"data": [
{
"id": "proj_01",
"name": "CRM",
"description": null,
"color": "blue",
"is_active": true,
"display_order": 0,
"created_at": "2026-01-10T08:00:00Z",
"updated_at": "2026-01-10T08:00:00Z"
}
]
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Project identifier (the project_id of pipelines) |
name | string | Project name |
description | string | Optional description (nullable) |
color | string | UI presentation hint |
is_active | boolean | Whether the project is active |
display_order | integer | Ordering of the project |