Get Playbook
GET/external/v1/playbooks/:idRetrieves one playbook with its ordered steps: what each step creates, when it is due and who receives it.
Authentication
Requires playbooks:read permission. The playbook must be visible to the user who created the API key (see List Playbooks), otherwise the response is 404.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Playbook identifier (UUID) |
Request
bash
curl --request GET \
--url "https://app.getraze.com/external/v1/playbooks/9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const playbookId = '9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62';
const response = await axios.get(
`https://app.getraze.com/external/v1/playbooks/${playbookId}`,
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
console.log(response.data);python
import requests
playbook_id = '9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62'
response = requests.get(
f'https://app.getraze.com/external/v1/playbooks/{playbook_id}',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Response
The fields of List Playbooks, plus steps.
json
{
"success": true,
"data": {
"id": "9d2c7a1e-4b3f-4e8a-a6d5-1c0b9f8e7d62",
"name": "Onboarding",
"visibility": "team",
"is_active": true,
"steps_count": 3,
"duration_hours": 50,
"steps": [
{
"id": "b7c6d5e4-f3a2-4b1c-9d8e-7f6a5b4c3d2e",
"position": 1,
"title": "Welcome call",
"description": null,
"task_type": "call",
"priority": "high",
"due": { "hours": 2, "from": "run_start", "offset_hours_from_start": 2 },
"assignee_mode": "owner",
"assignees": [],
"labels": [],
"subtasks_count": 0,
"size": null,
"estimate_hours": null
},
{
"id": "c8d7e6f5-a4b3-4c2d-8e9f-0a1b2c3d4e5f",
"position": 2,
"title": "Send the onboarding kit",
"task_type": "email",
"priority": "medium",
"due": { "hours": 24, "from": "previous_step", "offset_hours_from_start": 26 },
"assignee_mode": "users",
"assignees": [{ "id": "2d19889d-6ff9-4782-8165-32e56bb593c0", "name": "Maria Silva" }],
"labels": [{ "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "name": "Onboarding", "color": "#22c55e" }],
"subtasks_count": 3
}
]
}
}Step Fields
| Field | Type | Description |
|---|---|---|
position | integer | Order of the step (1-based) |
title / description | string | Copied to the task the step creates |
task_type / priority | string | Copied to the task |
due.hours / due.from | integer / string | The step is due hours after the run start (run_start) or after the previous step's due date (previous_step) |
due.offset_hours_from_start | integer | The resulting position in the chain, in hours from the run start |
assignee_mode | string | Who receives the task: users (the people in assignees), owner (the opportunity owner, or whoever handles the conversation when there is no owner) or none |
assignees | array | People of a users step |
labels | array | Task labels copied to the task |
subtasks_count | integer | Checklist items copied to the task |
size / estimate_hours | string / number | Copied to the task (nullable) |
The deal owner is a snapshot
For owner steps, the owner is read when the run starts. Changing the opportunity owner later does not move tasks that already exist.