API Reference

Plan Clients At Risk

get
https://api.scalepad.com/lifecycle-manager/v2/goals/summary

Retrieve account- or client-scoped clients flagged as at risk from goal health (severity from the worst goal status present), most severe first, each with a severity and a short reason.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^(eq):.+$

Optional encoded client identifier. When omitted, the list is calculated for the authenticated account.

string
^(eq|in):.+$

Narrows clients at risk to clients assigned to any supplied user. Use eq: for one user or in: for multiple users.

string
^(eq|gt|gte|lt|lte):.+$

Optional creation-date window. Repeat the parameter to bound each side with the
standardized operators: gte: for the inclusive lower bound and lte:
for the inclusive upper bound, each an ISO 8601 UTC instant. Accepted for a uniform
filter contract; clients-at-risk is goal-health based and is not narrowed by the
date range (only the client scope applies).

Responses

Updated 17 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago

Did this page help you?