List object schemas
Returns every object schema in the workspace as a cursor-paginated list of JSON:API resources. Each resource holds the full JSON Schema for one object type, including its fields, relationships, and presentation metadata.
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
Response Body
application/json
curl -X GET "https://example.com/workspaces/string/schemas"{ "links": { "next": null }, "data": [ { "id": "https://getclarify.ai/schemas/entities/c_project", "type": "schema", "attributes": { "$schema": "https://json-schema.org/draft/2020-12/clarify", "$id": "https://getclarify.ai/schemas/entities/c_project", "title": "Project", "type": "object", "xClarifyNamespace": "objects", "xClarifyLabel": { "singular": "Project", "plural": "Projects" }, "xClarifyAIDescription": "A customer project tracked alongside deals and companies.", "properties": { "name": { "type": "string", "title": "Name", "xClarifyPrimary": true }, "status": { "type": [ "string", "null" ], "title": "Status", "enum": [ "Planning", "In progress", "Complete" ] }, "company_id": { "type": [ "string", "null" ], "title": "Company", "xClarifyRelationship": { "kind": "many-to-one", "entity": "company", "field": "projects" } } } } } ]}List schema activities
Returns the history of schema changes for an object type as a paginated list of activities. Each activity groups the change events for one modification, such as adding or editing a field.
Add or remove enum field values
Adds or removes options on enum (single- and multi-select) fields for one object type. The request carries exactly one item in `data`; each field in `meta` names an `append` or `remove` operation. Removing an option also clears it from every record that holds it, and the response returns once the records are updated. To modify several object types, send separate requests.