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

# List calendar event blocks

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

## Request

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

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

A **calendar event block** represents a non-appointment event on the calendar (e.g., a staff meeting, lunch break, or clinic closure) that may block appointment scheduling.

## Query parameters

- `calendar_id` integer, required: Required. The ID of the calendar to fetch event blocks for
- `start_date` string, required: Required. Start date for fetching event 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 event 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 event blocks for

## Response `200`

OK

- ExternalCalendarEventBlockSchemaList
  - `data` ExternalCalendarEventBlockSchema[], required: A single page of data contained within this list.
    - `calendar_resource_ids` integer[], required: The ID's of the calendar resources for this event block. `is_applicable_to_all_resources` takes precedence over this field.
    - `description` string, nullable, required: The description of this event block.
    - `end_datetime` string, date-time, required: The end datetime for this event block, in UTC.
    - `is_applicable_to_all_resources` boolean, required: Whether this event block is applicable to all calendar resources.
    - `kind_id` integer, required: The ID of the calendar event kind for this event block.
    - `should_block_appointments` boolean, nullable, required: Whether appointments can be scheduled over this event block.
    - `start_datetime` string, date-time, required: The start datetime for this event block, 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)