Get appointment details (public)

Retrieve an appointment by its appointment number. No authentication is required, and what
comes back depends on who is reading.

  • The appointment's own vendor (its organisation API key, or a partner key acting on it
    with X-Vendor-Code) and its staff get the full record: ids, unmasked client contact
    details, booking notes, staff emails, metadata, additional staff, form responses, attachments, the skin
    analysis and, for staff, the doctor's join URL.
  • Anyone else, including an unauthenticated caller, gets the booking-confirmation view:
    time, status, appointment type, location, payment summary, services, the patient join URL
    for a virtual appointment, staff name and avatar, and the client's name, email and phone
    masked (Ada O., a**@example.com, +*********5678). Booking notes are left out.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Appointment number (e.g., APT-2025-00001)

Query Params
string

Comma-separated list of relationships to include (currently supports: treatmentPlanProcedures)

Responses

404

Appointment not found

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