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

# Get a paged array of contacts

`GET /contacts`

Get a paged array of contacts

## 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 — Contact firstname
- `lastname` string, nullable — Contact lastname
- `email` string, email, nullable — Contact email
- `phoneNumber` string, nullable — Contact phone number without country code

## Response `200`

A paged array of contacts

- object
  - `data` object[], required
    - `id` integer, required — Contact id
    - `type` string, nullable, required — Contact type
    - `name` string, nullable, required — Contact name
    - `title` string, nullable, required — Contact title
    - `firstName` string, nullable, required — Contact first name
    - `lastName` string, nullable, required — Contact last name
    - `preferredName` string, nullable, required — Contact preferred name
    - `occupation` string, nullable, required — Contact occupation
    - `companyName` string, nullable, required — Contact company name
    - `providerNumber` string, nullable, required — Contact provider number
    - `doctorType` string, nullable, required — Contact doctor type
    - `associatedPatientIds` number[], nullable, required — The associated patients' id in this contact
    - `associatedInvoiceIds` number[], nullable, required — The associated invoices' id in this contact
    - `associatedCaseIds` number[], nullable, required — The associated invoices' id in this contact
    - `email` string, nullable, required — Contact email
    - `addressL1` string, nullable, required — Contact address line 1
    - `addressL2` string, nullable, required — Contact address line 2
    - `addressL3` string, nullable, required — Contact address line 3
    - `suburb` string, nullable, required — Contact city
    - `state` string, nullable, required — Contact state
    - `postalCode` string, nullable, required — Contact post code
    - `country` string, nullable, required — Contact country
    - `phoneNumbers` object[]
      - `type` 'Mobile' | 'Home' | 'Work' | 'Fax' | 'Other', nullable — Phone number type
      - `code` string, nullable — Phone country code
      - `phoneNumber` string, required — Phone number
    - `archived` boolean, nullable — Whether the contact has been archived
    - `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)