Skip to content
XOS Developers

customObjectRelations

Platform module · 4 operations

List custom object relation rows

GET/custom-object-relations

A relation from a custom object record to another record. Returns a cursor page of custom object relation rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a custom object relation

POST/custom-object-relations

A relation from a custom object record to another record. Creates a custom object relation. 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 relation

GET/custom-object-relations/{id}

A relation from a custom object record to another record. Returns one custom object relation with its `ETag`. A custom object relation the caller may not see returns 404.

Delete a custom object relation

DELETE/custom-object-relations/{id}

A relation from a custom object record to another record. Soft-deletes the custom object relation: it moves to Trash and can be restored for its table's retention period.