facilities

Get facilities

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

get/v1-beta/facilities

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

npisstring
Example:1234567891,0123456789

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.

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.

building_type'clinic' | 'hospital'

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

The type of facility building, which can be Clinic or Hospital.

pageinteger

The zero indexed page of results.

page_sizeinteger

The number of results to return per page.

visit_reason_idstring
Example:pc_FRO-18leckytNKtruw5dLR

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

insurance_plan_idstring
Example:ip_31820

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

max_distance_to_patient_miinteger

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

Response

Successful

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": [
    {
      "location": {
        "state": "NY",
        "phone_number": "9999999999",
        "phone_extension": "123",
        "time_zone": "America/New_York"
      }
    }
  ]
}

Changes

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