Clarify APIRecords
Get a record
Returns a single record as a JSON:API resource. Use `include` to embed related records under `relationships`.
Authorization
apiKey Authorization<token>
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
workspace*string
The workspace slug — the {slug} segment of your Clarify workspace URL.
object*string
The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).
id*string
The unique ID of the record.
Query Parameters
include?string
Comma-separated list of relationship names to resolve and embed under relationships, e.g. include=companies,deals.
Response Body
application/json
curl -X GET "https://example.com/workspaces/string/objects/string/records/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"
}
}
}