---
title: "List Client Alignments"
method: GET
path: "/v1/clients/alignment"
tags: ["alignment"]
---

# List Client Alignments

`GET /v1/clients/alignment`

The current Red/Amber/Green alignment read for every client, as shown
in the Alignment column of the Commercial Intelligence report.

## Query parameters

- `week` string, nullable — Resolve reads as of this week (YYYY-MM-DD, typically a Monday). Reads filed for later weeks are ignored. Defaults to the latest read.
- `include_archived` boolean
- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- AlignmentListResponse — Response model for the client alignment list.
  - `clients` ClientAlignment[], required
    - `clientId` string, required
    - `clientName` string, nullable
    - `externalClientId` string, nullable — Customer-assigned client ID (extraColumns['Client ID']), when present
    - `knownwellScore` integer, nullable
    - `scoreSource` string, nullable — Score data source: chr1 or chr2
    - `alignment` AlignmentRead — A Red/Amber/Green alignment read filed on a client.
      - `value` string, required — The alignment read: red, amber, or green
      - `week` string, required — Monday (YYYY-MM-DD) of the week the read was filed for
      - `updatedAt` string, date-time, nullable — When the read was last edited
      - `updatedBy` string, nullable — Name of the user who filed the read
  - `total` integer, required
  - `week` string, nullable — As-of week the reads were resolved against; null when the latest reads were returned
  - `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)