Create a custom view

POST

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

Creates a custom table view for the project+object. Validates field keys, filter operands, and sort/filter paths against the definition (422 on invalid view body). Requires data-view:manage on the project.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

objectIdstringRequired

Request

This endpoint expects an object.

namestringRequired1-200 characters

fieldslist of objectsOptional

filterslist of objectsOptional

sortslist of objectsOptional

filterLogicstringOptional>=1 character

Response

The created view.

viewobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

1	curl -X POST https:/https://api/projects/projectId/data-objects/objectId/views \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Active Users View"
6	}'

1	{
2	"view": {
3	"_id": "64b8f9a2e4b0c123456789ab",
4	"projectId": "proj_9876543210abcdef",
5	"objectDefinitionId": "obj_1234567890abcdef",
6	"name": "Active Users View",
7	"type": "table",
8	"isDefault": false,
9	"filterLogic": "(1 AND 2) OR 3",
10	"fields": [
11	{}
12	],
13	"filters": [
14	{}
15	],
16	"sorts": [
17	{}
18	],
19	"createdAt": "2024-06-15T09:30:00Z",
20	"updatedAt": "2024-06-15T09:30:00Z",
21	"createdBy": "user_abc123xyz"
22	}
23	}