---
title: "GET /customers"
method: GET
path: "/customers"
tags: ["Customers"]
---

# GET /customers

`GET /customers`

Returns a list of customers. The list can be filtered by customer name.<br/><br/>
    A note about contact items on each person:<br>
    <ul>
      <li>The contact items are an array of objects. Each object has a `contactType` and a `contactValue`.
      <li>The `contactType` can be one of the following: email, phone, mobile, or fax.
      <li>The `contactValue` can be an email address or phone number.
    </ul>

## Query parameters

- `pageSize` integer
- `sortOrder` union
  - 'asc'
  - 'desc'
- `pageCursor` string
- `sortField` union
  - 'name'
  - 'createdAt'
- `filterSearchText` string

## Response `200`

Successful Response

- GetCustomersResponse
  - `result` string, required
  - `data` Customer[], required
    - `id` number, required
    - `companyId` number, required
    - `customerFullName` string, nullable, required
    - `createdAt` string, date-time, nullable, required
    - `mainContact` PersonContact, 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.
    - `physicalAddress` AddressContact, required
      - `id` number, required
      - `address1` string, nullable, required
      - `address2` string, nullable, required
      - `addressSuburb` string, nullable, required
      - `addressCity` string, nullable, required
      - `addressRegion` string, nullable, required
      - `addressPostcode` string, nullable, required
      - `addressCountry` string, nullable, required
    - `postalAddress` AddressContact, required
      - `id` number, required
      - `address1` string, nullable, required
      - `address2` string, nullable, required
      - `addressSuburb` string, nullable, required
      - `addressCity` string, nullable, required
      - `addressRegion` string, nullable, required
      - `addressPostcode` string, nullable, required
      - `addressCountry` string, nullable, required
    - `billingContact` PersonContact, 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.
    - `pricingTier` PricingTier, required
      - `id` number, required
      - `name` string, required
      - `isDefault` boolean, required
      - `tierType` string, required
      - `markupRate` number, nullable, required
      - `createdAt` string, required
      - `links` Links[], required
        - `href` string, required
        - `rel` string, required
        - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
    - `customerSource` string, 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)