Skip to main content

Find available slots

GET 
/v1/partner/locations/:location_id/slots
deprecated

Retrieves available appointment slots for a specified location. By default, it returns slots for today and the next six days. The number of days can be customized using the number_of_days_worth parameter. The response includes an array of objects representing the location and its available slots. Walk-in slots can be included or excluded based on the return_walkin_slots parameter.We recommend using the newer slots endpoint: /v2/partner/locations/{location_id}/slots

Token scope:

{'scope': 'read:locations'}

Request​

Path Parameters

    location_id Location Idrequired

    Required. The unique identifier of the location

Query Parameters

    number_of_days_worth Number Of Days Worth

    Default value: 7

    return_walkin_slots Return Walkin Slots

    Optional. Whether to include walk-in slots in the response. Default behavior may vary based on implementation

    with_booking_buffer With Booking Buffer
    visit_type_id Visit Type Id

Responses​

Successful Response

Schema

  • Array [

    • location_id Location Id (integer)required

    The unique identifier of the location

    slots

    object[]

    required

    A list of available appointment slots.

  • Array [

    • appointment_date date-timerequired

    The date and time of the appointment in ISO8601 format.

    availability Availability (integer)required
    busy Busy (boolean)
    location_ids string[]

  • ]

  • ]

Loading...