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

# Get a paged array of cases

`GET /cases`

Get a paged array of cases

## 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
- `patientId` number, nullable — Patient id
- `practitionerId` number, nullable — Practitioner id
- `contactId` number, nullable — Contact id
- `trackType` 'Appointments' | 'Hours' | 'Budget', nullable — Track type
- `status` 'Open' | 'Closed' | 'Expired', nullable — Status

## Response `200`

A paged array of cases

- object
  - `data` object[], required
    - `id` integer, required — Case id
    - `caseNumber` string — Case number
    - `budget` number, nullable — Budget
    - `appointmentCount` number, nullable — Appointment count
    - `contactId` integer, nullable, required — Contact Id
    - `providerNumber` string, nullable — Provider number
    - `referralPeriod` string, nullable — Referral Period
    - `issueDate` union, required — Issued date in YYYY-MM-DD HH:MM:SS format
      - string
      - string
      - unknown
    - `expiryDate` union, required — Expiry date in YYYY-MM-DD HH:MM:SS format
      - string
      - string
      - unknown
    - `notes` string, nullable — Notes
    - `trackType` 'Appointments' | 'Hours' | 'Budget' — Track type
    - `hours` number, nullable, required — hours
    - `includeDidNotArrive` boolean, nullable — Did not arrive
    - `includeCancelled` boolean, nullable — Include cancelled
    - `practitionerId` integer, nullable, required — Practitioner id
    - `items` object[], required — An array of appointment connections associated with this case
      - `typeId` integer, required — Item type id
      - `type` 'Appointment' | 'SupportActivity' | 'File' | 'SupportingActivity' | 'Letter', required — Item type
    - `organisationId` integer, required — Organisation id
    - `patientId` integer, required — Patient id
    - `isOpen` boolean, nullable — Is open
    - `hasAlert` boolean, nullable — Has alert
    - `remindTime` string, nullable — Remind time
    - `utilisationAlert` number, nullable — Utilisation alert
    - `isAlertUtilizationSent` boolean, nullable — Is alert utilization sent
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
  - `links` object, required
    - `previousPage` string — The link to retrieve next page
    - `nextPage` string — The link to retrieve previous page

---

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