ZOzocdoc
provider-locations

Get availability for provider locations

Retrieves availability for a set of provider locations. Required parameters passed include provider location ids, visit reason id and patient type. Visit reason and patient type (new or existing) are used to calculate the duration of the appointment and break availability into bookable timeslots based on the appointment duration. The response output includes the start times of appointments based on these calculations.

The start_time returned is used in the endpoint /v1/appointments to book appointments. If no timeslots are available that satisfy the parameters, an empty array will be returned for that Provider Location's timeslots.

get/v1/provider_locations/availability

Request

  • Base URL
    https://api-developer-sandbox.zocdoc.com
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.zocdoc.com/oauth/token
    • or OAuth 2
      Authorization code: https://auth.zocdoc.com/authorize
      Token URL: https://auth.zocdoc.com/oauth/token

Query parameters

provider_location_idsstring required
Example:pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890,pr_ghi123-jkl456_mnop7890|lo_ghi123-jkl456_mnop7890

A comma-delimited list of Zocdoc provider_location_ids retrieved from the /v1/providers or /v1/provider_locations endpoint. A maximum of 50 items will be accepted at a time.

visit_reason_idstring required
Example:pc_FRO-18leckytNKtruw5dLR

The Zocdoc ID of the visit reason. See Reference Data for options.

patient_type'existing' | 'new' required

Whether or not the patient has been to the provider's practice.

Example:new

New or existing to indicate if the patient is new to the practice or has been to the office before.

start_date_in_provider_local_timestring date

The first date to retrieve availability for, as YYYY-MM-DD. Defaults to current date in US Eastern Time. 150 days into the future is the guaranteed maximum. Dates past 150 days may be accepted but are not supported.

end_date_in_provider_local_timestring date

The last inclusive date to retrieve availability for, as YYYY-MM-DD. Defaults to 7 days after the current date. Must be 30 days or less after the start date. Both dates are included, so the maximum span is 31 days.

published_context'direct_listing' | 'condition_driven_search'

Determines how availability slots are returned. Direct_listing returns all slots, while condition_driven_search limits results to Zocdoc-active providers with budget. Applicable to syndication clients.

insurance_plan_idstring

The Zocdoc ID of the patient's insurance plan. Use the Get Insurance Plans endpoint to retrieve available plans. Used to construct booking_url.

insurance_carrier_idstring

The Zocdoc ID of the patient's insurance carrier. See Reference Data for options. Used to construct booking_url.

Response

Successful

request_idstring required

Unique request identifier for tracing

Example response

{
  "data": [
    {
      "provider_location_id": "pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890",
      "first_availability": {
        "start_time": "2022-04-27T09:00:00-04:00",
        "visit_reason_id": "pc_FRO-18leckytNKtruw5dLR",
        "booking_url": "https://www.zocdoc.com/booking/start?startTime=638874819000000000&locationId=274383&procedureId=75&professionalId=405844"
      },
      "timeslots": [
        {
          "start_time": "2022-04-27T09:00:00-04:00",
          "visit_reason_id": "pc_FRO-18leckytNKtruw5dLR",
          "booking_url": "https://www.zocdoc.com/booking/start?startTime=638874819000000000&locationId=274383&procedureId=75&professionalId=405844"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.