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

# Fetch a calendar designation

> Fetches a calendar designation by its ID.

A **calendar designation** defines a time window on a specific resource's schedule that is reserved for particular appointment kinds (e.g., a block reserved exclusively for surgeries or dental cleanings). Designations can be one-off or recurring.

If a designation is an exception to a recurring series, it references the parent recurring designation.



## OpenAPI

````yaml get /ext/v2/calendar-designations/{calendar_designation_id}/
openapi: 3.1.0
info:
  description: ''
  title: NinjaAPI
  version: 2.0.0
servers:
  - url: https://connect.vetcove.com/
security: []
paths:
  /ext/v2/calendar-designations/{calendar_designation_id}/:
    get:
      tags:
        - Scheduler
      summary: Fetch a calendar designation
      description: >-
        Fetches a calendar designation by its ID.


        A **calendar designation** defines a time window on a specific
        resource's schedule that is reserved for particular appointment kinds
        (e.g., a block reserved exclusively for surgeries or dental cleanings).
        Designations can be one-off or recurring.


        If a designation is an exception to a recurring series, it references
        the parent recurring designation.
      operationId: calendar_designations_get
      parameters:
        - description: The ID of the calendar designation to fetch.
          in: path
          name: calendar_designation_id
          required: true
          schema:
            description: The ID of the calendar designation to fetch.
            title: Calendar Designation Id
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCalendarDesignationSchema'
          description: OK
      security:
        - ExternalAPIAuth: []
components:
  schemas:
    ExternalCalendarDesignationSchema:
      properties:
        appointment_kind_ids:
          description: The IDs of the appointment kinds this designation is reserved for.
          items:
            type: integer
          title: Appointment Kind Ids
          type: array
        calendar_resource_id:
          description: The ID of the calendar resource this designation is assigned to.
          title: Calendar Resource Id
          type: integer
        clinic_id:
          description: The ID of the clinic this designation belongs to.
          title: Clinic Id
          type: integer
        created:
          description: The datetime this object was created.
          format: date-time
          title: Created
          type: string
        deleted:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The datetime this record was soft deleted.
          title: Deleted
        duration_minutes:
          description: Duration of the designation in minutes.
          title: Duration Minutes
          type: integer
        end_datetime:
          description: ISO 8601 formatted end datetime of the designation in UTC.
          format: date-time
          title: End Datetime
          type: string
        id:
          description: The unique identifier for this calendar designation.
          title: Id
          type: integer
        is_deleted:
          description: Whether this record is soft deleted or not.
          title: Is Deleted
          type: boolean
        is_recurring:
          description: Whether this record follows a recurrence pattern.
          title: Is Recurring
          type: boolean
        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
        name:
          description: Display name for this designation.
          title: Name
          type: string
        recurrence:
          anyOf:
            - $ref: '#/components/schemas/RecurrenceBreakdownSchema'
            - type: 'null'
          description: Structured recurrence pattern, if recurring.
        recurrence_excluded_datetimes:
          description: Specific datetimes excluded from the recurrence pattern.
          items:
            format: date-time
            type: string
          title: Recurrence Excluded Datetimes
          type: array
        recurring_designation_id:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            If this is an exception to a recurring designation, the ID of the
            parent.
          title: Recurring Designation Id
        rrule:
          anyOf:
            - type: string
            - type: 'null'
          description: Raw RFC 2445 RRule string, if recurring.
          title: Rrule
        start_datetime:
          description: ISO 8601 formatted start datetime of the designation in UTC.
          format: date-time
          title: Start Datetime
          type: string
      required:
        - created
        - modified
        - is_deleted
        - deleted
        - is_recurring
        - id
        - clinic_id
        - calendar_resource_id
        - name
        - start_datetime
        - end_datetime
        - duration_minutes
      title: ExternalCalendarDesignationSchema
      type: object
    RecurrenceBreakdownSchema:
      description: Structured representation of an RFC 2445 recurrence rule.
      properties:
        days_of_week:
          description: >-
            Two-letter day codes. Applicable for WEEKLY and some MONTHLY
            patterns.
          items:
            enum:
              - MO
              - TU
              - WE
              - TH
              - FR
              - SA
              - SU
            type: string
          title: Days Of Week
          type: array
        end_after_occurrences:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Total number of occurrences before the recurrence ends, if bounded
            by count.
          title: End After Occurrences
        end_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: >-
            ISO 8601 date (YYYY-MM-DD) when the recurrence ends, if bounded by
            date.
          title: End Date
        frequency:
          description: The base recurring frequency.
          enum:
            - YEARLY
            - MONTHLY
            - WEEKLY
            - DAILY
            - HOURLY
            - MINUTELY
            - SECONDLY
          title: Frequency
          type: string
        interval:
          description: >-
            The interval between each frequency iteration (e.g., 2 means every 2
            weeks for WEEKLY).
          title: Interval
          type: integer
      required:
        - frequency
        - interval
      title: RecurrenceBreakdownSchema
      type: object
  securitySchemes:
    ExternalAPIAuth:
      scheme: bearer
      type: http

````