v2
latestOpenAPI 3.0.02026-07-2632977728.5 KBClinical
Retrieve and search schedule blocks
Retrieve or search schedule blocks. Schedule blocks are used to block off time on a provider's calendar to prevent appointments from being scheduled. Use this to retrieve existing blocks for lunch breaks, meetings, PTO, or other non-appointment activities. Either date or date_range parameter is recommended for efficient querying.
get/api/schedule_blocks
Query parameters
cursorstring
The pagination cursor value.
page_sizeinteger
Number of results to return per page.
doctorinteger
ID of the provider or doctor
Filter by doctor/provider ID
officeinteger
ID of the office
Filter by office ID
datestring
Specific date to filter schedule blocks
Filter by specific date (YYYY-MM-DD format)
date_rangestring
Inclusive date range to filter schedule blocks
Filter by date range (YYYY-MM-DD/YYYY-MM-DD format)
Response
OK
Example response
{
"data": [
{
"description": "Lunch Break",
"office": 200,
"color": "#FF5733",
"practice_group": 1,
"start_time": "2024-03-15T12:00:00",
"exam_room": 1,
"series": null,
"end_time": "2024-03-15T13:00:00",
"provider": 100,
"id": 12345,
"appointment_break": null
}
]
}