---
title: "List clients"
method: GET
path: "/api/business/{businessId}/client"
tags: ["Client"]
---

# List clients

`GET /api/business/{businessId}/client`

Get a list of clients for the specified business id. List can be filtered by email, phone, DateTime of update, first and last name, external id and possibility to include archived, deleted and linked clients

## Path parameters

- `businessId` string, required

## Query parameters

- `email` string
- `phone` string
- `updatedAfter` string
- `updatedBefore` string
- `firstName` string
- `lastName` string
- `externalId` string
- `includeArchived` boolean
- `includeDeleted` boolean
- `includeLinkedClients` boolean

## Response `200`

Clients listed

- DataPagedModelClientResponse
  - `_embedded` object
    - `clients` ClientResponse[]
      - `linkedClientMobile` string
      - `landLine` string
      - `email` string
      - `address` AddressData
        - `streetAddress1` string
        - `streetAddress2` string
        - `city` string
        - `state` string
        - `postalCode` string
        - `country` string
      - `birthDate` string, date
      - `clientSince` string, date-time
      - `gender` 'MALE' | 'FEMALE' | 'NON_BINARY' | 'NOT_SPECIFIED' | 'PREFER_NOT_TO_SAY' | 'UNKNOWN'
      - `notes` string
      - `smsMarketingConsent` boolean
      - `emailMarketingConsent` boolean
      - `smsReminderConsent` boolean
      - `emailReminderConsent` boolean
      - `preferredStaffId` string
      - `externalId` string
      - `creatingBranchId` string
      - `archived` boolean
      - `banned` boolean
      - `clientCategoryIds` string[] — The list of client category IDs associated with this client
      - `clientId` string
      - `version` integer
      - `firstName` string, required
      - `lastName` string, required
      - `mobile` string
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `photoUrl` string
      - `creditAccount` CreditAccount
        - `outstandingBalance` number
        - `creditDays` integer
        - `creditLimit` number
      - `loyaltyCard` LoyaltyCard
        - `serial` string
        - `points` integer
      - `mergedToClientId` string
      - `linkedClientId` string — id of the linked (parent) client this client is linked to, if any
      - `deleted` boolean
      - `firstVisit` string, date
      - `lastVisit` string, date
      - `lastVisitedBranchId` string
  - `page` PageMetadata
    - `size` integer
    - `totalElements` integer
    - `totalPages` integer
    - `number` integer

## Other responses

- `400` — Bad Request
- `404` — Business with the specified id doesn't exist
- `429` — Request rate limit exceeded. Current limit set to 100 rps.
- `500` — Internal Server Error

---

[API](https://skmtc.net/phorest/apis/third-party-api.md) · [All operations](https://skmtc.net/phorest/apis/third-party-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/phorest/third-party-api/revisions/2218bc90d39c/schema)