---
title: "GET /contacts"
method: GET
path: "/contacts"
tags: ["Contacts"]
---

# GET /contacts

`GET /contacts`

Returns a list of contacts. The list can be filtered by contact type.

## Query parameters

- `pageSize` integer
- `sortOrder` union
  - 'asc'
  - 'desc'
- `pageCursor` string
- `sortField` 'firstName' | 'lastName' | 'createdAt'
- `filterContactType` 'CUSTOMER' | 'SITE'
- `filterCustomerId` number
- `filterSiteId` number
- `filterSearchText` string

## Response `200`

Successful Response

- ContactsResponse
  - `result` string, required
  - `data` Contact[], required
    - `id` number, required
    - `firstName` string, nullable, required
    - `lastName` string, nullable, required
    - `position` string, nullable, required
    - `company` string, nullable, required
    - `contactItems` ContactItem[], nullable, required
      - `id` number, required
      - `contactType` 'email' | 'phone' | 'mobile' | 'other' | 'fax' | 'website', required — The type of this contact item. It can be one of the following: email, phone, mobile, other, fax, website
      - `contactValue` string, required — The value of this contact item.
    - `contactType` 'CUSTOMER' | 'SITE', required
    - `isMain` boolean, required
    - `isBilling` boolean, required
    - `customerId` number, nullable, required
    - `siteId` number, nullable, required
    - `createdAt` string, date-time, nullable, required
    - `modifiedAt` string, date-time, nullable, required
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
  - `paging` Pagination
    - `perPage` number, required
    - `pageCount` number, required
    - `links` object, required
      - `self` string, required
      - `previous` string, nullable, required
      - `next` string, nullable, required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

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