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

# List calendar designation blocks

`GET /ext/v2/calendar-designation-blocks/`

## Request

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

Returns the designation blocks for a clinic's calendar within a date range. The blocks are sorted by datetime in ascending order.

A **calendar designation block** represents a time window on a resource's schedule that is designated for specific appointment kinds only (e.g., a block reserved exclusively for surgeries).

## Query parameters

- `calendar_id` integer, required: Required. The ID of the calendar to fetch designation blocks for
- `start_date` string, required: Required. Start date for fetching designation blocks. This will be translated to a datetime representing the start of the day in the clinic's timezone. Must be no more than 30 days before `end_date`. Format: YYYY-MM-DD
- `end_date` string, required: Required. End date for fetching designation blocks. This will be translated to a datetime representing the end of the day in the clinic's timezone. Must be no more than 30 days after `start_date`. Format: YYYY-MM-DD
- `calendar_resource_id` integer, nullable: Optional. The ID of the calendar resource to fetch designation blocks for

## Response `200`

OK

- ExternalCalendarDesignationBlockSchemaList
  - `data` ExternalCalendarDesignationBlockSchema[], required: A single page of data contained within this list.
    - `appointment_kind_ids` integer[]: The ID's of the appointment kinds allowed for this designation block
    - `calendar_resource_id` integer, required: The ID of the calendar resource this designation belongs to.
    - `end_datetime` string, date-time, required: The ending datetime of this instance of the designation, in UTC.
    - `name` string, nullable, required: The name of this designation.
    - `start_datetime` string, date-time, required: The starting datetime of this instance 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)