clients
Get Clients By Risk
Changed onget/v1/clients/by-risk/{risk_level}
Request
- Base URLhttps://api.knownwell.com (the document declares no server; this is the origin it was published from)
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
risk_level'high_risk' | 'medium_risk' | 'low_risk' | 'on_track' required
Query parameters
include_archivedboolean
limitinteger
offsetinteger
portfolio_idstring nullable
Scope results to a portfolio. Pass an id from GET /portfolios; omit it (or pass 'all-clients') for no scoping. An unknown, malformed or inaccessible id returns 404 rather than all clients. The camelCase spelling 'portfolioId' is accepted as an alias.
Response
Successful Response
unknown required
Changes
- info
added the new optional
queryrequest parameterportfolio_id
- info