clients

Get Client

get/v1/clients/{client_id}

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/get.ts
A function with typed inputs. Its response is checked against the schema.

client_idstring required

Successful Response

idstring required

customerIdstring required

namestring required

scoreinteger required

scoreSourcestring nullable

Score data source: chr1 or chr2

lastContactDatestring date-time nullable

lastUpdatedAtstring date-time nullable

hasInsufficientDataboolean nullable

extraColumnsobject nullable

Custom column values

historicalDatainteger[] nullable

archivedboolean nullable

spotlightSummarystring nullable

AI-generated markdown summary of client status for the current week

topicsobject[] nullable

Topic and category scores organized by category

Aug 31, 202688246c119184 Revision changes
- info
  added the optional property to the response with the status