HIhint
Appointment

List All Appointments

Changed on

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.

get/provider/appointments

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/appointments
  • Auth
    API key in header AUTHORIZATION

Query parameters

start_datestring

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

end_datestring

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

patientstring

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

statusstring[]

Allows filtering appointments by status.

limitinteger

Defaults to 10, maximum 100.

offsetinteger

Defaults to 0.

Response

Successful response

idstring
startstring
endstring
status'unconfirmed' | 'confirmed' | 'cancelled'
workflow_status'check_in' | 'waiting_for_provider' | 'in_progress' | 'completed' | 'checked_out' | 'no_show'
titlestring
descriptionstring
created_atstring
updated_atstring
appointment_type_idstring
recurring_appointment_idstring

Changes