Skip to main content
GET
List all calendar kind preferences

Authorizations

Authorization
string
header
required

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

Query Parameters

ids
integer[] | null

When provided, filters to objects with these IDs.

ending_before
integer | null

A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as starting_after.

starting_after
integer | null

A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as ending_before.

limit
integer
default:10

The maximum number of items to return per page.

Required range: 1 <= x <= 100
clinic_id
integer | null

The ID of the clinic to fetch calendar kind preferences for

calendar_id
integer | null

The ID of the calendar to fetch calendar kind preferences for

calendar_resource_id
integer | null

The ID of the calendar resource to fetch calendar kind preferences for

appointment_kind_id
integer | null

The ID of the appointment kind to fetch calendar kind preferences for

is_client_bookable
boolean | null

Whether the calendar kind preference is client bookable

species
enum<string>[]

The species to fetch calendar kind preferences for, this is filtering across the resources allowed species list

Available options:
CANINE,
FELINE,
EQUINE,
AVIAN,
BOVINE,
FERRET,
RABBIT,
RODENT,
REPTILE,
AMPHIBIAN,
FISH,
PORCINE,
CAPRINE,
SHEEP,
CAMELID,
RATITE,
MARSUPIAL,
MUSTELID,
CERVID,
PROCYONIDAE,
ERINACEIDAE,
MEPHITIDAE,
OTHER,
UNSPECIFIED

Response

200 - application/json

OK

data
CalendarKindPreference · object[]
required

A single page of data contained within this list.

next_page
string
required

A URL linking to the next page of this list.

has_more
boolean
default:false

Whether there are more pages or data in this list.

type
string
default:list

Type of this object. Always list.