--- title: "View provider" method: GET path: "/providers/{id}" tags: ["Providers"] --- # View provider `GET /providers/{id}` This endpoint returns a single provider. ## Path parameters - `id` integer, required ## Query parameters - `subdomain` string, required - `include[]` string[] ## Headers - `Nex-Api-Version` string, required ## Response `200` Successful - APIV20240412EntitiesProviderWithResourcesResponse — API_V20240412_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` APIV20240412EntitiesProviderWithResources - `id` integer — User id - `email` string, nullable — User email - `first_name` string — First name - `middle_name` string, nullable — 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 updation date in UTC - `institution_id` integer — The institution this user belongs to - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned - `inactive` boolean — Is the user inactivated? - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source - `display_name` string, nullable — Display name - `npi` string, nullable — National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system. - `tin` string, nullable — Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system. - `state_license` string, nullable — State license number. May be null if the practice did not enter it into the integrated system. - `specialty_code` string, nullable — 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` APIEntitiesLocation[] — Locations the provider is associated with - `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 — Unique identifier from the integrated system - `foreign_id_type` string — Unique identifier for the integrated system - `email` string, nullable — Location email id - `tz` string — Timezone name - `last_sync_time` string, nullable — Last time the resource was refreshed with data from the data source - `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 - `availabilities` APIV20240412EntitiesWorkingHourWithAppointmentTypes[] — List of availabilities for the provider, each with its associated appointment types - `id` integer — Resource id - `provider_id` integer, nullable — Provider id - `location_id` integer, nullable — Location id - `operatory_id` integer, nullable — Operatory id - `begin_time` string — Availability start time in the practices timezone - `end_time` string — Availability end time in the practices timezone - `days` string[], nullable — Configured week days. Empty when the working hour is configured for a custom recurrence - `specific_date` string, date, nullable — Configured specific date - `custom_recurrence` object, nullable — Configured custom recurrence, with the fields num (recurrence interval count), ref (starting date), and unit (day, week, or month) - `tz_offset` string — UTC offset for the practice - `active` boolean — Is active? - `source` 'manual' | 'synced' — Source of the working hour - `label` APIV20240412EntitiesWorkingHourLabel - `id` integer — Resource id - `location_id` integer, nullable — The location ID - `name` string — The name for working hour label - `appointment_types` APIV2EntitiesAppointmentTypeBasic[] — Associated appointment types - `id` integer — Appointment type Id - `name` string — Appointment type name. Unique string identifier - `parent_type` string — Parent type for appointment type. Defines the belongs to relationship with either Institution or Location - `parent_id` integer — Identifies the specific resource the appointment type belongs to (see parent_type) - `minutes` integer — Default duration of appointments of this appointment type - `bookable_online` boolean — True if this appointment type should be bookable via the NexHealth online booking page - `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.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)