Actions7
- Agent Actions
- Group Actions
- Action Actions
Group → Group Agents
AI-generatedOverview
This node operation retrieves a list of agents associated with a specified group from the Xcellerate.app API. It is useful for scenarios where you need to manage or analyze agents within a particular group, such as in customer support, sales teams, or any organizational unit that uses groups to categorize agents.
Use Case Examples
- Fetch all agents in a customer support group to monitor their activity.
- Retrieve a limited number of agents from a sales team group for reporting purposes.
Properties
| Name | Meaning |
|---|---|
| Group ID | The unique identifier of the group whose agents are to be listed. |
| Return All | Determines whether to return all agents or limit the number of results. |
| Limit | The maximum number of agents to return when 'Return All' is false. |
| Query | A search string to filter the agents within the group. |
Output
JSON
agents- An array of agent objects belonging to the specified group.totalCount- The total number of agents found matching the query and group criteria.
Dependencies
- Xcellerate.app API access with appropriate credentials
Troubleshooting
- Ensure the Group ID is valid and exists in the Xcellerate.app system to avoid errors.
- If no agents are returned, verify the query string and group membership.
- Check API credentials and permissions if authentication errors occur.
Links
- Xcellerate.app API Documentation - Group Agents - Official documentation for the Group Agents endpoint of the Xcellerate.app API.