alignment

Get Client Alignment

The current Red/Amber/Green alignment read for a single client.

get/v1/clients/{client_id}/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/:client_id/alignment/get.ts
A function with typed inputs. Its response is checked against the schema.

client_idstring required

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.

Successful Response

clientIdstring required

clientNamestring nullable

externalClientIdstring nullable

Customer-assigned client ID (extraColumns['Client ID']), when present

weekstring nullable

As-of week the read was resolved against; null when the latest read was returned

customerIdstring required

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