Get a project

GET

/projects/:id

GET

/projects/:id

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

1 {
2   "project": {
3     "_id": "64b8f9e2a1c4d3f5b7e9a123",
4     "number": 42,
5     "prefix": "PRJ",
6     "numberKey": "042",
7     "name": "Q3 Marketing Campaign",
8     "description": "Project to coordinate all marketing activities for Q3 2024.",
9     "icon": "📈",
10     "templateId": "tmpl_9f8e7d6c5b4a3210",
11     "sections": [
12       {
13         "id": "sec_001",
14         "kind": "task-list",
15         "title": "Initial Planning",
16         "config": {
17           "dueDate": "2024-07-15",
18           "priority": "high"
19         }
20       }
21     ],
22     "access": {
23       "roles": [
24         "project_manager",
25         "marketing_lead"
26       ],
27       "userIds": [
28         "user_12345",
29         "user_67890"
30       ]
31     },
32     "status": "active",
33     "closedAt": null,
34     "createdAt": "2024-06-01T09:00:00Z",
35     "updatedAt": "2024-06-20T15:30:00Z",
36     "createdBy": "user_12345",
37     "createdByAttribution": "Alice Johnson",
38     "provisionAttempt": null,
39     "storageBackend": {
40       "kind": "managed",
41       "credentialId": "cred_abc123xyz",
42       "rootDirectoryId": "dir_987654321"
43     }
44   }
45 }

Returns a single project by id. 404 when missing or inaccessible (existence is never leaked).

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The project id.

Response

The project.

projectobject

Errors

401

Unauthorized Error

404

Not Found Error