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
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
^(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]=1,2,3,4

filter[period.half]=eq:1,2,3,4

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]=1,2,3,4

filter[period.quarter]=eq:1,2,3,4

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

Available values: period.half, period.quarter, period.year, title

int32
string
Responses

Updated about 2 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 about 2 months ago

Did this page help you?