NEnexhealth
Locations

View location (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.ehr, data.ehr.display_name, data.ehr.id, data.ehr.name (+1 more); removes response field data.last_sync_time.

This endpoint returns a single location by its NexHealth ID.

get/locations/{id}

Request

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

Path parameters

idinteger required

The NexHealth location ID

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": 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,
    "ehr": {
      "id": 11,
      "name": "dentrix",
      "display_name": "Dentrix",
      "type": "onprem"
    }
  },
  "count": 2
}

Changes

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