List playbooks with their binding to a space type

GET

/space-types/:spaceTypeId/playbooks

GET

/space-types/:spaceTypeId/playbooks

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

1 {
2   "data": [
3     {
4       "id": "pbk-9f8a7c6d-1234-4e56-b789-0a1b2c3d4e5f",
5       "name": "Incident Response Playbook",
6       "description": "Steps to follow for handling security incidents in the workspace.",
7       "status": "active",
8       "spaceTypes": [
9         "security-workspace"
10       ],
11       "bound": true,
12       "global": false
13     },
14     {
15       "id": "pbk-4d3c2b1a-9876-5f43-e210-9a8b7c6d5e4f",
16       "name": "Company-wide Onboarding",
17       "description": "Standard onboarding process applicable to all space types.",
18       "status": "active",
19       "spaceTypes": [],
20       "bound": false,
21       "global": true
22     },
23     {
24       "id": "pbk-7e6f5d4c-3210-4b98-a765-1c2d3e4f5a6b",
25       "name": "Project Kickoff",
26       "description": "Checklist and tasks for starting new projects in project spaces.",
27       "status": "draft",
28       "spaceTypes": [
29         "project-space",
30         "development-space"
31       ],
32       "bound": false,
33       "global": false
34     }
35   ]
36 }

Admin configuration view of the playbook ↔ space-type binding: returns EVERY playbook definition in the org annotated for the space type named in the path. Each entry carries the playbook id, name, description, status and spaceTypes plus two flags: bound (its spaceTypes explicitly includes this space type) and global (its spaceTypes is empty, so it applies to every space type and cannot be unbound here). Authorization: org admin only — other callers get 403. Returns 404 not_found if the space type does not exist. Response: { data: [...] }, unpaginated.

Admin configuration view of the playbook ↔ space-type binding: returns EVERY playbook definition in the org annotated for the space type named in the path. Each entry carries the playbook id, name, description, status and spaceTypes plus two flags: `bound` (its `spaceTypes` explicitly includes this space type) and `global` (its `spaceTypes` is empty, so it applies to every space type and cannot be unbound here). Authorization: org admin only — other callers get 403. Returns 404 `not_found` if the space type does not exist. Response: `{ data: [...] }`, unpaginated.

Authentication

AuthorizationBearer

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

Path parameters

spaceTypeIdstringRequired

Response

Every playbook, annotated for this space type.

datalist of objects

Errors

404

Not Found Error