List template data objects

GET

/project-templates/:templateId/data-objects

GET

/project-templates/:templateId/data-objects

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

1 {
2   "definitions": [
3     {
4       "_id": "60f7a1c2d4e3b45a9f123456",
5       "scope": "template",
6       "templateId": "tpl_9f8e7d6c5b4a3210",
7       "projectId": null,
8       "nameSingular": "Task",
9       "namePlural": "Tasks",
10       "labelSingular": "Task",
11       "labelPlural": "Tasks",
12       "description": "A unit of work to be completed within the project template.",
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           "key": "completed",
31           "type": "boolean",
32           "required": false,
33           "description": "Whether the task has been completed."
34         }
35       ],
36       "fieldGroups": [
37         {
38           "name": "Basic Info",
39           "fields": [
40             "title",
41             "dueDate"
42           ]
43         },
44         {
45           "name": "Status",
46           "fields": [
47             "completed"
48           ]
49         }
50       ],
51       "version": 3,
52       "archivedAt": null,
53       "createdAt": "2023-11-15T09:30:00Z",
54       "updatedAt": "2024-05-20T16:45:00Z",
55       "createdBy": "user_1234567890abcdef",
56       "cardinality": {
57         "min": 1,
58         "max": null
59       }
60     }
61   ]
62 }

Lists object definitions scoped to a project template. Requires project-template:use.

Authentication

AuthorizationBearer

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

Path parameters

templateIdstringRequired

Query parameters

archivedbooleanOptional

Include archived definitions when true.

Response

The template's object definitions.

definitionslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error