List template playbooks

GET

/project-templates/:templateId/playbooks

GET

/project-templates/:templateId/playbooks

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

1 {
2   "playbooks": [
3     {
4       "_id": "5f8d0d55b54764421b7156c3",
5       "scope": "template",
6       "templateId": "tpl_9a8b7c6d5e4f3a2b1c0d",
7       "projectId": null,
8       "sourceDefinitionId": "def_1234567890abcdef",
9       "sourceVersion": 2.3,
10       "slug": "onboarding-new-employees",
11       "name": "Employee Onboarding",
12       "description": "A playbook to guide the onboarding process for new hires.",
13       "icon": "👥",
14       "color": "#4A90E2",
15       "status": "active",
16       "numbering": {
17         "taskPrefix": "ONB",
18         "stepFormat": "numeric"
19       },
20       "startableByUsers": true,
21       "webhookEnabled": false,
22       "webhookSecret": null,
23       "orchestrator": {
24         "type": "sequential",
25         "retryPolicy": "exponentialBackoff"
26       },
27       "startForm": {
28         "fields": [
29           {
30             "name": "employeeName",
31             "type": "text",
32             "label": "Employee Name",
33             "required": true
34           },
35           {
36             "name": "startDate",
37             "type": "date",
38             "label": "Start Date",
39             "required": true
40           }
41         ]
42       },
43       "tasks": [
44         {
45           "taskId": "task_001",
46           "title": "Setup workstation",
47           "assignedTo": "it_support"
48         }
49       ],
50       "dependencies": [
51         {
52           "dependencyId": "dep_001",
53           "type": "completion",
54           "taskId": "task_001"
55         }
56       ],
57       "version": 2.3,
58       "archivedAt": null,
59       "briefId": null,
60       "createdAt": "2024-05-10T09:15:00Z",
61       "updatedAt": "2024-06-01T14:45:00Z",
62       "createdBy": "user_7f9e8d6c5b4a3f2e1d0c"
63     }
64   ]
65 }

Lists the playbooks scoped to a project template, most recently updated first. Optionally filter by status.

Authentication

AuthorizationBearer

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

Path parameters

templateIdstringRequired

The project template id.

Query parameters

statusenumOptional

Filter to a single playbook status.

Allowed values:

Response

The template's playbooks.

playbookslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error