List project playbooks

GET

/projects/:projectId/playbooks

GET

/projects/:projectId/playbooks

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

1 {
2   "playbooks": [
3     {
4       "_id": "5f8d0d55b54764421b7156c3",
5       "scope": "library",
6       "templateId": "tpl_9a8b7c6d5e4f3a2b1c0d",
7       "projectId": "proj_1234567890abcdef",
8       "sourceDefinitionId": "def_abcdef1234567890",
9       "sourceVersion": 2.3,
10       "slug": "customer-onboarding",
11       "name": "Customer Onboarding",
12       "description": "Playbook for onboarding new customers efficiently.",
13       "icon": "📋",
14       "color": "#4A90E2",
15       "status": "draft",
16       "numbering": {
17         "step": "1.1"
18       },
19       "startableByUsers": true,
20       "webhookEnabled": true,
21       "webhookSecret": "whsec_4f3a2b1c0d9e8f7a",
22       "orchestrator": {
23         "type": "sequential",
24         "retryPolicy": "exponential-backoff"
25       },
26       "startForm": {
27         "fields": [
28           {
29             "name": "customerName",
30             "type": "text",
31             "required": true
32           },
33           {
34             "name": "startDate",
35             "type": "date",
36             "required": false
37           }
38         ]
39       },
40       "tasks": [
41         {
42           "taskId": "task_001",
43           "name": "Send welcome email",
44           "type": "email"
45         }
46       ],
47       "dependencies": [
48         {
49           "dependencyId": "dep_123",
50           "type": "approval"
51         }
52       ],
53       "version": 1.1,
54       "archivedAt": null,
55       "briefId": "brief_7890abcdef123456",
56       "createdAt": "2024-05-10T09:15:00Z",
57       "updatedAt": "2024-06-01T14:45:00Z",
58       "createdBy": "user_5a6b7c8d9e0f1a2b3c4d"
59     }
60   ]
61 }

Lists the playbooks scoped to a project, most recently updated first. Playbooks owned by a not-yet-approved brief are hidden. Optionally filter by status.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

The project id.

Query parameters

statusenumOptional

Filter to a single playbook status.

Allowed values:

Response

The project's playbooks.

playbookslist of objects

Errors

401

Unauthorized Error

404

Not Found Error