Skip to main content

Get booking details by ID

GET 
/v1/partner/bookings/:booking_id

Fetches comprehensive details for a specific booking using its unique ID. Provides all relevant information about an individual booking.

Token scope:

{'scope': 'read:bookings'}

Request​

Path Parameters

    booking_id Booking Idrequired

    The unique identifier of the booking to retrieve.

Responses​

Successfull operation, Returns an array of booking details.

Schema

    address_city Address City (string)
    address_state Address State (string)
    address_street Address Street (string)
    address_street_secondary Address Street Secondary (string)
    address_zip Address Zip (string)
    appointment_date Appointment Date (string)required
    birth_date Birth Date (string)required
    birth_sex Birth Sex (string)
    custom_booking_management_url Custom Booking Management Url (string)
    email Email (string)required
    emr_booking_id Emr Booking Id (string)
    emr_department_id Emr Department Id (integer)
    emr_patient_id Emr Patient Id (integer)
    emr_practice_id Emr Practice Id (integer)required
    emr_provider_id Emr Provider Id (integer)required
    first_name First Name (string)required
    gender Gender (string)
    id Id (integer)required
    is_walk_in Is Walk In (boolean)required
    last_name Last Name (string)required
    location_id Location Id (integer)required
    notes Notes (string)
    paperwork_status Paperwork Status (string)required
    phone Phone (string)required
    reason Reason (string)required
    status Status (string)required
Loading...