Skip to main content

Detailed information about a calendar

​
allowed_appointment_kinds
integer[]
required

List of appointment kind IDs that can be booked on this calendar.

​
block_increment_minutes
enum<integer>
required

The granularity at which blocks should be scheduled in this calendar.

Available options:
10,
15,
20,
30,
40,
45,
50,
60
​
clinic_id
integer
required

The ID of the clinic this calendar belongs to.

​
default_duration_minutes
enum<integer>
required

The default time a generic appointment on this calendar should be booked for.

Available options:
10,
15,
20,
30,
40,
45,
50,
60
​
id
integer
required

The unique identifier for the calendar.

​
is_client_booking_enabled
boolean
required

Whether client booking is enabled for this calendar.

​
name
string
required

Display name for the calendar.

​
non_exotic_species
string[]
required

List of species that the clinic defines as not exotic.