---
title: "View operatories (beta)"
method: GET
path: "/operatories"
tags: ["Operatories"]
---

# View operatories (beta)

`GET /operatories`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/operatories`
- Auth: API key in header `Authorization`

> 🚧 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 the operatories of the specified location. Every filter is optional.

## Query parameters

- `subdomain` string, required
- `location_id` integer, required
- `start_cursor` string
- `end_cursor` string
- `per_page` integer
- `search_name` string
- `foreign_id` string
- `updated_since` string, date-time
- `include[]` string[]

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesOperatoryWithResourcesCollectionResponseWithCursor: API_V31_Entities_OperatoryWithResources_Collection_Response_WithCursor 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` APIV31EntitiesOperatoryWithResources[]
    - `id` integer: Operatories ID
    - `name` string: Name of the operatory from the integrated system
    - `foreign_id` string: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
    - `foreign_id_type` string: Foreign ID type is a unique identifier for the integrated system
    - `location_id` integer, nullable: Location ID relevant to the Operatory
    - `created_at` string, date-time: Operatories created time in UTC
    - `updated_at` string, date-time: Operatories last updation time in UTC
    - `display_name` string, nullable: Optional custom display name
    - `active` boolean: Is operatory active?
    - `bookable_online` boolean: Operatory is active for online booking?
    - `appointment_types` APIV2EntitiesAppointmentTypeBasic[]: Collection of 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
  - `page_info` object: Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)