Skip to main content
GET
List resource schedule blocks

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

calendar_id
integer
required

Required. The ID of the calendar to fetch resource schedule blocks for

start_datetime__gte
string
required

Required. Start date for fetching resource schedule 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_datetime__lte. Format: YYYY-MM-DD

end_datetime__lte
string
required

Required. End date for fetching resource schedule 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_datetime__gte. Format: YYYY-MM-DD

calendar_resource_id
integer | null

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

Response

200 - application/json

OK

data
ExternalResourceScheduleBlockSchema · object[]
required

A single page of data contained within this list.

next_page
string
required

A URL linking to the next page of this list.

has_more
boolean
default:false

Whether there are more pages or data in this list.

type
string
default:list

Type of this object. Always list.