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

# View operatories

`GET /operatories`

This endpoint returns the operatories for the specified location, narrowed down by the optional filters configured.

## 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

- APIV2EntitiesOperatoryWithResourcesCollectionResponseWithCursor — API_V2_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` APIV2EntitiesOperatoryWithResources[]
    - `id` integer — Operatories Id
    - `name` string — Name of the operatory from the integrated system
    - `foreign_id` string — Foreign Id is a unique identifier from the integrated system
    - `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
    - `last_sync_time` string, date-time, nullable — Last time the resource was refreshed with data from the data source in UTC
    - `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.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)