Get a data object's compiled JSON schema

GET

/data-objects/:id/schema

GET

/data-objects/:id/schema

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

1 {
2   "schema": {
3     "$schema": "http://json-schema.org/draft-07/schema#",
4     "title": "Customer",
5     "type": "object",
6     "properties": {
7       "customerId": {
8         "type": "string",
9         "format": "uuid",
10         "description": "Unique identifier for the customer"
11       },
12       "name": {
13         "type": "string",
14         "description": "Full name of the customer"
15       },
16       "email": {
17         "type": "string",
18         "format": "email",
19         "description": "Email address of the customer"
20       },
21       "createdAt": {
22         "type": "string",
23         "format": "date-time",
24         "description": "Timestamp when the customer was created"
25       },
26       "isActive": {
27         "type": "boolean",
28         "description": "Indicates if the customer is currently active"
29       }
30     },
31     "required": [
32       "customerId",
33       "name",
34       "email",
35       "createdAt"
36     ],
37     "additionalProperties": false
38   }
39 }

Returns the compiled JSON Schema for an object definition. 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 compiled JSON Schema.

schemamap from strings to any

An arbitrary JSON object.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error