alignment

List Client Alignments

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

get/v1/clients/alignment

Request

Base URL
https://api.knownwell.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/knownwell/apis/knownwell-api/docs/v1/clients/alignment/get.ts
A function with typed inputs. Its response is checked against the schema.

weekstring 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_archivedboolean

limitinteger

offsetinteger

Successful Response

totalinteger required

weekstring nullable

As-of week the reads were resolved against; null when the latest reads were returned

customerIdstring required

No recorded changes to this operation across all 2 revisions of this API.