Provider locations

Endpoints for retrieving and modifying provider location objects and their related insurance plans and availability.

Operations

Get provider locations

Request

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.

Security

ClientCredentialsFlow or AuthorizationCodeFlow

Query

zip_codestring

A 5 digit zip code.

Example:zip_code=36925

latitudenumber, (float), [ -90 .. 90 ]

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), [ -180 .. 180 ]

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

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.

Example:specialty_id=sp_153

visit_reason_idstring

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.

Example:visit_reason_id=pc_FRO-18leckytNKtruw5dLR

pageinteger

The zero indexed page of results.

page_sizeinteger

The number of results to return per page.

insurance_plan_idstring

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

Example:insurance_plan_id=ip_31820

visit_typestring(VisitType)

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

Enum:"all""in_person""video_visit"

Example:visit_type=all

max_distance_to_patient_miinteger, [ 1 .. 50 ]

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.

curl -i -X GET \
  'https://api-developer-sandbox.zocdoc.com/v1/provider_locations?zip_code=36925&latitude=-90&longitude=-180&specialty_id=sp_153&visit_reason_id=pc_FRO-18leckytNKtruw5dLR&page=0&page_size=0&insurance_plan_id=ip_31820&visit_type=all&max_distance_to_patient_mi=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Succesful

Bodyapplication/json

request_idstringrequired

Unique request identifier for tracing

pageintegerrequired

The zero based index of the current page.

page_sizeintegerrequired

The size of the current page.

total_countintegerrequired

The total number of result items.

next_urlstringrequired

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

dataobject(ProviderSearchResult)required

Response

{
  "request_id": "string",
  "page": 0,
  "page_size": 0,
  "total_count": 0,
  "next_url": "string",
  "data": {
    "search_parameters": { … },
    "provider_locations": [ … ]
  }
}