List Playbooks
GET/external/v1/playbooksReturns the playbooks of the account. A playbook is a reusable sequence of steps ("call in 2 hours, send the proposal the next day, follow up 2 days later"). Each time you start it on a contact, opportunity or internal title you create a playbook run, and each step becomes a real task with its own due date.
Authentication
Requires playbooks:read permission.
What the key can see
A key sees the same playbooks as the user who created it sees in the app. Admins see every playbook of the account. Other users see their own playbooks plus the ones shared with the team (visibility: team).
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
search | string | - | Partial match on the name or the shortcut |
include_inactive | boolean | false | Also return inactive playbooks |
This list is not paginated.
Request
bash
curl --request GET \
--url "https://app.getraze.com/external/v1/playbooks" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const response = await axios.get('https://app.getraze.com/external/v1/playbooks', {
headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
console.log(response.data);python
import requests
response = requests.get(
'https://app.getraze.com/external/v1/playbooks',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Response
json
{
"success": true,
"data": [
{
"id": "9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62",
"name": "Onboarding",
"description": "First week of a new customer",
"shortcut": "onboarding",
"visibility": "team",
"is_active": true,
"steps_count": 5,
"duration_hours": 120,
"uses_deal_owner": true,
"runs": { "active": 8, "overdue": 2, "completed": 31, "total": 41 },
"created_by": { "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva" },
"created_at": "2026-08-02T12:00:00.000Z",
"updated_at": "2026-10-01T18:30:00.000Z"
}
]
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Playbook identifier |
name / description | string | Name and description |
shortcut | string | Shortcut used to start it from the chat (/onboarding) |
visibility | string | team (everyone in the account) or private (only its author and admins) |
is_active | boolean | Inactive playbooks cannot be started |
steps_count | integer | Number of steps |
duration_hours | integer | Hours from the start of a run to the last step's due date |
uses_deal_owner | boolean | At least one step is assigned to the deal owner. A run without a contact or opportunity leaves those steps unassigned |
runs | object | Run counts: in progress, in progress with an overdue step, completed, total |
created_by | object | Author |
created_at / updated_at | string | UTC timestamps |