Agent Action

List agent actions.

This will list agent action statuses.

  • Requires the action agent:ListActionStatus on the organization
get/api/v1/org/{orgUID}/agent_action_status

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/agent_action_status
  • Auth: HTTP bearer

Path parameters

orgUIDstring required

Organization UID

Query parameters

action_taken_bystring

Filter actions by the principal that created the action or the agent that executed the action

action_type_equalsstring

Return actions with a type equal to this value.

action_uid_equalsstring

The auto-generated uid for the action

agent_uid_equalsstring

Return actions for this agent

analytic_uid_equalsstring

Analytic UID -- the uid that starts with 'action:'

object_uid_equalsstring[]

Filter actions by one or more object UIDs

pageinteger

Page number to return

page_sizeinteger

Number of results to return (10 by default). If you specify -1, all results are returned

reason_containsstring

Filter actions by the reason

reason_equalsstring

Filter actions by the reason

result_code_equalsinteger

Return actions with a result code equal to this value

result_code_not_equalsinteger

Return actions with a result code not equal to this value

reversedboolean

Sort in descending order

sort_bystring

Sort by field. Valid values are 'state', 'resultcode', 'completed', 'validfrom', and 'validto'

state_equalsstring

Return actions with a state equal to this value. Valid values are 'queued', 'delivered', 'expired', and 'completed'

state_not_equalsstring

Return actions with a state not equal to this value. Valid values are 'queued', 'delivered', 'expired', and 'completed'

Response

OK

search_totalinteger

The total number of items

total_pagesinteger

The total number of pages

Changes

No recorded changes to this operation across all 1 revision of this API.