List active playbooks available in a space

GET

/spaces/:spaceId/playbooks

GET

/spaces/:spaceId/playbooks

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

1 {
2   "data": [
3     {
4       "id": "pb-8f3a2c1d",
5       "name": "Contract intake",
6       "description": "A playbook to guide the intake and review of new contracts.",
7       "status": "active",
8       "spaceTypes": [
9         "legal",
10         "compliance"
11       ],
12       "tasks": [
13         {
14           "id": "task-001",
15           "title": "Review contract terms",
16           "instructions": "Carefully review all contract terms and highlight any unusual clauses.",
17           "dependsOn": []
18         },
19         {
20           "id": "task-002",
21           "title": "Verify signatures",
22           "instructions": "Ensure all required parties have signed the contract.",
23           "dependsOn": [
24             "task-001"
25           ]
26         }
27       ],
28       "actions": [
29         {
30           "installedActionId": "action-verify-signature",
31           "preApproval": false,
32           "postApproval": true,
33           "dependsOn": [
34             "task-002"
35           ],
36           "trigger": "user"
37         }
38       ],
39       "version": 3,
40       "createdAt": "2024-01-15T09:30:00Z",
41       "updatedAt": "2024-04-10T14:45:00Z",
42       "createdBy": "[email protected]"
43     }
44   ]
45 }

Lists the ACTIVE playbook definitions launchable in this space, i.e. whose spaceTypes include the space’s spaceType (resolved server-side from the space record — the caller never passes it). These are the playbooks a user can start as a run here. Authorization: requires space:read on the space (org admins bypass); callers without it get 404 (existence is hidden). 404 is also returned when the space does not exist. Returns { data: Playbook[] } with no pagination; each Playbook carries its id, name, description, tasks and configured actions.

Lists the ACTIVE playbook definitions launchable in this space, i.e. whose spaceTypes include the space's spaceType (resolved server-side from the space record — the caller never passes it). These are the playbooks a user can start as a run here. Authorization: requires `space:read` on the space (org admins bypass); callers without it get 404 (existence is hidden). 404 is also returned when the space does not exist. Returns `{ data: Playbook[] }` with no pagination; each Playbook carries its id, name, description, tasks and configured actions.

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

Response

Active playbooks launchable in this space.

datalist of objects

Errors

404

Not Found Error