Returns a paginated list of groups with member count.
Requires the GROUPMANAGEMENT security role.
Filter groups by matching name.
Filter by specific group IDs (hyphens in the UUIDs are optional).
Sort field and direction. Prefix with - for descending order (e.g. -name).
Allowed values:namedescription-name-description
Default:name
Page number (1-based).
Default:1
>= 1
Number of results per page.
Default:20
>= 1<= 1000
Successful response
Example:{"description":"Everyone in the marketing department","id":"0397e4bd-33fe-4b8f-a51d-4c2f1d9b6c1a","name":"Marketing","user_count":12}
Creates a new group.
Requires the GROUPMANAGEMENT security role.
Optional description of the group.
Name of the group. Must be unique within the account. Must be a string (numbers are not coerced).
Group created successfully.
Number of members in the group.
Deletes a group and removes all its members from it.
Requires the GROUPMANAGEMENT security role.
ID of the group to delete (hyphens optional).
Group deleted successfully. No content is returned.
Returns a single group by its ID, including member count.
Requires the GROUPMANAGEMENT security role.
ID of the group (hyphens optional).
Successful response
Number of members in the group.
Updates the name and/or description of an existing group.
At least one field must be provided. Only the fields included in the request body are updated
(partial update semantics).
Requires the GROUPMANAGEMENT security role.
ID of the group to update (hyphens optional).
New description for the group. Pass null to clear it.
New name for the group. Must be unique within the account.
Group updated successfully.
Number of members in the group.