List resources
Returns a paginated JSON:API collection of an object’s resources. Use include to embed related resources and filter to narrow results by field — a bare value is an exact match, including on collection fields (filter[email_addresses]=jane@acme.com); shorthand operators are parsed from the value (filter[status]=active,pending, filter[amount]=>100, filter[name]=*Smith*, filter[assigned]=null), or name them explicitly (filter[start][Is on or after]=2025-01-01, filter[domains][Contains]=acme). To filter on a relationship field, include that relationship: filter[author.name]=John&include=author.
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.
The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).
Query Parameters
Offset pagination, e.g. page[offset]=0&page[limit]=100.
Default
{ "offset": 0, "limit": 500}Sort order, e.g. sortOrder[column]=_created_at&sortOrder[dir]=DESC.
Comma-separated relationship names to embed under relationships and return in included, e.g. include=company,deals.
Nested filter object keyed by field name, e.g. filter[status]=active or filter[amount][Greater than]=100. See the endpoint description for the full operator syntax.
Response Body
application/json
curl -X GET "https://example.com/workspaces/string/objects/string/resources"{ "links": { "next": null, "prev": null }, "meta": { "total_records": 1, "total_pages": 1, "offset": 0, "limit": 50 }, "data": [ { "type": "person", "id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71", "attributes": { "_id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71", "name": { "first_name": "Jane", "last_name": "Doe" }, "email_addresses": { "items": [ "jane@acme.com" ] }, "job_title": "VP of Marketing", "company_id": "c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88", "_created_at": "2026-01-15T09:30:00.000Z", "_updated_at": "2026-02-01T17:45:00.000Z" } } ], "included": []}Get a resource
Returns a single resource as a JSON:API document. Use `include` to embed related resources under `relationships` and return them in `included`.
Create a custom object
Creates a new custom object type in the workspace and returns its generated JSON Schema. The name is normalized to a `c_`-prefixed identifier (for example "Sales Order" becomes `c_sales_order`).