API Reference

List Clients

get
https://api.scalepad.com/lifecycle-manager/v1/clients

Get paginated client summary by query parameter

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params

Free-text search applied to the client display name.

string
^(eq|in):.+$

Narrows the list to clients assigned to any of the supplied users. Use eq: for one user or in: for multiple users.

string
^(eq):.+$

Filter clients by segment identifier. Use the eq: operator and repeat the parameter for multiple segments.

string
^(eq):.+$

Filter clients by client access group identifier. Use the eq: operator and repeat the parameter for multiple groups.

filter[vertical_id]
array of strings

Filter clients by vertical identifier. Use the eq: operator and repeat the parameter for multiple verticals.

filter[vertical_id]
filter[last_assessment_score]
array of strings

Filter clients by last-assessment score percentage. Use eq: for an exact value, or repeat gte: and lte: bounds.

filter[last_assessment_score]
filter[last_assessment_days_ago]
array of strings

Filter clients by the number of days since their last assessment. Use eq: for an exact value, or repeat gte: and lte: bounds.

filter[last_assessment_days_ago]
filter[upcoming_meeting_days]
array of strings

Filter clients by the number of days until their next meeting. Use eq: for an exact value, or repeat gte: and lte: bounds.

filter[upcoming_meeting_days]
filter[last_meeting_starts_at]
array of strings

Filter clients by the date of their most recent past meeting. Use eq: for an exact yyyy-MM-dd value, or repeat gte: and lte: bounds.

filter[last_meeting_starts_at]
string
^(eq):.+$

Filter clients by assigned license. Use the eq: operator. Available values: lmx and pro.

string
^[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

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

int32

The number of records to be returned in a single page

string

Opaque cursor of the page to return. Omit this value for the first
page, then pass the next_cursor value from the previous response.

  • Cursor pagination cannot guarantee atomicity.
  • Endpoints may skip new records inserted between paginated reads.
  • Endpoints may occasionally return duplicate records.
Responses

Updated 3 months 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 3 months ago

Did this page help you?