Get a playbook definition

GET

/playbooks/:playbookId

GET

/playbooks/:playbookId

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

200Retrieved

1 {
2   "data": {
3     "id": "pb-9f8e7d6c5b4a3",
4     "name": "Contract intake",
5     "description": "This playbook guides the legal team through the contract intake process, ensuring all necessary steps are completed before approval.",
6     "status": "draft",
7     "spaceTypes": [
8       "legal",
9       "contracts"
10     ],
11     "tasks": [
12       {
13         "id": "task-001",
14         "title": "Review contract details",
15         "instructions": "Carefully review the contract terms and conditions for compliance and completeness.",
16         "dependsOn": []
17       },
18       {
19         "id": "task-002",
20         "title": "Verify client information",
21         "instructions": "Confirm the client's details and contact information are accurate and up to date.",
22         "dependsOn": [
23           "task-001"
24         ]
25       }
26     ],
27     "actions": [
28       {
29         "installedActionId": "action-approve-contract",
30         "preApproval": true,
31         "postApproval": false,
32         "dependsOn": [
33           "task-002"
34         ],
35         "trigger": "user"
36       }
37     ],
38     "version": 3,
39     "createdAt": "2024-01-15T09:30:00Z",
40     "updatedAt": "2024-04-10T14:45:00Z",
41     "createdBy": "[email protected]"
42   }
43 }

Fetches a single playbook definition by playbookId, scoped to the caller tenant. Authorization: any authenticated org member (session + tenant context only, no admin required). Returns 404 if the playbook does not exist in this org. Response: { data: Playbook }.

Authentication

AuthorizationBearer

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

Path parameters

playbookIdstringRequired

Response

The playbook definition.

dataobject