Retrieve an appointment
Path Parameters
The appointment ID
Response
AppointmentResource
The appointment's unique identifier.
"app_01HQFQ9QWTNNPY58FZ8CB3FWWK"
The location identifier where the appointment takes place.
"loc_01HQFQ9QWTNNPY58FZ8CB3FWWK"
The practitioner identifier who provides the service.
"pra_01HQFQ9QWTNNPY58FZ8CB3FWWK"
The service identifier being provided.
"ser_01HQFQ9QWTNNPY58FZ8CB3FWWK"
The snapshotted base price from the service at time of booking.
12000
The calculated total price (service_price × client count if price_per_client).
24000
The snapshotted price unit from the service at time of booking.
hourly, fixed "hourly"
Whether the price is per client (true) or per appointment (false).
false
Whether billable travel time applies to this appointment.
true
The snapshotted travel line item name.
"Travel"
The snapshotted flat travel price in cents.
5000
The billable travel time before the appointment in minutes.
15
The billable travel time after the appointment in minutes.
15
The travel destination address (single-line, free text).
"123 Sample Street, Sydney NSW 2000, Australia"
The travel expense line items (when loaded).
The transport line items (when loaded).
The appointment clients (when loaded).
The appointment start time (ISO 8601).
"2024-01-01T10:00:00Z"
The appointment end time (ISO 8601).
"2024-01-01T11:00:00Z"
The appointment duration in minutes.
60
The appointment status.
pending, arrived, missed, cancelled "pending"
The room identifier where the appointment takes place.
"rom_01HQFQ9QWTNNPY58FZ8CB3FWWK"
The vehicle identifier if transportation is involved.
"veh_01HQFQ9QWTNNPY58FZ8CB3FWWK"
The IDs of resources required for this appointment.
The appointment note.
"Client requested morning appointment."
The cancellation reason identifier if cancelled.
"cnr_01HQFQ9QWTNNPY58FZ8CB3FWWK"
The cancellation note if cancelled.
"Client had to travel unexpectedly."
When the appointment was cancelled (ISO 8601).
"2024-01-01T08:00:00Z"
When the appointment was archived (ISO 8601).
"2024-01-01T08:00:00Z"
The timestamp when the appointment was created (ISO 8601).
"2024-01-01T12:00:00Z"