Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zocdoc provider-locations API

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

Zocdoc provider-locations API is one of 10 APIs that Zocdoc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include provider-locations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a changelog.

This API exposes 5 operations across 4 paths, and defines 35 schemas. It is described by OpenAPI 3.0.0, at version 1.176.

Requests are made against 2 base URLs: https://api-developer-sandbox.zocdoc.com, https://api-developer.zocdoc.com.

5 operations 4 paths 35 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.176
Base URL
https://api-developer.zocdoc.com
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Zocdoc provider-locations API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (ClientCredentialsFlow) using the clientCredentials flow, exposing 6 scopes. It supports OAuth 2.0 (AuthorizationCodeFlow) using the authorizationCode flow, exposing 3 scopes.

  • ClientCredentialsFlow — Machine to machine authentication (for use from client server to Zocdoc). Production: https://auth.zocdoc.com/oauth/token Sandbox: https://auth-api-developer-s…
  • AuthorizationCodeFlow — Log in as a user. Client Secret is not necessary for this login flow. Production: https://auth.zocdoc.com Sandbox: https://auth-api-developer-sandbox.zocdoc.com

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

provider-locations 5

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

GET
/v1/provider_locations
Get provider locations
getProviderLocations 8 params → 200400401403
GET
/v1/provider_locations/{provider_location_id}
Get provider location by id
getProviderLocation 2 params → 200400401403404
GET
/v1/provider_locations/availability
Get availability for provider locations
getProviderLocationsAvailability 8 params → 200400401403404
GET
/v1/provider_locations/{provider_location_id}/insurance_mappings
Get insurance mappings for provider location
getProviderLocationInsuranceMappings 1 param → 200400401403404409500
POST
/v1/provider_locations/{provider_location_id}/insurance_mappings
Submit request to update mapped insurance plans
updateProviderLocationInsuranceMappings 1 param body → 202400401403404409500

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are BaseProvider (16 properties), BaseLocation (11 properties), ProviderLocation (9 properties), InsuranceCarrierNetwork (3 properties). Each schema is shown below with its type and property counts.

BaseResult
object
1 property 1 required
SearchParameters
object
2 properties 2 required
UpdateInsuranceMappingsRequest
object
2 properties 2 required
EligibleInsurance
object
2 properties 2 required
GetInsuranceMappingsResults
BaseProvider
object
16 properties
ProviderCredentials
object
Provider Credentials include education and certifications.
2 properties 2 required
Error
object
2 properties 1 required
ProviderListResult
Availability
object
3 properties
Timeslot
object
3 properties 1 required
VisitType
string
The type of patient visit with the provider.
Practice
object
2 properties 2 required
BaseLocation
object
11 properties 6 required
BookingRequestInsuranceSource
string
The types of insurance coverage that a provider accepts
ErrorResult
InsuranceMappingUpdateOperation
string
PaginatedBaseResult
ProviderLocationResult
InsuranceMappingData
object
2 properties 2 required
PublishedContext
string
AvailabilityResult
ProviderLocation
object
9 properties 5 required
InsurancePlanMapping
object
1 property 1 required
BaseLocationWithDistance
ErrorType
string
Education
object
1 property
AcceptsPatientInsuranceType
string
Whether the provider location accepts the patient's insurance
ProviderLocationType
string
ProviderSearchResult
object
2 properties 2 required
BookingRequirements
object
Criteria for booking appointments, defines requirements and mandatory fields specified by Zocdoc providers
2 properties 2 required
BaseVirtualLocation
object
3 properties 1 required
PatientType
string
Whether or not the patient has been to the provider's practice.
UpdateInsuranceMappingsResult
InsuranceCarrierNetwork
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zocdoc-provider-locations-api-openapi.yml Raw ↑

Other APIs Zocdoc publishes across the network.

Zocdoc appointments API
Zocdoc calendar-integration-timeslots API
Zocdoc credentials API
Zocdoc facilities API
Zocdoc insurance-reference API
Zocdoc providers API
Zocdoc reference API
Zocdoc schedulable-entities API
Zocdoc webhook API