Retrieve Case Outcome Areas

get

https://example.com/outcomes_case_areas/

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

outcomes_case

integer

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

area

integer

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

disabled

boolean

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

completed_count_gte

integer

Filter via completed count. Returns all Outcomes Case Areas with a completed count greater than the supplied value.

completed_count_lte

integer

Filter via completed count. Returns all Outcomes Case Areas with a completed count less than the supplied value.

pending_count_gte

integer

Filter via pending count. Returns all Outcomes Case Areas with a pending count greater than the supplied value.

pending_count_lte

integer

Filter via pending count. Returns all Outcomes Case Areas with a pending count less than the supplied value.

goal_count_gte

integer

Filter via goal count. Returns all Outcomes Case Areas with a goal count greater than the supplied value.

goal_count_lte

integer

Filter via goal count. Returns all Outcomes Case Areas with a goal count less than the supplied value.

percent_complete_gte

integer

Filter via percentage complete. Returns all Outcomes Case Areas with a percentage complete greater than the supplied value.

percent_complete_lte

integer

Filter via percentage complete. Returns all Outcomes Case Areas with a percentage complete less than the supplied value.

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

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200returns a list of case outcome areas