Skip to main content
All CRUD methods accept an optional AbortSignal as their last parameter. See Cancellation & Cleanup for cancellation patterns.

listRecords(entityKey, options?, signal?)

Fetches a page of records with optional filtering and sorting.
Options: See Pagination for cursor-based pagination patterns.

getRecord(entityKey, id, signal?)

Fetches a single record by ID.

createRecord(entityKey, data, signal?)

Creates a new record. Returns the created record including its assigned id and system timestamps.
Rules:
  • Do not include system fields (id, created_at, updated_at) — they are set automatically.
  • Keys that are not declared fields of the entity are dropped. Each value is checked against its field’s type and constraints; a failing value throws ErrorCode.ValidationFailed with the field in getFieldErrors().

updateRecord(entityKey, id, data, signal?)

Partially updates a record. Only the fields you include are changed — omitted fields are untouched.
To clear an optional field, send null:

deleteRecord(entityKey, id, signal?)

Deletes a record. Returns void (no response body).
A deleted record can no longer be retrieved, listed, or updated through the SDK or the Data API. It is retained server-side for audit, not restorable from the SDK.

Record Shape

Every record includes these system fields in addition to your schema fields: Never include system fields in create or update payloads.