Sign in

v1

latestOpenAPI 3.1.02026-07-26364986.4 KB
Appointments

Get an Appointment

Retrieve detailed appointment information using its unique identifier

get/api/2026-01-01/appointments/{appointment_id}

Path parameters

appointment_idstring uuid required

The ID of the appointment

Response

The appointment

idstring uuid required
start_atstring date-time
end_atstring date-time
staff_member_idstring uuid
patient_idstring uuid
location_idstring uuid
treatment_idstring uuid
first_visitboolean
cancelled_atstring date-time nullable
cancelled_reasonstring nullable

The reason the appointment was cancelled. Free-text reasons entered by staff are mapped to 'Other' to prevent exposure of potentially sensitive information; only predefined reasons are returned as-is.

booked_atstring date-time
no_show_atstring date-time nullable
arrived_atstring date-time nullable
archived_atstring date-time nullable
checked_in_atstring date-time nullable
state'reserved' | 'booked' | 'arrived' | 'no_show' | 'cancelled' | 'archived'

The current state of the appointment.