---
title: "View appointment descriptors (beta)"
method: GET
path: "/appointments/{id}/appointment_descriptors"
tags: ["Appointments"]
---

# View appointment descriptors (beta)

`GET /appointments/{id}/appointment_descriptors`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/appointments/{id}/appointment_descriptors`
- 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 EHR appointment descriptors associated with the given appointment, optionally filtered by `descriptor_type`.

## Path parameters

- `id` integer, required

## Query parameters

- `subdomain` string, required
- `descriptor_type` string

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesEhrApptDescriptorCollectionResponse: API_V31_Entities_EhrApptDescriptor_Collection_Response 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` APIV31EntitiesEhrApptDescriptor[]
    - `id` integer: Descriptor ID
    - `descriptor_type` string: The type of descriptor
    - `name` string: The name of descriptor
    - `code` string: The code of descriptor
    - `location_id` integer: The location this object belongs to
    - `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: Unique identifier for the integrated system itself
    - `data` object: The configuration object, structure depends on the underlying EHR
    - `active` boolean: Is descriptor active?
    - `created_at` string, date-time: The datetime the descriptor was created in UTC
    - `updated_at` string, date-time: The datetime the descriptor was last updated in UTC
  - `count` integer: Number of total objects, in case of collection.

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