---
title: "View provider (beta)"
method: GET
path: "/providers/{id}"
tags: ["Providers"]
---

# View provider (beta)

`GET /providers/{id}`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/providers/{id}`
- Auth: API key in header `Authorization`

> 🚧 Beta
>
> Send `Nex-Api-Version: v3.1.0` to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

> **Changed from v3.0.0:** Adds response fields `data.cell_phone_number`, `data.home_phone_number`, `data.phone_number`, `data.work_phone_extension` (+1 more); and other schema changes.

This endpoint returns a single provider by its NexHealth ID.

## Path parameters

- `id` integer, required

## Query parameters

- `subdomain` string, required

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesProviderWithResourcesResponse: API_V31_Entities_ProviderWithResources_Response model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesProviderWithResources
    - `id` integer: User ID
    - `email` string: User email
    - `first_name` string: First name
    - `middle_name` string: Middle name
    - `last_name` string: Last name
    - `name` string: Full name
    - `created_at` string, date-time: User creation date in UTC
    - `updated_at` string, date-time: User last update date in UTC
    - `institution_id` integer: The institution this user belongs to
    - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
    - `foreign_id_type` string: Foreign ID type is a unique string identifier for the integrated system
    - `inactive` boolean: Is the user inactivated?
    - `phone_number` string: Primary phone number
    - `cell_phone_number` string: Cell phone number
    - `home_phone_number` string: Home phone number
    - `work_phone_number` string: Work phone number
    - `work_phone_extension` string: Work phone extension
    - `display_name` string: Display name
    - `npi` string: National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system.
    - `tin` string: Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system.
    - `state_license` string: State license number. May be null if the practice did not enter it into the integrated system.
    - `specialty_code` string: Specialty code corresponding to the provider's state license and NPI. May be null if the practice did not enter it into the integrated system.
    - `locations` APIV31EntitiesLocationBasic[]
      - `id` integer: Location ID
      - `name` string: Location name
      - `institution_id` integer: Institution ID
      - `street_address` string, nullable: Location street address
      - `street_address_2` string, nullable: Location street address 2
      - `city` string, nullable: Location city
      - `state` string, nullable: 2 letter state code
      - `zip_code` string, nullable: Location zip code
      - `country_code` string, nullable: Location country code
      - `created_at` string: Location created time in UTC
      - `updated_at` string: Location last updation time in UTC
      - `latitude` number, float, nullable: Geolocated latitude determined by the address
      - `longitude` number, float, nullable: Geolocated longitude determined by the address
      - `phone_number` string, nullable: Practice phone number
      - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
      - `foreign_id_type` string: Unique identifier for the integrated system
      - `email` string, nullable: Location email ID
      - `tz` string: Timezone name
      - `insert_appt_client` boolean: True if appointments created at this location are inserted into the EHR
      - `map_by_operatory` boolean: True if this location uses and therefore requires an operatory to schedule appointments
      - `set_availability_by_operatory` boolean: True if the location has appointment types specific to an operatory, false if the appointment types are specific to a provider
      - `inactive` boolean: Is this location not being actively used?
      - `specialty` APIEntitiesSpecialty
        - `id` integer: Specialty ID
        - `name` string: Specialty name
    - `provider_requestables` APIV2EntitiesProviderRequestable[]: List of locations this provider can be booked with at
      - `location_id` integer: Location ID
  - `count` integer: Number of total objects, in case of collection.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)