---
title: "List all calendar designations"
method: GET
path: "/ext/v2/calendar-designations/"
tags: ["Scheduler"]
---

# List all calendar designations

`GET /ext/v2/calendar-designations/`

## Request

- Base URL: `https://connect.vetcove.com`
- URL: `https://connect.vetcove.com/ext/v2/calendar-designations/`
- Auth: HTTP bearer

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

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.

## Query parameters

- `ids` integer[], nullable: When provided, filters to objects with these IDs.
- `ending_before` integer, 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_after` integer, 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`.
- `limit` integer: The maximum number of items to return per page.
- `cursor` string, nullable: A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with `starting_after` or `ending_before` parameters.
- `modified__gte` string, date-time, nullable: Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.
- `modified__lte` string, date-time, nullable: Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with `starting_after` or `ending_before` parameters.
- `is_deleted` 'FALSE' | 'TRUE' | 'ALL': When 'FALSE' (default), filters to non-deleted records only. When 'TRUE', filters to soft-deleted records only. When 'ALL', returns both deleted and non-deleted records.
- `clinic_id` integer, nullable: Filter to calendar designations belonging to the clinic with this ID.
- `calendar_resource_id` integer, nullable: Filter to calendar designations assigned to the calendar resource with this ID.

## Response `200`

OK

- ExternalCalendarDesignationSchemaList
  - `data` ExternalCalendarDesignationSchema[], required: A single page of data contained within this list.
    - `appointment_kind_ids` integer[]: The IDs of the appointment kinds this designation is reserved for.
    - `calendar_resource_id` integer, required: The ID of the calendar resource this designation is assigned to.
    - `clinic_id` integer, required: The ID of the clinic this designation belongs to.
    - `created` string, date-time, required: The datetime this object was created.
    - `deleted` string, date-time, nullable, required: The datetime this record was soft deleted.
    - `duration_minutes` integer, required: Duration of the designation in minutes.
    - `end_datetime` string, date-time, required: ISO 8601 formatted end datetime of the designation in UTC.
    - `id` integer, required: The unique identifier for this calendar designation.
    - `is_deleted` boolean, required: Whether this record is soft deleted or not.
    - `is_recurring` boolean, required: Whether this record follows a recurrence pattern.
    - `modified` string, date-time, required: The datetime this object was last modified; changes to related entities will not update this field.
    - `name` string, required: Display name for this designation.
    - `recurrence` RecurrenceBreakdownSchema: Structured representation of an RFC 2445 recurrence rule.
      - `days_of_week` string[]: Two-letter day codes. Applicable for WEEKLY and some MONTHLY patterns.
      - `end_after_occurrences` integer, nullable: Total number of occurrences before the recurrence ends, if bounded by count.
      - `end_date` string, date, nullable: ISO 8601 date (YYYY-MM-DD) when the recurrence ends, if bounded by date.
      - `frequency` 'YEARLY' | 'MONTHLY' | 'WEEKLY' | 'DAILY' | 'HOURLY' | 'MINUTELY' | 'SECONDLY', required: The base recurring frequency.
      - `interval` integer, required: The interval between each frequency iteration (e.g., 2 means every 2 weeks for WEEKLY).
    - `recurrence_excluded_datetimes` string[]: Specific datetimes excluded from the recurrence pattern.
    - `recurring_designation_id` integer, nullable: If this is an exception to a recurring designation, the ID of the parent.
    - `rrule` string, nullable: Raw RFC 2445 RRule string, if recurring.
    - `start_datetime` string, date-time, required: ISO 8601 formatted start datetime of the designation in UTC.
  - `has_more` boolean: Whether there are more pages or data in this list.
  - `next_page` string, required: A URL linking to the next page of this list.
  - `type` string: Type of this object. Always `list`.

---

[API](https://skmtc.dev/vetcove/apis/ninjaapi.md) - [All operations](https://skmtc.dev/vetcove/apis/ninjaapi/llms.txt) - [OpenAPI document](https://skmtc.dev/vetcove/apis/ninjaapi/revisions/4ceaed956e15?raw)