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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Required. The ID of the calendar to fetch event blocks for
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
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
Optional. The ID of the calendar resource to fetch event blocks for
Response
OK
A single page of data contained within this list.
A URL linking to the next page of this list.
Whether there are more pages or data in this list.
Type of this object. Always list.