VEvetcove
Scheduler

List calendar event blocks

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.

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

Query parameters

calendar_idinteger required

Required. The ID of the calendar to fetch event blocks for

start_datestring 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_datestring 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_idinteger nullable

Optional. The ID of the calendar resource to fetch event blocks for

Response

OK

has_moreboolean

Whether there are more pages or data in this list.

next_pagestring required

A URL linking to the next page of this list.

typestring

Type of this object. Always list.

Changes

No recorded changes to this operation across all 1 revision of this API.