Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Clinical

Retrieve or search appointment or breaks. <b>Note:</b> Either since, occurred_since, date or date_range parameter must be specified. results returned in order of scheduled date.

get/api/appointments

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page.

statusstring

Appointment status name

patientinteger

Patient ID

officeinteger

Office ID

doctorinteger

Doctor ID

sincestring

Lower bound inclusive date filter for appointment updated/created date

occurred_sincestring

Filter appointments based on scheduled time

Filter appointments based on scheduled time

date_rangestring

Inclusive upper and lower bound filter for appointment scheduled date. Format: yyyy-mm-dd/yyyy-mm-dd. Max window size 190 days

verboseboolean

set to true to include clinical_note, custom_fields, custom_vitals, extended_updated_at, reminders, status_transitions, vitals but limit page_size to 25

datestring

Specific date filter for appointment scheduled date

ignore_virtualboolean

Do not include virtual appointments that have not yet been materialized. This is useful when you need to get a list of appointments that are materialized and ready to be used.

set to true to ignore virtual appointments that have not yet been materialized

show_archivedboolean

Include archived or deleted appointments in the response

set to true or 1 to include deleted or archived appointments

Response

OK

OR