---
title: "Get a paged array of appointments"
method: GET
path: "/appointments"
tags: ["appointment"]
---

# Get a paged array of appointments

`GET /appointments`

Get a paged array of appointments

## Query parameters

- `id_gt` integer, nullable — The starting object id of the next page
- `id_lt` integer, nullable — The starting object id of the previous page
- `update_gt` union — Search for objects updated after this date time
  - string
  - string
- `update_lt` union — Search for objects updated before this date time
  - string
  - string
- `include_archived` 'true' | 'false', nullable — Whether archived objects should be retrieved, default is false
- `start_gt` union — Search for appointments start after this date time
  - string
  - string
  - unknown
- `start_lt` union — Search for appointments start before this date time
  - string
  - string
  - unknown
- `patientId` number, nullable — Search for appointments with this patient id
- `practitionerId` number, nullable — Search for appointments with this practitioner id
- `status` 'Arrived' | 'Did not arrive' | 'Cancelled' | 'Completed', nullable — Patient status of this appointment
- `status_update_gt` union — Search for appointments status update after this date time
  - string
  - string
  - unknown
- `status_update_lt` union — Search for appointments status update before this date time
  - string
  - string
  - unknown

## Response `200`

A paged array of appointments

- object
  - `data` object[], required
    - `id` integer, required — Appointment id
    - `start` union, required — Appointment start date time
      - string
      - string
    - `end` union, required — Appointment end date time
      - string
      - string
    - `isUnavailableBlock` boolean, nullable — **@deprecated** - please refer to the new [busy-time](/api-reference/endpoints/busy-time) endpoint. Whether this time slot is unavailable, eg. busy time or meeting
    - `busyTimePractitionerIds` integer[] — **@deprecated** - please refer to the new [busy-time](/api-reference/endpoints/busy-time) endpoint. The practitioner ids of this multiple practitioners busy time
    - `serviceId` integer, nullable, required — The service id of this appointment
    - `locationId` integer, required — The location id of this appointment
    - `practitionerId` integer, nullable, required — The practitioner id of this appointment
    - `maxPatients` integer, required — The max patient number of this appointment. A number greater than 1 indicates a group appointment.
    - `appointmentPatients` object[], required — The status of each patient of this appointment
      - `appointmentId` integer, required — Appointment id
      - `patientId` integer, required — Patient id
      - `caseId` integer, nullable, required — The case id of this appointment
      - `status` 'Arrived' | 'Did not arrive' | 'Cancelled' | 'Completed', nullable, required — Patient status of this appointment
      - `note` string, nullable, required — Note for the appointment patient
      - `doNotInvoice` boolean, nullable — Whether this appointment patient will not be invoiced
      - `invoiceId` integer, nullable, required — Invoice id of this appointment patient
      - `cancellationReason` string, nullable, required — The cancellation reason if the appointment is cancelled
      - `cancellationRate` number, nullable, required — The billable rate in percentage if the appointment is cancelled
      - `cancellationNote` string, nullable, required — The cancellation note if the appointment is cancelled
      - `statusUpdatedAt` union, required — The status update time
        - string
        - string
        - unknown
    - `repeatId` string, nullable, required — An recurring appointment will have this repeat id
    - `recurringRule` string, nullable, required — The rule for recurring appointment
    - `unit` 'Hour' | 'Each', nullable, required — The appointment unit
    - `pricing` number, nullable, required — The appointment unit price, in dollar
    - `total` number, nullable, required — The appointment total price without tax, in dollar
    - `taxType` union, required — Tax type, check Splose support for more info
      - 'STANDARD' | 'ZERO' | 'EXEMPT' | 'REDUCED'
      - string
      - unknown
    - `supportItemIds` integer[], required — Array of support item ids of this appointment
    - `note` string, nullable, required — The appointment note
    - `archived` boolean, nullable — Whether the appointment has been archived
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
    - `deletedAt` union, required — Object archived date time
      - string
      - string
      - unknown
  - `links` object, required
    - `previousPage` string — The link to retrieve next page
    - `nextPage` string — The link to retrieve previous page

---

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