List projects

GET

/projects

GET

/projects

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

1 {
2   "projects": [
3     {
4       "_id": "64b8f9a2e4b0c123456789ab",
5       "number": 42,
6       "prefix": "MK",
7       "numberKey": "MK-42",
8       "name": "Marketing Campaign Q3",
9       "description": "Project to manage all marketing activities for Q3 2024.",
10       "icon": "📈",
11       "templateId": "tpl-9f8e7d6c5b4a3210",
12       "sections": [
13         {
14           "id": "sec-001",
15           "kind": "tasks",
16           "title": "Task List",
17           "config": {
18             "showCompleted": false,
19             "priorityFilter": "high"
20           }
21         }
22       ],
23       "access": {
24         "roles": [
25           "project_manager",
26           "marketing_lead"
27         ],
28         "userIds": [
29           "user-1234abcd",
30           "user-5678efgh"
31         ]
32       },
33       "status": "active",
34       "closedAt": null,
35       "createdAt": "2024-04-01T09:00:00Z",
36       "updatedAt": "2024-06-10T15:45:00Z",
37       "createdBy": "user-1234abcd",
38       "createdByAttribution": "Alice Johnson",
39       "provisionAttempt": null,
40       "openTaskCount": 12,
41       "needsApprovalCount": 3,
42       "activePlaybookRunCount": 1,
43       "lastActivityAt": "2024-06-10T15:30:00Z",
44       "storageBackend": {
45         "kind": "managed",
46         "credentialId": null,
47         "rootDirectoryId": null
48       }
49     }
50   ]
51 }

Returns the projects the caller can access, each decorated with a per-project activity rollup.

Authentication

AuthorizationBearer

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

Query parameters

statusenumOptional

Filter to active or closed projects.

Allowed values:

prefixstringOptional

Filter to projects with this prefix (case-insensitive).

templateIdstringOptional

Filter to projects created from this template.

orderenumOptional

Apply the caller's saved sidebar order to the result.

Allowed values:

Response

The accessible projects.

projectslist of objects

Errors

401

Unauthorized Error