CommunityGroups
Search CommunityGroups
Search and list CommunityGroup records with filtering, sorting, and pagination.
GET
Search CommunityGroups
A community group is a named customer group that controls who can view and post in Discussion Board conversations assigned to it.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CommunityGroup-List role.Enums
eCommunityThreadVisibility — GroupAccess values
eCommunityThreadVisibility — GroupAccess values
Query Parameters
Pagination & Sorting
Filters
Filter by iD of the user account that administers this group; the administrator can always view and post in it.
Filter by access level for conversations assigned to this group: Restricted (1) lets all customers view but only the administrator and members post; Public (2) lets all customers view and post; Private (3) lets only the administrator and members view and post.
Filter by internal GUID linking this automatically maintained group to its Team; change Team.HasCommunityGroup instead.
Filter by internal GUID linking this automatically maintained group to its Course; change Course.HasCommunityGroup instead.
Range Filters
Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of CommunityGroup records matching the query. See the Get one CommunityGroup endpoint for the full list of properties returned for each record.
Example Response