Sign in

v1

latestOpenAPI 3.1.02026-08-04272636.0 KB
alignment

Get Client Alignment

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

get/v1/clients/{client_id}/alignment

Path parameters

client_idstring required

Query parameters

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.

Resolve reads as of this week (YYYY-MM-DD, typically a Monday). Reads filed for later weeks are ignored. Defaults to the latest read.

Response

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