NEnexhealth
Institutions

View institution (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 field data.ehrs; removes response field data.emrs.

This endpoint returns a single institution by its NexHealth ID.

get/institutions/{id}

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/institutions/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

The NexHealth ID of the institution

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.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": 1,
    "name": "General Practice",
    "created_at": "2020-06-05T20:16:57.007Z",
    "updated_at": "2020-06-05T20:16:57.007Z",
    "subdomain": "example-sandbox",
    "phone_number": "2222222222",
    "country_code": "US",
    "is_sync_notifications": true,
    "locations": [
      {
        "id": 7,
        "name": "Default",
        "street_address": "123 Law St",
        "street_address_2": "85335, North East",
        "city": "New York",
        "state": "NY",
        "zip_code": "54700",
        "phone_number": "8888750851",
        "email": "defaultLocation@nexhealth.com"
      }
    ],
    "ehrs": [
      "dentrix",
      "curve2"
    ]
  },
  "count": 2
}

Changes

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