Skip to content
XOS Developers

objects

Platform module · 5 operations

List custom object record rows

GET/objects/{object_key}

A record of a custom object. Values are stored one row per field, never as JSON. Returns a cursor page of custom object record rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a custom object record

POST/objects/{object_key}

A record of a custom object. Values are stored one row per field, never as JSON. Creates a custom object record. 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 custom object record

GET/objects/{object_key}/{id}

A record of a custom object. Values are stored one row per field, never as JSON. Returns one custom object record with its `ETag`. A custom object record the caller may not see returns 404.

Update a custom object record

PATCH/objects/{object_key}/{id}

A record of a custom object. Values are stored one row per field, never as JSON. 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 custom object record

DELETE/objects/{object_key}/{id}

A record of a custom object. Values are stored one row per field, never as JSON. Soft-deletes the custom object record: it moves to Trash and can be restored for its table's retention period.