---
title: "GET /api/appointments"
method: GET
path: "/api/appointments"
tags: ["Clinical"]
---

# GET /api/appointments

`GET /api/appointments`

Retrieve or search appointment or breaks.
<b>Note:</b> Either `since`, `occurred_since`, `date` or `date_range` parameter must be specified.
          results returned in order of scheduled date.

## Query parameters

- `cursor` string — The pagination cursor value.
- `page_size` integer — Number of results to return per page.
- `status` string
- `patient` integer
- `office` integer
- `doctor` integer
- `since` string
- `occurred_since` string — Filter appointments based on scheduled time
- `date_range` string
- `verbose` boolean
- `date` string
- `ignore_virtual` boolean — Do not include virtual appointments that have not yet been materialized. This is useful when you need to get a list of appointments that are materialized and ready to be used.
- `show_archived` boolean — Include archived or deleted appointments in the response

## Response `200`

OK

- union — Availability response structure for single date or date range.
  - object
    - `dates` object[], required — List of dates and their open slots.
      - `date` string, date, required — Date in YYYY-MM-DD format.
      - `open_slots` object[], required — List of available time slots.
        - `start` string, required — Slot start time (HH:MM format)
        - `end` string, required — Slot end time (HH:MM format)
        - `availability` integer, required — Number of available slots (or adjust type to match implementation)
    - `office` integer — Office ID (if specified).
    - `doctor` integer — Doctor ID (if specified).
    - `exam_room` integer — Exam room ID (if specified).
    - `date_range` string[], required — Start and end date of the range.
    - `duration` integer, required — Duration of each slot in minutes.
  - object
    - `office` integer — Office ID (if specified).
    - `doctor` integer — Doctor ID (if specified).
    - `open_slots` object[] — List of available time slots.
      - `start` string, required — Slot start time (HH:MM format)
      - `end` string, required — Slot end time (HH:MM format)
      - `availability` integer, required — Number of available slots (or adjust type to match implementation)
    - `exam_room` integer — Exam room ID (if specified).
    - `duration` integer — Duration of each slot in minutes.
    - `date` string, date — Date in YYYY-MM-DD format.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Permission Denied
- `500` — Internal Server Error

---

[API](https://skmtc.net/drchrono/apis/untitled-api.md) · [All operations](https://skmtc.net/drchrono/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drchrono/untitled-api/versions/e595797fe800/schema)
