Get playbook by id

GET

/playbooks/:id

GET

/playbooks/:id

1 curl https:/https://api/playbooks/id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "playbook": {
3     "_id": "5f8d0d55b54764421b7156c3",
4     "scope": "library",
5     "templateId": "tpl_9a8b7c6d5e4f3a2b1c0d",
6     "projectId": null,
7     "sourceDefinitionId": "def_1234567890abcdef",
8     "sourceVersion": 2.3,
9     "slug": "incident-response-template",
10     "name": "Incident Response Playbook",
11     "description": "A comprehensive playbook for managing security incident responses.",
12     "icon": "🛡️",
13     "color": "#007ACC",
14     "status": "draft",
15     "numbering": {
16       "steps": "1.1",
17       "sections": "A"
18     },
19     "startableByUsers": true,
20     "webhookEnabled": true,
21     "webhookSecret": "whsec_4f3e2d1c",
22     "orchestrator": {
23       "type": "sequential",
24       "retryPolicy": "exponentialBackoff"
25     },
26     "startForm": {
27       "fields": [
28         {
29           "name": "incident_type",
30           "type": "dropdown",
31           "options": [
32             "phishing",
33             "malware",
34             "data_breach"
35           ]
36         }
37       ]
38     },
39     "tasks": [
40       {
41         "taskId": "task_001",
42         "name": "Identify Incident",
43         "assignedTo": "security_team"
44       }
45     ],
46     "dependencies": [
47       {
48         "dependencyId": "dep_001",
49         "type": "approval",
50         "required": true
51       }
52     ],
53     "version": 1.1,
54     "archivedAt": null,
55     "briefId": null,
56     "createdAt": "2024-05-10T09:15:00Z",
57     "updatedAt": "2024-05-15T16:45:00Z",
58     "createdBy": "user_7f9e8d6c5b4a3f2e1d0c"
59   }
60 }

Returns a single playbook by id across any scope. Authorization depends on the playbook’s scope (library/template require playbook:create; project requires project access).

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

idstringRequired

Response

The playbook.

playbookobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error