Skip to main content

Get booking details by location

GET 
/v2/partner/bookings

Retrieves bookings associated with a specified location_id and query parameters. Returns an array of booking objects in chronological order by appointment_date, or by created_date if that parameter is supplied.

Token scope:

{'scope': 'read:bookings'}

Request​

Query Parameters

    location_id Location Idrequired

    Required. The unique indentifier of the location.

    status Status

    Optional. Filter by a single status or multiple statuses separated by commas.

    appointment_date Appointment Date

    Optional. Filter by a single datetime or a range (format: start_datetime_to_end_datetime, ISO format). Cannot be used with created_date.

    created_date Created Date

    Optional. Filter by a single datetime or a range (format: start_datetime_to_end_datetime, ISO format). Cannot be used with appointment_date.

    limit Limit

    Default value: 20

    Optional. Number of bookings to return in the request

    page Page

    Default value: 1

    Optional. Page offset of bookings to return in the request (1-indexed)

Responses​

Successfull operation, Returns an array of booking objects.

Schema

  • Array [

    • 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 (string)
    emr_patient_id Emr Patient Id (string)
    emr_practice_id Emr Practice Id (string)
    emr_provider_id Emr Provider Id (string)
    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...