API Reference

List Assessments

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

Retrieve a comprehensive list of all assessments overview with filtering options.

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

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

Supports comparison operators eq, in.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • in — Matches any value in a comma-separated list.

Query examples:

filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283

filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283

filter[client.id]=in:0d3e7d0k-241a-461r-av15-758a90d70283,1a2b3c4d-5e6f-7a8b-9c0d-e1f2a3b4c5d6

string
^(eq|in):.+$

Filter assessments to clients assigned to the supplied account-team users. Uses eq: for one user or in: for multiple users.

string
^(cont|eq):.+$

Filters records by using a query string on the field title.

Supports comparison operators eq, cont.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • cont — Case-insensitive substring match (LIKE %value%). Use this for free-form search inputs; the supplied value is matched anywhere inside the field, and % / _ characters in the value are escaped so they do not act as wildcards.

Query examples:

filter[title]=example_string

filter[title]=eq:example_string

filter[title]=cont:exam

string
^(eq|in):.+$

Filters records by using a query string on the field status.

Supports comparison operators eq, in.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • in — Matches any value in a comma-separated list.

Query examples:

filter[status]=example_string

filter[status]=eq:example_string

filter[status]=in:example_string,another_string

Available values: Completed, InProgress.

string
^(eq|in):.+$

Filters records by using a query string on the field assessment_template_id.

Supports comparison operators eq, in.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • in — Matches any value in a comma-separated list.

Query examples:

filter[assessment_template_id]=example_string

filter[assessment_template_id]=eq:example_string

filter[assessment_template_id]=in:example_string,another_string

Free-text search matched against the assessment title and description.

string
^(eq|in):.+$

Filters records by using a query string on the field evaluate_user_id.

Supports comparison operators eq, in.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • in — Matches any value in a comma-separated list.

Query examples:

filter[evaluate_user_id]=0d3e7d0k-241a-461r-av15-758a90d70283

filter[evaluate_user_id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283

filter[evaluate_user_id]=in:0d3e7d0k-241a-461r-av15-758a90d70283,1a2b3c4d-5e6f-7a8b-9c0d-e1f2a3b4c5d6

string
^(eq|gte):.+$

Filters records by using a query string on the field score_min.

Supports comparison operators eq, gte.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • gte — Greater than or equal to the supplied value.

Query examples:

filter[score_min]=199.99

filter[score_min]=eq:199.99

filter[score_min]=gte:199.99

string
^(eq|lte):.+$

Filters records by using a query string on the field score_max.

Supports comparison operators eq, lte.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • lte — Less than or equal to the supplied value.

Query examples:

filter[score_max]=199.99

filter[score_max]=eq:199.99

filter[score_max]=lte:199.99

string
^(eq|gte):.+$

Filters records by using a query string on the field evaluated_at_from.

Supports comparison operators eq, gte.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • gte — Greater than or equal to the supplied value.

Query examples:

filter[evaluated_at_from]=2025-11-11T15:30:00Z

filter[evaluated_at_from]=eq:2025-11-11T15:30:00Z

filter[evaluated_at_from]=gte:2025-11-11T15:30:00Z

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

Filters records by using a query string on the field evaluated_at_to.

Supports comparison operators eq, lte, lt.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • lte — Less than or equal to the supplied value.
  • lt — Less than the supplied value.

Query examples:

filter[evaluated_at_to]=2025-11-11T15:30:00Z

filter[evaluated_at_to]=eq:2025-11-11T15:30:00Z

filter[evaluated_at_to]=lte:2025-11-11T15:30:00Z

filter[evaluated_at_to]=lt:2025-11-11T15:30:00Z

boolean

Whether to include child assessments for multi-site parent assessments

boolean

Whether to include current Core site data. Defaults to true for compatibility.

boolean

Whether to include category scores for each assessment

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

Strict upper bound for the assessment evaluation date, ISO-8601.

filter[client.segment_id]
array of strings

Narrows results to clients in any supplied segment. Repeat eq: for each segment, or use in: with a
comma-separated list. Use null:true to match clients with no segment; combined with ids it matches either.

filter[client.segment_id]
filter[client.vertical_id]
array of strings

Narrows results to clients in any supplied vertical. Repeat eq: for each vertical, or use in: with a
comma-separated list. Use null:true to match clients with no vertical; combined with ids it matches either.

filter[client.vertical_id]
filter[client.client_access_group_id]
array of strings

Narrows results to clients in any supplied client access group. Repeat eq: for each group, or use in: with
a comma-separated list. Use null:true to match clients with no access group; combined with ids it matches
either.

filter[client.client_access_group_id]
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.

Available fields: client.name, evaluated_at, score, title

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 5 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 5 months ago

Did this page help you?