Member Groups Tools

List Groups

Lists existing member groups.
published

List Member Groups

Allows the agent to query existing member groups in the workspace.


When to enable this tool

Use this tool when the agent needs to view or verify existing groups — for example, before adding members to a group or to answer questions about the workspace's organization.

Practical examples:

  • "What member groups exist in the workspace?"
  • "Who is part of the Legal Team?"
  • Check a group's ID before assigning it in a permission

What the agent can do

  • List all workspace groups
  • Filter groups by name or status
  • See how many people each group has
  • View the complete member list of each group (when requested)

Information the agent uses

InformationDescription
NameOptional: filter groups by name
StatusOptional: show only active, inactive, or blocked groups
Include membersOptional: return the list of who is in each group

Important notes

  • Returns a maximum of 100 groups per query
  • Inactive or blocked groups appear in results unless filtered by status
  • Requesting the member list of each group (include members) can make the response longer in large workspaces