NEnexhealth
Operatories

View operatory (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: Removes response field data.last_sync_time.

This endpoint returns a single operatory by its NexHealth ID, with optional sideloading of appointment_types and appt_categories.

get/operatories/{id}

Request

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

Path parameters

idinteger required

NexHealth ID of the operatory

Query parameters

subdomainstring required

Used to scope the request to the specified institution

include[]string[]

Resources to be included in the response

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": "op1",
    "foreign_id": "1",
    "foreign_id_type": "--DataSource-",
    "location_id": 4,
    "created_at": "2020-06-05T20:16:57.007Z",
    "updated_at": "2020-06-05T20:16:57.007Z",
    "display_name": "op1",
    "active": true,
    "bookable_online": true,
    "appointment_types": [
      {
        "id": 1,
        "name": "Medical",
        "parent_type": "Institution",
        "parent_id": 1,
        "minutes": 15
      }
    ]
  },
  "count": 2
}

Changes

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