---
title: "List Clients"
method: GET
path: "/v1/clients"
---

# List Clients

`GET /v1/clients`

This API endpoint retrieves a list of clients. <br><br>You can use the query params to filter a subset of clients who match specific field values.

## Query parameters

- `companyId` string
- `email` string
- `givenName` string
- `familyName` string
- `nextToken` string
- `limit` integer

## Response `200`

200

- object
  - `data` object[]
    - `id` string
    - `object` string
    - `createdAt` string
    - `givenName` string
    - `familyName` string
    - `email` string
    - `companyId` string
    - `companyIds` string[]
    - `status` string
    - `inviteUrl` string
    - `avatarImageUrl` string
    - `firstLoginDate` string
    - `lastLoginDate` string
    - `customFields` object
      - `phoneNumber` string
      - `tags` string[]
      - `address` object
        - `country` string
        - `region` string
        - `postalCode` string
        - `addressLine1` string
        - `addressLine2` string
        - `city` string
        - `fullAddress` string
      - `email` string
      - `text` string
      - `url` string
      - `number` number
    - `fallbackColor` string
    - `creationMethod` string
    - `updatedAt` string
  - `nextToken` string

## Other responses

- `403` — 403

---

[API](https://skmtc.net/assembly/apis/core-resources.md) · [All operations](https://skmtc.net/assembly/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/assembly/core-resources/versions/28a9e7d13a8c/schema)