CommunityGroups
Search CommunityGroups
Search and list CommunityGroup records with filtering, sorting, and pagination.
GET
A CommunityGroup is a named subset of customers used to control who can see and contribute to conversations on the Discussion Board. Groups are created by admins and can be assigned to
Groups can also be auto-generated by the system: if a
CommunityThread conversations to restrict or open participation.
Each group has an access level (GroupAccess) that determines visibility:
| Value | Meaning |
|---|---|
Restricted (1) | All customers can see the group’s conversations but only members can post |
Public (2) | Any customer with access to Discussion Boards can see and post |
Private (3) | Only group members can see or post in the group’s conversations |
Team has HasCommunityGroup = true, a group is created and its GUID stored in TeamGuid; if a Course has HasCommunityGroup = true, a group is created and its GUID stored in CourseGuid.
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
| Value | Name |
|---|---|
| 1 | Restricted |
| 2 | Public |
| 3 | Private |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by iD of the location this group belongs to.
Filter by location name.
Filter by iD of the user account designated as the group administrator.
Filter by display name of the group.
Filter by short description of the group’s purpose shown to customers.
Filter by access level controlling who can see and post in this group’s conversations: Restricted (1) = all customers can see but only members post; Public (2) = all customers can see and post; Private (3) = members only.
Filter by gUID of the Team this group was created for. Set when the group was auto-generated because
Team.HasCommunityGroup is true.Filter by gUID of the Course this group was created for. Set when the group was auto-generated because
Course.HasCommunityGroup is true.Range Filters
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.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.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response