---
title: "View appointments"
method: GET
path: "/appointments"
tags: ["Appointments"]
---

# View appointments

`GET /appointments`

This endpoint returns the appointments starting within the requested time window, narrowed down by the optional filters configured. At least one of location_id or foreign_id must be provided.

## Query parameters

- `subdomain` string, required
- `location_id` integer
- `sort` string
- `start` string, date-time, required
- `end` string, date-time, required
- `timezone` string
- `cancelled` boolean
- `unavailable` boolean
- `nex_only` boolean
- `updated_since` string, date-time
- `appointment_type_id` integer
- `foreign_id` string
- `created_by` integer
- `start_cursor` string
- `end_cursor` string
- `per_page` integer
- `patient_ids[]` integer[]
- `provider_ids[]` integer[]
- `operatory_ids[]` integer[]

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV2EntitiesAppointmentWithoutIncludesCollectionResponseWithCursor — API_V2_Entities_AppointmentWithoutIncludes_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` APIV2EntitiesAppointmentWithoutIncludes[]
    - `id` integer — Appointment id
    - `patient_id` integer, nullable — Appointment patient id
    - `provider_id` integer, nullable — Provider id
    - `provider_name` string, nullable — Provider name
    - `start_time` string, date-time — Appointment scheduled start time in UTC
    - `confirmed` boolean, nullable — Appointment confirmation status
    - `patient_missed` boolean, nullable — Did the patient no show? Not supported by all integrations
    - `created_at` string, date-time — Appointment created time in UTC
    - `updated_at` string, date-time — Appointment last updation time in UTC
    - `note` string, nullable — Appointment note
    - `end_time` string, date-time — Appointment scheduled end time in UTC
    - `unavailable` boolean, nullable — Is this appointment a scheduling block (blocks off the schedule)
    - `cancelled` boolean — Is this appointment cancelled?
    - `timezone` string — Appointment timezone
    - `institution_id` integer — Institution id
    - `appointment_type_id` integer, nullable — Nexhealth appointment_type id, 0 if not set
    - `checkin_at` string, date-time, nullable — Time the patient checked in at in UTC. Not supported by all integrations
    - `location_id` integer, nullable — Appointment location id
    - `foreign_id` string, nullable — Unique identifier of this resource from the integrated system
    - `foreign_id_type` string — Unique identifier for the integrated system itself
    - `misc` object, nullable — Miscellaneous information for the appointment. The is_booked_on_nexhealth key indicates whether the appointment was booked through NexHealth
    - `last_sync_time` string, date-time, nullable — Last Sync time in UTC
    - `patient_confirmed` boolean, nullable — Is this appointment confirmed by the patient (as opposed to the office)?
    - `created_by_user_id` integer, nullable — Id of the user who booked the appointment
    - `is_guardian` boolean, nullable — Was the appointment booked by a guardian?
    - `patient_confirmed_at` string, date-time, nullable — Time of patient_confirmation in UTC
    - `cancelled_at` string, date-time, nullable — Time of appointment cancellation in UTC. Note this will not be reset if the appointment is uncancelled
    - `is_new_clients_patient` boolean, nullable — Is this a new patient at this practice?
    - `confirmed_at` string, date-time, nullable — Time of appointment confirmation by the office in UTC
    - `sooner_if_possible` boolean, nullable — Does patient want an earlier time?
    - `operatory_id` integer, nullable — Operatory id for the appointment
    - `checked_out` boolean, nullable — Has the patient checked out? Not supported by all integrations
    - `checked_out_at` string, date-time, nullable — Time of check out in UTC
    - `referrer` string, nullable — Optional field to store URI origin of the booking
    - `is_past_patient` boolean, nullable — Does this patient have prior appointments?
    - `timezone_offset` string — Timezone offset string
  - `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)