Skip to content

List action groups

Tool name: list_action_groups

Returns action groups. An action group is a set of recommended actions for one customer, such as an email to send or a call to make, raised from a signal, a meeting, a support ticket or an automation, with the background that explains why. Each comes with how many actions it has; use get_action_group for the actions themselves. Give a customer for its groups, or leave it out for groups across the member’s customers. Each group names the agent that created it; give agentId for the groups of one agent only.

Input schema

customerstring, non-empty

Only action groups for this customer, by name or ID

scopestring

Ignored when a customer is given. mine: customers the member is assigned to. team: customers the member or their team is assigned to. all: every customer the member can see

Default:"mine"
Enum:"mine""team""all"
statusstring

Only groups with an action in this state. todo means not yet completed or dismissed

Enum:"todo""completed""dismissed"
dismissalSourcestring

Only groups with an action dismissed by a member, or automatically by Hook (system)

Enum:"member""system"
agentIdinteger, [ -9007199254740991 .. 9007199254740991 ]

Only groups created by this agent, by its ID from get_organization_context

limitinteger, [ 1 .. 25 ]

How many to return, up to 25. Ask for more only if the first results were not enough

Default:10
offsetinteger, [ 0 .. 9007199254740991 ]

How many to skip from the start of the list. To continue a list, give how many have been returned so far

Default:0
Input example
{ "customer": "string", "scope": "mine", "status": "todo", "dismissalSource": "member", "agentId": -9007199254740991, "limit": 10, "offset": 0 }