Skip to content
XOS Developers

riders

Advancing module · 5 operations

List rider rows

GET/riders

A technical or hospitality rider for an engagement. Returns a cursor page of rider rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a rider

POST/riders

A technical or hospitality rider for an engagement. Creates a rider. 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 rider

GET/riders/{id}

A technical or hospitality rider for an engagement. Returns one rider with its `ETag`. A rider the caller may not see returns 404.

Update a rider

PATCH/riders/{id}

A technical or hospitality rider for an engagement. 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 rider

DELETE/riders/{id}

A technical or hospitality rider for an engagement. Soft-deletes the rider: it moves to Trash and can be restored for its table's retention period.