List record views

GET

/projects/:projectId/data-objects/:objectId/views

GET

/projects/:projectId/data-objects/:objectId/views

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

1 {
2   "default": {
3     "_id": "view_63f8a1b2e4b0c123456789ab",
4     "projectId": "proj_9f8e7d6c5b4a3210fedcba98",
5     "objectDefinitionId": "objdef_123abc456def789ghi012jkl",
6     "name": "Default Table View",
7     "type": "table",
8     "isDefault": true,
9     "filterLogic": "AND",
10     "fields": [
11       {
12         "fieldName": "status",
13         "label": "Status",
14         "type": "string"
15       },
16       {
17         "fieldName": "createdAt",
18         "label": "Created At",
19         "type": "datetime"
20       },
21       {
22         "fieldName": "assignedTo",
23         "label": "Assigned To",
24         "type": "string"
25       }
26     ],
27     "filters": [
28       {
29         "field": "status",
30         "operator": "!=",
31         "value": "archived"
32       }
33     ],
34     "sorts": [
35       {
36         "field": "createdAt",
37         "direction": "desc"
38       }
39     ],
40     "createdAt": "2024-05-10T09:15:00Z",
41     "updatedAt": "2024-05-15T12:00:00Z",
42     "createdBy": "user_7a8b9c0d1e2f3g4h5i6j7k8l"
43   },
44   "views": [
45     {
46       "_id": "view_74b9c2d3e5f6a78901234567",
47       "projectId": "proj_9f8e7d6c5b4a3210fedcba98",
48       "objectDefinitionId": "objdef_123abc456def789ghi012jkl",
49       "name": "Open Tasks",
50       "type": "table",
51       "isDefault": false,
52       "filterLogic": "AND",
53       "fields": [
54         {
55           "fieldName": "title",
56           "label": "Task Title",
57           "type": "string"
58         },
59         {
60           "fieldName": "dueDate",
61           "label": "Due Date",
62           "type": "date"
63         },
64         {
65           "fieldName": "priority",
66           "label": "Priority",
67           "type": "string"
68         }
69       ],
70       "filters": [
71         {
72           "field": "status",
73           "operator": "=",
74           "value": "open"
75         }
76       ],
77       "sorts": [
78         {
79           "field": "priority",
80           "direction": "asc"
81         },
82         {
83           "field": "dueDate",
84           "direction": "asc"
85         }
86       ],
87       "createdAt": "2024-05-12T08:00:00Z",
88       "updatedAt": "2024-05-16T10:30:00Z",
89       "createdBy": "user_1a2b3c4d5e6f7g8h9i0j1k2l"
90     }
91   ]
92 }

Returns the default view (lazily seeded on first read) plus any custom views for the project+object. Requires data-record:read on the project.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

objectIdstringRequired

Response

The default view and the custom views.

defaultobject

viewslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error