List Clients Compliance Health Metrics

get

https://api.scalepad.com/controlmap/v1/clients/health

Returns compliance health metrics for each client of an MSP. By default, returns a paginated list of clients and their overall compliance health. Use fields to include additional health metrics like compliance_score, risk_score, frameworks, work_progress, and history.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter[client.id]

string

Filters records by using a query string on the field client.id.

Supports comparison operators: eq, in.

Query examples:

filter[client.id]=example_value — exact match
filter[client.id]=eq:example_value — exact match
filter[client.id]=in:example_value_1,example_value_2,example_value_3 — any match in list

Example :

365bcf1e-a26b-4abc-ad9a-8607e2f43910
eq:365bcf1e-a26b-4abc-ad9a-8607e2f43910

filter[client.tenant_id]

string

Filters records by using a query string on the field client.tenant_id.

Supports comparison operators: eq, in.

Query examples:

filter[client.tenant_id]=example_value — exact match
filter[client.tenant_id]=eq:example_value — exact match
filter[client.tenant_id]=in:example_value_1,example_value_2,example_value_3 — any match in list

Example : eq:example_value

filter[client.name]

string

Filters records by using a query string on the field client.name.

Supports comparison operators: eq, in.

Query examples:

filter[client.name]=example_value — exact match
filter[client.name]=eq:example_value — exact match
filter[client.name]=in:example_value_1,example_value_2,example_value_3 — any match in list

Example : eq:example_value

fields

array of strings

Comma-separated components: compliance_score, risk_score, frameworks, work_progress

fields

page_size

integer

1 to 200

Defaults to 50

Clients per page (default 50, max 200)

cursor

string

Opaque pagination cursor (Base64)

sort

string

One or more sortable fields, separated by commas. Prefix with + for ascending or - for descending.

Available values: client.name, client.tenant_id, client.id

Responses

200OK

400Bad Request — Invalid input or business rule violation.

401Unauthorized - Authentication required

404Not Found — Requested resource does not exist.

500Internal server error