List project data objects

GET

/projects/:projectId/data-objects

GET

/projects/:projectId/data-objects

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

1 {
2   "definitions": [
3     {
4       "_id": "64b8f9a2e4b0c123456789ab",
5       "scope": "library",
6       "templateId": "tpl_9876543210abcdef",
7       "projectId": "proj_1234567890abcdef",
8       "nameSingular": "Task",
9       "namePlural": "Tasks",
10       "labelSingular": "Task",
11       "labelPlural": "Tasks",
12       "description": "A unit of work to be completed within the project.",
13       "icon": "check_circle",
14       "color": "#4A90E2",
15       "labelFieldKey": "title",
16       "fields": [
17         {
18           "key": "title",
19           "type": "string",
20           "required": true,
21           "description": "The title of the task."
22         },
23         {
24           "key": "dueDate",
25           "type": "date",
26           "required": false,
27           "description": "The due date for the task."
28         }
29       ],
30       "fieldGroups": [
31         {
32           "name": "General",
33           "fields": [
34             "title",
35             "dueDate"
36           ]
37         }
38       ],
39       "version": 3,
40       "archivedAt": null,
41       "createdAt": "2024-06-10T09:15:00Z",
42       "updatedAt": "2024-06-15T12:00:00Z",
43       "createdBy": "user_abc123xyz",
44       "cardinality": {
45         "min": 1,
46         "max": null
47       }
48     }
49   ]
50 }

Lists object definitions scoped to a project (hiding definitions owned by a not-yet-approved brief). An inaccessible project reads as 404.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

Query parameters

archivedbooleanOptional

Include archived definitions when true.

Response

The project's object definitions.

definitionslist of objects

Errors

401

Unauthorized Error

404

Not Found Error