Actions34
- Data Actions
- Group Actions
- Manager Actions
- Membership Actions
- Performance Actions
- Supplier Actions
- User Actions
- Utility Actions
Data → Get Groups
AI-generatedSummary
Get a list of groups or workspaces filtered by domain and optional criteria, with an option to return results as an array.
Inputs
- Domain (required) — The domain ID to scope the request (number).
- Return as Array — Boolean flag to choose if the results are returned as an array (default: true).
- Filters — Optional filters including group type such as Course, Group, Org Unit, Qualification, Role, Template, or Workplan.
Output shape
A JSON object representing the list of groups or workspaces returned by the API, optionally wrapped in an array based on the 'Return as Array' parameter.
The list can be filtered by type through the Filters collection. The domain parameter is required. The operation makes a POST request to '/WebServices/api_remote/groups' with body containing domain, optional filters, and the as_array flag as 1 or 0. Error handling is provided for HTTP and API-level errors.