v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Calendar

List Calendars

Retrieve a list of calendars

get/calendar

Query parameters

idstring

Calendar ID

created_atstring

Creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

namestring

Name of the calendar

typestring

Calendar type (virtual or provider). Only virtual calendars can be created via the API.

external_idstring

External ID

selectstring

Filtering Columns

orderstring

Ordering. Allowed Fields: created_at, updated_at, name

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

idstring uuid

Calendar ID

created_atstring timestamp with time zone

Creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

namestring text

Name of the calendar

type'virtual' | 'provider' public.calendar_type

Calendar type (virtual or provider). Only virtual calendars can be created via the API.

external_idstring text nullable

External ID