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 reference API

Endpoints to retrieve information about the developer's directory.

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

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

This API exposes 5 operations across 5 paths, and defines 14 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 5 paths 14 schemas 5 GET

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 reference 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 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

reference 5

Endpoints to retrieve information about the developer's directory.

GET
/v1/reference/npi
Get active provider NPIs
getProviderNpis 2 params → 200400401403
GET
/v1/specialties
Get specialties
getSpecialties 3 params → 200400401403404
GET
/v1/specialties/{specialty_id}
Get specialty by id
getSpecialtyById 1 param → 200400401403404
GET
/v1/visit_reasons
Get visit reasons
getVisitReasons 3 params → 200400401403404
GET
/v1/visit_reasons/{visit_reason_id}
Get visit reason by id
getVisitReasonById 1 param → 200400401403404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are SpecialtyData (5 properties), VisitReasonData (3 properties), Error (2 properties), ProviderNpis (1 property). Each schema is shown below with its type and property counts.

ErrorType
string
BaseResult
object
1 property 1 required
PaginatedBaseResult
ProviderNpiResponse
ProviderNpis
object
1 property
VisitReasonByIdResponse
object
SpecialtiesResponse
object
VisitReasonData
object
3 properties 3 required
VisitReasonsResponse
object
Error
object
2 properties 1 required
SpecialtyByIdResponse
object
SpecialtyData
object
5 properties 5 required
CareCategory
string
The category of care for an insurance plan Health: Health and Mental Health Care Dental: Dental Care Vision: Vision Care
ErrorResult

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zocdoc-reference-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 provider-locations API
Zocdoc providers API
Zocdoc schedulable-entities API
Zocdoc webhook API