Create a record access grant
Shares a single record — a record entity (deal, company, person, or a custom object) or a list, meeting, or message — with a user or the whole workspace at a given access level. Only the record’s owner or a workspace permission admin (records and lists), the record’s owner (messages), a participant (meetings), or the assignee or creator (tasks) can create grants. Requires a user-backed API key; workspace-actor API keys are not supported.
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 shareable object the record belongs to: a record entity (deal, company, person, task, a custom object) or list / meeting / message.
The unique ID of the shared record.
Query Parameters
When true, suppresses in-app and Slack notifications for this mutation and batches its live updates, so open views can lag by up to 20 seconds.
Header Parameters
The API version for this request. Send 2026-11 to get the behavior documented here. Omit it to use your API key's version, which this header can raise but not lower.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/workspaces/string/objects/string/records/string/access" \ -H "clarify-version: 2026-11" \ -H "Content-Type: application/json" \ -d '{ "data": { "type": "object-record-access", "attributes": { "grantee_type": "user", "grantee_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "access_level": "view" } } }'{ "data": { "type": "object-record-access", "id": "2f4a6c8e-0b1d-4a3f-8c5e-7a9b1c3d5e6f", "attributes": { "_id": "2f4a6c8e-0b1d-4a3f-8c5e-7a9b1c3d5e6f", "object_id": "9d2c4e6f-8a1b-4c3d-9e5f-7a9b1c3d5e7f", "grantee_type": "user", "grantee_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "access_level": "view", "source": "share", "_created_at": "2026-01-15T09:30:00.000Z", "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81", "_updated_at": null, "_updated_by": null } }}Run a SQL query
Runs a read-only SQL query over the workspace’s records with the caller’s record access applied, and returns the rows as JSON with offset pagination in `links` and `meta`. A `LIMIT` or `OFFSET` in the SQL bounds the whole result, and `page[offset]` and `page[limit]` (up to 500) page within it. Each page reruns the query, so add an `ORDER BY` for stable pages. 64-bit integers, such as `COUNT(*)`, come back as strings to keep their precision.
Share many records in one request
Grants view access on up to 1000 records to a set of grantees in one request, with grantees times records capped at 10000. Supports `message` (messages you own, email and LinkedIn) and `meeting` (meetings you attended); records you can't manage are skipped and counted in `meta`. Grantees are not notified. Requires a user-backed API key; workspace-actor API keys are not supported.