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

# Get a paged array of patients

`GET /patients`

Get a paged array of patients

## 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
- `firstname` string, nullable — Patient firstname
- `lastname` string, nullable — Patient lastname
- `email` string, email, nullable — Patient email
- `birthdate` string, nullable — Patient birth date in YYYY-MM-DD format
- `phoneNumber` string, nullable — Patient phone number without country code
- `patientTag` string, nullable — Patient tag

## Response `200`

A paged array of patients

- object
  - `data` object[], required
    - `firstname` string, required — Patient first name
    - `lastname` string, required — Patient last name
    - `middleName` string, nullable — Patient middle name
    - `preferredName` string, nullable — Patient preferred name
    - `title` string, nullable — Patient title
    - `email` string, nullable — Patient email
    - `sex` string, nullable — Patient sex
    - `genderIdentity` string, nullable — Patient gender identity
    - `pronouns` string, nullable — Patient pronouns
    - `alert` string, nullable — Patient alert messages
    - `invoiceRecipientId` integer, nullable — The invoice receipient (contact) id of this patient
    - `birthdate` union — Patient birthdate in YYYY-MM-DD format
      - string
      - string
      - unknown
    - `timezone` string, nullable — Patient timezone
    - `extraInfo` string, nullable — Patient extra info
    - `extraBillingInfo` string, nullable — Patient extra billing info
    - `addressL1` string, nullable — Patient address line 1
    - `addressL2` string, nullable — Patient address line 2
    - `addressL3` string, nullable — Patient address line 3
    - `city` string, nullable — Patient city
    - `state` string, nullable — Patient state
    - `postalCode` string, nullable — Patient post code
    - `country` string, nullable — Patient country
    - `phoneNumbers` object[], nullable
      - `type` 'Mobile' | 'Home' | 'Work' | 'Fax' | 'Other', nullable — Phone number type
      - `code` string, nullable — Phone country code
      - `phoneNumber` string, required — Phone number
    - `privacyPolicy` 'No response' | 'Accepted' | 'Rejected' | '', nullable — Patient privacy policy status
    - `ndisNumber` string, nullable — Patient NDIS number
    - `ndisInfo` object, nullable
      - `diagnosis` string, nullable — NDIS Diagnosis
      - `nomineeEmail` string, nullable — Nominee email
      - `fundManagement` string, nullable — NDIS fund management type
      - `nomineeLastName` string, nullable — Last name of nominee
      - `nomineeFirstName` string, nullable — First name of nominee
      - `nomineeMobileCode` string, nullable — Nominee phone country code
      - `nomineeMobileNumber` string, nullable — Nominee phone number
      - `startDate` string, nullable — Plan start date
      - `endDate` string, nullable — Plan end date
    - `medicareNum` string, nullable — Patient Medicare number
    - `irn` string, nullable — Patient Medicare reference number
    - `veteransFileNumber` string, nullable — Patient veterans information
    - `emergencyContactNumber` string, nullable — Patient emergency contact number
    - `emergencyContactName` string, nullable — Patient emergency contact name
    - `emergencyContactRelationship` string, nullable — Patient emergency contact relationship
    - `communicationPreference` 'NONE' | 'SMS' | 'SMS_EMAIL' | 'EMAIL' — Patient communication preference (defaults to organisation's communication preference if not set)
    - `archived` boolean, nullable — Whether the patient has been archived
    - `id` integer, required — Patient Id
    - `patientTags` string[], nullable — Patient tags
    - `customFields` object[], nullable
      - `name` string, required
      - `value` union, required
        - string
        - number
    - `healthFund` object, nullable
      - `name` string, required — Health fund name
      - `membershipNumber` string, nullable — Health fund membership number
      - `patientNumber` string, nullable — Health fund patient number
      - `cardIssueNumber` string, nullable — Health fund card issue number
    - `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.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)