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.
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 assignedid and system timestamps.
- 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.ValidationFailedwith the field ingetFieldErrors().
updateRecord(entityKey, id, data, signal?)
Partially updates a record. Only the fields you include are changed — omitted fields are untouched.null:
deleteRecord(entityKey, id, signal?)
Deletes a record. Returnsvoid (no response body).
Record Shape
Every record includes these system fields in addition to your schema fields:
Never include system fields in create or update payloads.