Skip to content
XOS Developers

availabilityCalendars

Gateway module · 5 operations

List availability calendar rows

GET/availability-calendars

A person's availability calendar. Returns a cursor page of availability calendar rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an availability calendar

POST/availability-calendars

A person's availability calendar. Creates an availability calendar. 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 an availability calendar

GET/availability-calendars/{id}

A person's availability calendar. Returns one availability calendar with its `ETag`. A availability calendar the caller may not see returns 404.

Update an availability calendar

PATCH/availability-calendars/{id}

A person's availability calendar. 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 an availability calendar

DELETE/availability-calendars/{id}

A person's availability calendar. Soft-deletes the availability calendar: it moves to Trash and can be restored for its table's retention period.