Get a project by number key

GET

/projects/by-number/:numberKey

GET

/projects/by-number/:numberKey

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

1 {
2   "project": {
3     "_id": "64b8f9a2e4b0c123456789ab",
4     "number": 42,
5     "prefix": "IMM",
6     "numberKey": "IMM-42",
7     "name": "Immersive Media Project",
8     "description": "A project focused on developing immersive media experiences using VR and AR technologies.",
9     "icon": "🎥",
10     "templateId": "tmpl_9876543210abcdef",
11     "sections": [
12       {
13         "id": "sec_001",
14         "kind": "overview",
15         "title": "Project Overview",
16         "config": {
17           "summary": "This section provides a high-level summary of the project goals and milestones."
18         }
19       }
20     ],
21     "access": {
22       "roles": [
23         "admin",
24         "editor",
25         "viewer"
26       ],
27       "userIds": [
28         "user_12345",
29         "user_67890"
30       ]
31     },
32     "status": "active",
33     "closedAt": null,
34     "createdAt": "2024-04-10T09:15:00Z",
35     "updatedAt": "2024-06-01T16:45:00Z",
36     "createdBy": "user_12345",
37     "createdByAttribution": "Jane Doe",
38     "provisionAttempt": null,
39     "storageBackend": {
40       "kind": "managed",
41       "credentialId": "cred_abc123def456",
42       "rootDirectoryId": "dir_789xyz"
43     }
44   }
45 }

Returns a single project by its PREFIX-N number key. 404 when missing or inaccessible.

Authentication

AuthorizationBearer

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

Path parameters

numberKeystringRequired

The project’s PREFIX-N number key (e.g. IMM-42).

Response

The project.

projectobject

Errors

401

Unauthorized Error

404

Not Found Error