Clarify APIGet a resource
Returns a single resource as a JSON:API document. Use `include` to embed related resources under `relationships` and return them in `included`.
Authorization
apiKey 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_*).
The unique ID of the record.
Query Parameters
Comma-separated relationship names to embed under relationships and return in included, e.g. include=company,deals.
Response Body
application/json
curl -X GET "https://example.com/workspaces/string/objects/string/resources/string"{
"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": [],
"meta": {}
}List resources in a list
Returns a paginated JSON:API collection of the resources that belong to a specific list, applying the list’s membership on top of any `filter` you pass. Use `include` to embed related resources.
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 — 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`). To filter on a relationship field, include that relationship: `filter[author.name]=John&include=author`.