# Get provider locations

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  returned in the response can be used to retrieve availability in the endpoint /v1/provider_locations/availability.


Endpoint: GET /v1/provider_locations
Version: 1.22
Security: ClientCredentialsFlow, AuthorizationCodeFlow

## Query parameters:

  - `zip_code` (string, required)
    A 5 digit zip code.
    Example: 36925

  - `specialty_id` (string)
    The Zocdoc ID of the provider's specialty. See Reference Data for options. One of  or  is required. If  is not supplied, the default visit reason for the specialty will be used.
    Example: "sp_153"

  - `visit_reason_id` (string)
    The Zocdoc ID for the visit reason. See Reference Data for options. One of  or  is required. If both  and  are supplied, the specialty must be the visit reason's corresponding specialty.
    Example: "pc_FRO-18leckytNKtruw5dLR"

  - `page` (integer)
    The zero indexed page of results.

  - `page_size` (integer)
    The number of results to return per page.

  - `insurance_plan_id` (string)
    The Zocdoc ID of the patient's insurance plan. See Reference Data for options.
    Example: "ip_2224"

  - `visit_type` (string)
    The type of patient visit with the provider. If not provided, the default value is set to .
    Enum: "all", "in_person", "video_visit"

  - `max_distance_to_patient_mi` (integer)
    The maximum distance in miles from the physical location to the search location (the center point of the given ). Default is 50 miles.

## Response 200 fields (application/json):

  - `request_id` (string, required)

  - `page` (integer, required)
    The zero based index of the current page.

  - `page_size` (integer, required)
    The size of the current page.

  - `total_count` (integer, required)
    The total number of result items.

  - `next_url` (string, required)
    A link to the next page of results; null if this is the last page of results.

  - `data` (object, required)

  - `data.search_parameters` (object, required)

  - `data.search_parameters.specialty_id` (string, required)
    The Zocdoc ID of the specialty used to search with. If no specialty was provided by the developer, this will be the specialty associated with the visit reason ID that was provided.
    Example: "sp_153"

  - `data.search_parameters.visit_reason_id` (string, required)
    The Zocdoc ID of the visit reason used to search with. If no visit reason was provided by the developer, this will be the default visit reason for the specialty id that was provided.
    Example: "pc_FRO-18leckytNKtruw5dLR"

  - `data.provider_locations` (array, required)

  - `data.provider_locations.provider_location_id` (string, required)
    Example: "pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890"

  - `data.provider_locations.provider_location_type` (string, required)
    Enum: "in_person_provider", "virtual_provider"

  - `data.provider_locations.accepts_patient_insurance` (string, required)
    Whether the provider location accepts the patient's insurance
    Enum: "accepted", "not_accepted", "insurance_not_specified"

  - `data.provider_locations.first_availability_date_in_provider_local_time` (string)
    The first date where provider has availability for new patients with any visit reason in provider's local time zone, formatted as YYYY-MM-DD and up to 90 days in the future.

  - `data.provider_locations.provider` (object, required)

  - `data.provider_locations.provider.npi` (string)

  - `data.provider_locations.provider.first_name` (string)

  - `data.provider_locations.provider.last_name` (string)

  - `data.provider_locations.provider.title` (string)

  - `data.provider_locations.provider.full_name` (string)

  - `data.provider_locations.provider.gender_identity` (string)
    Possible values include: Female, Male, Non-binary

  - `data.provider_locations.provider.specialties` (array)

  - `data.provider_locations.provider.specialty_ids` (array)

  - `data.provider_locations.provider.default_visit_reason_id` (string)

  - `data.provider_locations.provider.visit_reason_ids` (array)

  - `data.provider_locations.provider.statement` (string)

  - `data.provider_locations.provider.provider_photo_url` (string)
    Url to a provider's photo.
    Example: "https://d2uur722ua7fvv.cloudfront.net/ZeeFace_02.svg"

  - `data.provider_locations.provider.languages` (array)
    Languages spoken at the practice location, might be facilitated by translators on site. Download Languages csv.
    Example: ["English","Spanish"]

  - `data.provider_locations.provider.credentials` (object)
    Provider Credentials include education and certifications.

  - `data.provider_locations.provider.credentials.certifications` (array, required)

  - `data.provider_locations.provider.credentials.education` (object, required)

  - `data.provider_locations.provider.credentials.education.institutions` (array)

  - `data.provider_locations.location` (object)

  - `data.provider_locations.location.address1` (string, required)

  - `data.provider_locations.location.address2` (string)

  - `data.provider_locations.location.city` (string, required)

  - `data.provider_locations.location.state` (string, required)
    The location's two letter state code.
    Example: "NY"

  - `data.provider_locations.location.zip_code` (string, required)
    The location's 5 digit zip code.

  - `data.provider_locations.location.latitude` (number, required)

  - `data.provider_locations.location.longitude` (number, required)

  - `data.provider_locations.location.location_name` (string)

  - `data.provider_locations.location.distance_to_patient_mi` (number, required)
    Distance from patient to provider in miles.

  - `data.provider_locations.virtual_location` (object)

  - `data.provider_locations.practice` (object)

  - `data.provider_locations.practice.practice_id` (string, required)

  - `data.provider_locations.practice.practice_name` (string, required)

  - `data.provider_locations.booking_requirements` (object, required)
    Criteria for booking appointments, defines requirements and mandatory fields specified by Zocdoc providers

  - `data.provider_locations.booking_requirements.required_fields` (array, required)

  - `data.provider_locations.booking_requirements.accepts_booking_requests_from` (array, required)
    Enum: "in_network", "out_of_network", "self_pay"

## Response 400 fields (application/json):

  - `request_id` (string, required)

  - `error_type` (string, required)
    Enum: "api_error", "invalid_request"

  - `errors` (array, required)

  - `errors.field` (string)

  - `errors.message` (string, required)