v1
latestOpenAPI 3.1.0Private2026-07-24196240439.2 KBList 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 parameters
Start of the query window (inclusive). Must be a valid ISO 8601 date string.
End of the query window (inclusive). Must be a valid ISO 8601 date string. Range may not exceed 31 days.
Filter by patient attendee. A patient id, such as pat- (or sbx-pat- in sandbox).
Allows filtering appointments by status.
Defaults to 10, maximum 100.
Defaults to 0.
Response
Successful response