Skip to content

calendars

Schedule module · 5 operations

List calendar rows

GET/calendars

A working calendar with its time zone. Returns a cursor page of calendar rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a calendar

POST/calendars

A working calendar with its time zone. Creates a 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 a calendar

GET/calendars/{id}

A working calendar with its time zone. Returns one calendar with its `ETag`. A calendar the caller may not see returns 404.

Update a calendar

PATCH/calendars/{id}

A working calendar with its time zone. 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 calendar

DELETE/calendars/{id}

A working calendar with its time zone. Soft-deletes the calendar: it moves to Trash and can be restored for its table's retention period.