API Reference

List Goals

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

List all goals to help you quickly find relevant objectives with filtering options.

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

When true, returns only archived goals. When omitted or false, returns only active goals.

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
^(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: AtRisk, Complete, OffTrack, OnHold, OnTrack.

string

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

string
^(eq):.+$

Filters records by using a query string on the field period.year.

Supports comparison operators eq.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.

Query examples:

filter[period.year]=123

filter[period.year]=eq:123

string
^(eq):.+$

Filters records by using a query string on the field period.half.

Supports comparison operators eq.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.

Query examples:

filter[period.half]=example_string

filter[period.half]=eq:example_string

string
^(eq):.+$

Filters records by using a query string on the field period.quarter.

Supports comparison operators eq.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.

Query examples:

filter[period.quarter]=example_string

filter[period.quarter]=eq:example_string

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: created_by, period.half, period.quarter, period.year, 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?