ZOzocdoc
provider-locations

Get provider locations

This endpoint accepts parameters such as zip code, specialty, visit reason and accepted insurance to return a filtered set of providers within the developer's directory. The response includes additional information about the provider location objects returned.

The provider_location_id returned in the response can be used to retrieve availability in the endpoint /v1/provider_locations/availability.

get/v1/provider_locations

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

zip_codestring

A 5 digit zip code to search near. One of zip_code or the latitude and longitude pair is required. zip_code takes precedence if both are supplied.

latitudenumber float

Latitude of the search location, in decimal degrees. Must be provided together with longitude. Used only when zip_code is not supplied; zip_code takes precedence over the pair.

longitudenumber float

Longitude of the search location, in decimal degrees. Must be provided together with latitude. Used only when zip_code is not supplied; zip_code takes precedence over the pair.

specialty_idstring
Example:sp_153

The Zocdoc ID of the provider's specialty. See Reference Data for options. One of specialty_id or visit_reason_id is required. If visit_reason_id is not supplied, the default visit reason for the specialty will be used.

visit_reason_idstring
Example:pc_FRO-18leckytNKtruw5dLR

The Zocdoc ID for the visit reason. See Reference Data for options. One of specialty_id or visit_reason_id is required. If both visit_reason_id and specialty_id are supplied, the specialty must be the visit reason's corresponding specialty.

pageinteger

The zero indexed page of results.

page_sizeinteger

The number of results to return per page.

insurance_plan_idstring
Example:ip_31820

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

visit_type'all' | 'in_person' | 'video_visit'

The type of patient visit with the provider.

Example:all

The type of patient visit with the provider. If not provided, the default value is set to in_person.

max_distance_to_patient_miinteger

The maximum distance in miles from the physical location to the search location (the center point of the given zip_code). Defaults to 50 miles, which is also the widest radius available.

Response

Succesful

request_idstring required

Unique request identifier for tracing

pageinteger required

The zero based index of the current page.

page_sizeinteger required

The size of the current page.

total_countinteger required

The total number of result items.

next_urlstring required

A link to the next page of results; null if this is the last page of results.

Example response

{
  "data": {
    "search_parameters": {
      "specialty_id": "sp_153",
      "visit_reason_id": "pc_FRO-18leckytNKtruw5dLR"
    },
    "provider_locations": [
      {
        "provider_location_id": "pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890",
        "provider": {
          "provider_photo_url": "//d2uur722ua7fvv.cloudfront.net/ZeeFace_02.svg",
          "languages": [
            "English",
            "Spanish"
          ],
          "profile_url": "https://zocdoc.com/doctor/capivarudo-nojeira-md-517507?utm_source=FakeSource"
        },
        "location": {
          "state": "NY",
          "phone_number": "9999999999",
          "phone_extension": "123",
          "time_zone": "America/New_York"
        },
        "virtual_location": {
          "state": "NY",
          "time_zone": "America/New_York"
        }
      }
    ]
  }
}

Changes

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