Get a data object by id

GET

/data-objects/:id

GET

/data-objects/:id

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

1 {
2   "definition": {
3     "_id": "a3f1c9d2-4b7e-4f9a-8c3d-2e5b7f9a1d23",
4     "scope": "library",
5     "templateId": "tpl_9f8e7d6c5b4a3",
6     "projectId": null,
7     "nameSingular": "Task",
8     "namePlural": "Tasks",
9     "labelSingular": "Task",
10     "labelPlural": "Tasks",
11     "description": "A task represents a unit of work to be completed within a project or workflow.",
12     "icon": "check-circle",
13     "color": "#4A90E2",
14     "labelFieldKey": "title",
15     "fields": [
16       {
17         "key": "title",
18         "type": "string",
19         "required": true,
20         "label": "Title",
21         "description": "The title of the task"
22       },
23       {
24         "key": "dueDate",
25         "type": "date",
26         "required": false,
27         "label": "Due Date",
28         "description": "The date by which the task should be completed"
29       }
30     ],
31     "fieldGroups": [
32       {
33         "name": "General",
34         "fields": [
35           "title",
36           "dueDate"
37         ]
38       }
39     ],
40     "version": 3,
41     "archivedAt": null,
42     "createdAt": "2023-11-15T09:30:00Z",
43     "updatedAt": "2024-05-10T16:45:00Z",
44     "createdBy": "user_7d8e9f0a1b2c",
45     "cardinality": {
46       "min": 1,
47       "max": null
48     }
49   }
50 }

Returns an object definition in any scope. Project-scoped definitions are hidden (404) from callers without project access. Requires data-object:read.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The object definition.

definitionobject or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error