Skip to main content
GET
List client health

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:25

Items per page

Required range: 1 <= x <= 100
companyId
string<uuid>

Filter to one company

riskLevel
enum<string>[]

Filter by risk level (repeat the key or comma-separate)

Available options:
thriving,
healthy,
at_risk,
critical

Search company name

Maximum string length: 200
sortBy
enum<string>
default:health_score

Sort column

Available options:
health_score,
service_quality_score,
engagement_score,
financial_score,
sales_score,
project_score,
tool_stack_score,
environment_score,
operational_score,
company_name,
risk_level
sortDir
enum<string>
default:asc
Available options:
asc,
desc

Response

Client health rows

data
object[]
required
pagination
object
required