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.
const result = await sdk.listRecords('tasks', {
filter: { status: { eq: 'open' } },
sort: 'due_date:asc',
pageSize: 25,
cursor: undefined, // omit on first page; pass meta.cursor for subsequent pages
});
// result.data — RecordData[]
// result.meta — { hasMore: boolean, cursor: string|null, total?: number }
| Option | Type | Default | Description |
|---|
filter | Filter object | — | See Filtering |
sort | string | — | "fieldKey:asc" or "fieldKey:desc" |
pageSize | number | 25 | Records per page (max 100) |
cursor | string | — | Pagination cursor from previous response |
getRecord(entityKey, id, signal?)
Fetches a single record by ID.
const result = await sdk.getRecord('tasks', '01JA...'); // record id (ULID)
// result.data — RecordData (with id, timestamps, and all field values)
createRecord(entityKey, data, signal?)
Creates a new record. Returns the created record including its assigned id and system timestamps.
const result = await sdk.createRecord('tasks', {
title: 'Buy milk',
status: 'open',
due_date: '2026-04-01',
});
// result.data — RecordData (includes id, created_at, etc.)
- Do not include system fields (
id, created_by, updated_by, created_at, updated_at) — they are set automatically.
- Required fields must be present. Missing required fields throw
ErrorCode.ValidationFailed.
updateRecord(entityKey, id, data, signal?)
Partially updates a record. Only the fields you include are changed — omitted fields are untouched.
const result = await sdk.updateRecord('tasks', '01JA...', {
status: 'done',
});
// result.data — full updated RecordData
null:
await sdk.updateRecord('tasks', '01JA...', {
due_date: null, // clears the field
});
deleteRecord(entityKey, id, signal?)
Deletes a record. Returns void (no response body).
Deleted records are permanently removed — they cannot be retrieved, listed, or restored via the SDK.
await sdk.deleteRecord('tasks', '01JA...');
Record Shape
Every record includes these system fields in addition to your schema fields:
| Field | Type | Description |
|---|
id | string (ULID) | Unique record ID |
created_by | string (ULID) | User who created the record |
updated_by | string (ULID) | User who last updated the record |
created_at | ISO 8601 string | Creation timestamp |
updated_at | ISO 8601 string | Last update timestamp |
