Skip to main content
GET
Fetch a calendar kind preference

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

calendar_kind_preference_id
integer
required

The ID of the calendar kind preference to fetch

Response

200 - application/json

OK

Calendar Kind Preferences represent configurations of an AppointmentKind for a specific Calendar

appointment_kind_id
integer
required

The ID of the appointment kind this preference is for.

calendar_id
integer
required

The ID of the calendar this preference is for.

clinic_id
integer
required

The ID of the clinic this preference belongs to.

created
string<date-time>
required

The datetime this object was created.

default_duration_minutes
enum<integer>
required

The default duration in minutes for appointments of this kind on this calendar.

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

The unique identifier for this calendar kind preference object.

is_client_bookable
boolean
required

Whether clients can book this appointment kind.

min_hours_before_booking
integer
required

The minimum number of hours in advance appointments can be booked, for this appointment kind and calendar.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

calendar_resource_ids
integer[]

Calendar resources this appointment kind is limited to.