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

# List Clients

`GET /v1/clients`

## Query parameters

- `include_archived` boolean
- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- ClientListResponse — Response model for list of clients.
  - `clients` ClientResponse[], required
    - `id` string, required
    - `customerId` string, required
    - `name` string, required
    - `score` integer, required
    - `scoreSource` string, nullable — Score data source: chr1 or chr2
    - `scoreChanges` ScoreChanges — Score changes over different time periods.
      - `7day` ScoreChange — Score change over a time period.
        - `change` number, required — Absolute change in score
        - `percentage` number, nullable — Percentage change
        - `previousScore` number, required — Score at start of period
      - `30day` ScoreChange — Score change over a time period.
        - `change` number, required — Absolute change in score
        - `percentage` number, nullable — Percentage change
        - `previousScore` number, required — Score at start of period
    - `lastContactDate` string, date-time, nullable
    - `lastUpdatedAt` string, date-time, nullable
    - `hasInsufficientData` boolean, nullable
    - `metadata` ClientMetadata — Client metadata.
      - `accountOwner` string, nullable
      - `annualRevenue` string, nullable
      - `industry` string, nullable
      - `location` string, nullable
      - `active` boolean, nullable
      - `accountStatus` string, nullable
      - `domain` string, nullable
      - `clientType` string, nullable
      - `revenueTTM` number, nullable
      - `revenueF12M` number, nullable
    - `extraColumns` object, nullable — Custom column values
    - `historicalData` integer[], nullable
    - `archived` boolean, nullable
  - `total` integer, required
  - `customerId` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/knownwell/apis/knownwell-api.md) · [All operations](https://skmtc.net/knownwell/apis/knownwell-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knownwell/knownwell-api/revisions/3cf7fd5ae733/schema)