Scheduler

List all calendar kind preferences

Returns a list of all calendar kind preferences across all clinics in the organization. The calendar kind preferences are sorted by creation date, with the most recent appearing first.

A calendar kind preference links an appointment kind to specific calendar resources, defining which resources can handle which types of appointments. It also controls whether that appointment kind is bookable by pet parents online.

get/ext/v2/calendar-kind-preferences/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/calendar-kind-preferences/
  • Auth
    HTTP bearer

Query parameters

idsinteger[] nullable

When provided, filters to objects with these IDs.

ending_beforeinteger nullable

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_afterinteger nullable

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.

limitinteger

The maximum number of items to return per page.

clinic_idinteger nullable

The ID of the clinic to fetch calendar kind preferences for

calendar_idinteger nullable

The ID of the calendar to fetch calendar kind preferences for

calendar_resource_idinteger nullable

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

appointment_kind_idinteger nullable

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

is_client_bookableboolean nullable

Whether the calendar kind preference is client bookable

speciesstring[]

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

Response

OK

has_moreboolean

Whether there are more pages or data in this list.

next_pagestring required

A URL linking to the next page of this list.

typestring

Type of this object. Always list.

Changes

No recorded changes to this operation across all 1 revision of this API.