NEnexhealth
Providers

View providers (beta)

🚧 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 the providers of the institution. Every filter is optional.

get/providers

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/providers
  • Auth
    API key in header Authorization

Query parameters

subdomainstring required

Used to scope the request to the specified institution

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

sortstring

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

  • updated_at
  • -updated_at
location_idinteger

Only return providers associated with the specified Location ID

foreign_idstring

Unique appointment ID from the EHR

requestableboolean

Only return providers who are bookable via NexHealth online booking at the specified location_id

inactiveboolean

Filter result set based on inactive status, defaults to false if not specified

updated_sincestring date-time

Query providers whose records have updated since the specified datetime in ISO8601 format. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000

ids[]integer[]

NexHealth IDs

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 415,
      "email": "anthony.smith@nexhealth.com",
      "first_name": "John",
      "middle_name": "Anthony",
      "last_name": "Smith",
      "name": "John Smith",
      "created_at": "2020-06-05T20:16:57.007Z",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "institution_id": 1,
      "foreign_id": "532e7f8c",
      "foreign_id_type": "--DataSource-",
      "phone_number": "5163042196",
      "display_name": "John Smith",
      "npi": "1912507500",
      "tin": "078051120",
      "state_license": "R219935",
      "specialty_code": "363L00000X",
      "locations": [
        {
          "id": 7,
          "name": "Default",
          "institution_id": 1,
          "street_address": "123 Law St",
          "street_address_2": "85335, North East",
          "city": "New York",
          "state": "NY",
          "zip_code": "54700",
          "country_code": "US",
          "created_at": "2020-06-05T20:16:57.007Z",
          "updated_at": "2020-06-05T20:16:57.007Z",
          "latitude": 37.7775028,
          "longitude": -122.3970603,
          "phone_number": "8888750851",
          "foreign_id": "1",
          "foreign_id_type": "--DataSource-",
          "email": "defaultLocation@nexhealth.com",
          "tz": "America/Los_Angeles",
          "insert_appt_client": true,
          "map_by_operatory": true
        }
      ],
      "provider_requestables": [
        {
          "location_id": 4
        }
      ]
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

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