Skip to content

API Documentation (1.22)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Sandbox

https://api-developer-sandbox.zocdoc.com/

Production

https://api-developer.zocdoc.com/

NPIs

Endpoints to retrieve information about the developer's directory.

Operations

Schedulable entities

Endpoints to retrieve schedulable entities with availability information.

Operations

Insurance

Endpoints to retrieve insurance plans supported by Zocdoc.

Operations

Providers

Endpoints to retrieve providers within the developer's directory.

Operations

Provider locations

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

Operations

Facilities

Endpoints to retrieve facilities within the developer's directory.

Operations

Get facilities

Request

Get a set of facilities within the developer's network.

Security
ClientCredentialsFlow or AuthorizationCodeFlow
Query
npisstring

A comma-delimited list of Provider NPI numbers. A maximum of 50 items will be accepted at a time. One of zip_code or npis is required.

Example: npis=1234567891,0123456789
zip_codestring

A 5 digit zip code that will be used as the location to find facilities near by. One of zip_code or npis is required.

Example: zip_code=36925
building_typestring(BuildingType)

The type of facility building, which can be clinic or hospital.

Enum"clinic""hospital"
pageinteger[ 0 .. 10 ]

The zero indexed page of results.

Default 0
page_sizeinteger[ 1 .. 50 ]

The number of results to return per page.

Default 10
visit_reason_idstring

The Zocdoc ID of the visit reason to search by zip_code for. See Reference Data for options.

Example: visit_reason_id=pc_FRO-18leckytNKtruw5dLR
insurance_plan_idstring

The Zocdoc ID of the patient's insurance plan to search by zip_code for. See Reference Data for options.

Example: insurance_plan_id=ip_2224
max_distance_to_patient_miinteger[ 1 .. 50 ]

The maximum distance in miles from the facility to the search location (the center point of the given zip_code). Default is 50 miles.

Default 50
curl -i -X GET \
  'https://api-developer-sandbox.zocdoc.com/v1-beta/facilities?npis=1234567891%2C0123456789&zip_code=36925&building_type=clinic&page=0&page_size=10&visit_reason_id=pc_FRO-18leckytNKtruw5dLR&insurance_plan_id=ip_2224&max_distance_to_patient_mi=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful

Bodyapplication/json
request_idstringrequired
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.

dataArray of objects(Facility)required
data[].​facility_idstringrequired

Zocdoc id for facility

data[].​namestringrequired
data[].​npistring
data[].​building_typestring
data[].​specialtiesArray of stringsrequired
data[].​languagesArray of stringsrequired
data[].​visit_reason_idsArray of stringsrequired
data[].​default_visit_reason_idstringrequired
data[].​locationobject(BaseLocation)required
data[].​location.​address1stringrequired
data[].​location.​address2string
data[].​location.​citystringrequired
data[].​location.​statestringrequired

The location's two letter state code.

Example: "NY"
data[].​location.​zip_codestringrequired

The location's 5 digit zip code.

data[].​location.​latitudenumber(float)required
data[].​location.​longitudenumber(float)required
data[].​location.​location_namestring
data[].​scheduleobject(FacilitySchedule)required
data[].​schedule.​schedule_idstringrequired

Zocdoc id for bookable schedule

data[].​schedule.​provider_location_idstringrequired

Zocdoc provider location id for availability and booking requests

data[].​schedule.​booking_requirementsobject(BookingRequirements)required

Criteria for booking appointments, defines requirements and mandatory fields specified by Zocdoc providers

data[].​schedule.​booking_requirements.​required_fieldsArray of stringsrequired
data[].​schedule.​booking_requirements.​accepts_booking_requests_fromArray of strings(BookingRequestInsuranceSource)required
Items Enum"in_network""out_of_network""self_pay"
data[].​practiceobject(Practice)
Response
application/json
{
  "request_id": "string",
  "page": 0,
  "page_size": 0,
  "total_count": 0,
  "next_url": "string",
  "data": [
    { … }
  ]
}

Get facility by id

Request

Get facility by facility id.

Security
ClientCredentialsFlow or AuthorizationCodeFlow
Path
facility_idstringrequired

Zocdoc facility id.

Example: d04b049a-41b1-4aba-9268-d8973cf72cdd
curl -i -X GET \
  https://api-developer-sandbox.zocdoc.com/v1-beta/facilities/d04b049a-41b1-4aba-9268-d8973cf72cdd \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful

Bodyapplication/json
request_idstringrequired
dataobject(Facility)
Response
application/json
{
  "request_id": "string",
  "data": {
    "facility_id": "string",
    "name": "string",
    "npi": "string",
    "building_type": "string",
    "specialties": [ … ],
    "languages": [ … ],
    "visit_reason_ids": [ … ],
    "default_visit_reason_id": "string",
    "location": { … },
    "schedule": { … },
    "practice": { … }
  }
}

Calendar integration timeslots

Endpoints to manage timeslots for providers.

Operations

Appointments

Endpoints for booking, cancelling, and rescheduling appointments, including retrieving current appointment statuses and updated information.

Operations

Webhook

Sandbox endpoints to mock webhook behavior

Operations
Copyright © Zocdoc Inc. All rights reserved.