Retrieve Outcome Goals

get

https://example.com/outcomes_goals/

Returns a list of Outcome Goals applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

area

integer

Filter via area ID. Must supply integer value, cannot search by Outcomes Area name or other field information.

required

boolean

Filter via required boolean value, accepts true or false. Determines whether or not an Outcome Goal is required.

custom

boolean

Filter via custom boolean value, accepts true or false. Determines whether or not an Outcome Goal is a non-standard custom Goal.

disabled

boolean

Filter via disabled boolean value, accepts true or false. Determines whether or not an Outcome Goal is enabled to be used by Agents.

order_by

string

Order results by a field name. Prefix with - for descending order. eg. order_by=mod_date for ascending or order_by=-mod_date for descending. Must be a valid field on the resource; an invalid field returns a 400 error.

Response

200returns a list of outcome goals