Skip to content
XOS Developers

recordGrants

Settings module · 5 operations

List record grant rows

GET/record-grants

A grant on specific records, with scope and expiry. Returns a cursor page of record grant rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a record grant

POST/record-grants

A grant on specific records, with scope and expiry. Creates a record grant. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a record grant

GET/record-grants/{id}

A grant on specific records, with scope and expiry. Returns one record grant with its `ETag`. A record grant the caller may not see returns 404.

Update a record grant

PATCH/record-grants/{id}

A grant on specific records, with scope and expiry. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a record grant

DELETE/record-grants/{id}

A grant on specific records, with scope and expiry. Soft-deletes the record grant: it moves to Trash and can be restored for its table's retention period.