latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

appointments

List appointments

get/appointments

Query parameters

patientstring
providerstring
facilitystring
typestring
datestring date-time
durationinteger
source'integrator' | 'reminder' | 'ui' | 'waitlist' | 'reschedule' | 'telehealth'
status'unconfirmed' | 'confirmed' | 'cancelled'
userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

pageinteger
limitinteger

How many items to fetch per page

_populatestring

Response properties which will be replaced by the referenced objects, separated by commas.

_selectstring

Response properties that should be returned, separated by commas.

Response

List of appointments

pageinteger required
sizeinteger required