List All Appointments

Declined appointments are not returned by this endpoint.
Recurring appointments are stored once and expanded into one appointment object per occurrence
that falls within start_date/end_date. Occurrences that haven't been individually modified
share the base appointment's id; once an occurrence's status is changed (for example, checking
a patient in), it's returned as its own appointment with a new id and a recurring_appointment_id
pointing back to the original recurring appointment. See Recurring Appointments
for details, including what happens when a series is edited after an occurrence has already split off.

Query Params
string

Start of the query window (inclusive). Must be a valid ISO 8601 date string.

string

End of the query window (inclusive). Must be a valid ISO 8601 date string. Range may not exceed 31 days.

string

Filter by patient attendee. A patient id, such as pat- (or sbx-pat- in sandbox).

status
array of strings

Allows filtering appointments by status.

status
Allowed:
int32

Defaults to 10, maximum 100.

int32

Defaults to 0.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json