v1
latestOpenAPI 3.1.02026-07-2649128242.2 KBAppointment
Find available appointments
The $find operation generates a list of available appointments from the Slot Resources. It will use the Online booking preferences to ensure that the available times adhere to buffer time, lead time and advance booking limit.
get/main/Appointment/$find
Query parameters
startstring datetime required
Appointment start
endstring datetime required
Appointment end
practitioner-rolestring
Appointment practitioner-role
practitionerstring
Appointment practitioner
organizationstring
Appointment organization
durationstring required
Appointment duration
show'first-available'
Appointment show
emergencyboolean
Ignores lead time to show all available times for emergency appointments
apply-buffer-timeboolean
Applies buffer time to show all available times
_sort'start' | '-start'
Each item in the comma-separated list is a search parameter, optionally with a ' - ' prefix. The prefix indicates decreasing order; in its absence, the parameter is applied in increasing order.
Response
Appointment resource