List playbook definitions

GET

/playbooks

GET

/playbooks

$ curl https://api.cloudraker.com/playbooks \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "pb-8f3a2c1d",
5       "name": "Contract intake",
6       "description": "A playbook to guide the contract intake process ensuring all necessary steps are completed.",
7       "status": "draft",
8       "spaceTypes": [
9         "legal",
10         "sales"
11       ],
12       "tasks": [
13         {
14           "id": "task-001",
15           "title": "Review contract details",
16           "instructions": "Carefully review the contract terms and conditions for compliance and completeness.",
17           "dependsOn": []
18         },
19         {
20           "id": "task-002",
21           "title": "Obtain initial approvals",
22           "instructions": "Get approval from the legal and sales departments before proceeding.",
23           "dependsOn": [
24             "task-001"
25           ]
26         }
27       ],
28       "actions": [
29         {
30           "installedActionId": "action-verify-signature",
31           "preApproval": true,
32           "postApproval": false,
33           "dependsOn": [
34             "task-002"
35           ],
36           "trigger": "agent"
37         },
38         {
39           "installedActionId": "action-notify-team",
40           "preApproval": false,
41           "postApproval": true,
42           "dependsOn": [
43             "task-002"
44           ],
45           "trigger": "user"
46         }
47       ],
48       "version": 3,
49       "createdAt": "2024-01-15T09:30:00Z",
50       "updatedAt": "2024-04-10T14:45:00Z",
51       "createdBy": "[email protected]"
52     }
53   ]
54 }

Lists the org-level playbook definitions for the caller tenant. Authorization: any authenticated org member (session + tenant context only, no admin required). Optional query status filters by lifecycle state and MUST be one of draft | active | archived — any other value returns 400 invalid_status. Optional query spaceType filters to playbooks whose spaceTypes includes that space-type slug (playbooks with an empty spaceTypes apply to all space types). Response is { data: Playbook[] } — a single unpaginated array; each Playbook carries id, name, description, status, spaceTypes, tasks, actions, version, createdAt/updatedAt, createdBy.

Lists the org-level playbook definitions for the caller tenant. Authorization: any authenticated org member (session + tenant context only, no admin required). Optional query `status` filters by lifecycle state and MUST be one of `draft` | `active` | `archived` — any other value returns 400 `invalid_status`. Optional query `spaceType` filters to playbooks whose `spaceTypes` includes that space-type slug (playbooks with an empty `spaceTypes` apply to all space types). Response is `{ data: Playbook[] }` — a single unpaginated array; each Playbook carries id, name, description, status, spaceTypes, tasks, actions, version, createdAt/updatedAt, createdBy.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

statusenumOptional

Lifecycle filter: draft, active or archived. Any other value returns 400 invalid_status.

Allowed values:

spaceTypestringOptional>=1 character

Only playbooks whose spaceTypes includes this identifier. Playbooks with an empty spaceTypes apply everywhere.

Response

The playbook definitions.

datalist of objects