> ## Documentation Index
> Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml get /ext/v2/calendar-kind-preferences/
openapi: 3.1.0
info:
  description: ''
  title: NinjaAPI
  version: 2.0.0
servers:
  - url: https://connect.vetcove.com/
security: []
paths:
  /ext/v2/calendar-kind-preferences/:
    get:
      tags:
        - Scheduler
      summary: List all calendar kind preferences
      description: >-
        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.
      operationId: calendar_kind_preferences_list
      parameters:
        - description: When provided, filters to objects with these IDs.
          in: query
          name: ids
          required: false
          schema:
            anyOf:
              - items:
                  type: integer
                type: array
              - type: 'null'
            description: When provided, filters to objects with these IDs.
            title: Ids
        - description: >-
            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`.
          in: query
          name: ending_before
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              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`.
            title: Ending Before
        - description: >-
            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`.
          in: query
          name: starting_after
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              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`.
            title: Starting After
        - description: The maximum number of items to return per page.
          in: query
          name: limit
          required: false
          schema:
            default: 10
            description: The maximum number of items to return per page.
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: The ID of the clinic to fetch calendar kind preferences for
          in: query
          name: clinic_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: The ID of the clinic to fetch calendar kind preferences for
            title: Clinic Id
        - description: The ID of the calendar to fetch calendar kind preferences for
          in: query
          name: calendar_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: The ID of the calendar to fetch calendar kind preferences for
            title: Calendar Id
        - description: >-
            The ID of the calendar resource to fetch calendar kind preferences
            for
          in: query
          name: calendar_resource_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              The ID of the calendar resource to fetch calendar kind preferences
              for
            title: Calendar Resource Id
        - description: >-
            The ID of the appointment kind to fetch calendar kind preferences
            for
          in: query
          name: appointment_kind_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              The ID of the appointment kind to fetch calendar kind preferences
              for
            title: Appointment Kind Id
        - description: Whether the calendar kind preference is client bookable
          in: query
          name: is_client_bookable
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: Whether the calendar kind preference is client bookable
            title: Is Client Bookable
        - description: >-
            The species to fetch calendar kind preferences for, this is
            filtering across the resources allowed species list
          in: query
          name: species
          required: false
          schema:
            default: []
            description: >-
              The species to fetch calendar kind preferences for, this is
              filtering across the resources allowed species list
            items:
              enum:
                - CANINE
                - FELINE
                - EQUINE
                - AVIAN
                - BOVINE
                - FERRET
                - RABBIT
                - RODENT
                - REPTILE
                - AMPHIBIAN
                - FISH
                - PORCINE
                - CAPRINE
                - SHEEP
                - CAMELID
                - RATITE
                - MARSUPIAL
                - MUSTELID
                - CERVID
                - PROCYONIDAE
                - ERINACEIDAE
                - MEPHITIDAE
                - OTHER
                - UNSPECIFIED
              title: PatientKind
              type: string
            title: Species
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarKindPreferenceList'
          description: OK
      security:
        - ExternalAPIAuth: []
components:
  schemas:
    CalendarKindPreferenceList:
      properties:
        data:
          description: A single page of data contained within this list.
          items:
            $ref: '#/components/schemas/ExternalCalendarKindPreferenceSchema'
          title: Data
          type: array
        has_more:
          default: false
          description: Whether there are more pages or data in this list.
          title: Has More
          type: boolean
        next_page:
          description: A URL linking to the next page of this list.
          title: Next Page
          type: string
        type:
          default: list
          description: Type of this object. Always `list`.
          title: Type
          type: string
      required:
        - data
        - next_page
      title: CalendarKindPreferenceList
      type: object
    ExternalCalendarKindPreferenceSchema:
      description: >-
        Calendar Kind Preferences represent configurations of an AppointmentKind
        for a specific Calendar
      properties:
        appointment_kind_id:
          description: The ID of the appointment kind this preference is for.
          title: Appointment Kind Id
          type: integer
        calendar_id:
          description: The ID of the calendar this preference is for.
          title: Calendar Id
          type: integer
        calendar_resource_ids:
          default: []
          description: Calendar resources this appointment kind is limited to.
          items:
            type: integer
          title: Calendar Resource Ids
          type: array
        clinic_id:
          description: The ID of the clinic this preference belongs to.
          title: Clinic Id
          type: integer
        created:
          description: The datetime this object was created.
          format: date-time
          title: Created
          type: string
        default_duration_minutes:
          $ref: '#/components/schemas/MinuteIncrements'
          description: >-
            The default duration in minutes for appointments of this kind on
            this calendar.
        id:
          description: The unique identifier for this calendar kind preference object.
          title: Id
          type: integer
        is_client_bookable:
          description: Whether clients can book this appointment kind.
          title: Is Client Bookable
          type: boolean
        min_hours_before_booking:
          description: >-
            The minimum number of hours in advance appointments can be booked,
            for this appointment kind and calendar.
          title: Min Hours Before Booking
          type: integer
        modified:
          description: >-
            The datetime this object was last modified; changes to related
            entities will not update this field.
          format: date-time
          title: Modified
          type: string
      required:
        - created
        - modified
        - id
        - appointment_kind_id
        - calendar_id
        - clinic_id
        - default_duration_minutes
        - is_client_bookable
        - min_hours_before_booking
      title: CalendarKindPreference
      type: object
    MinuteIncrements:
      enum:
        - 10
        - 15
        - 20
        - 30
        - 40
        - 45
        - 50
        - 60
      title: MinuteIncrements
      type: integer
  securitySchemes:
    ExternalAPIAuth:
      scheme: bearer
      type: http

````