Skip to main content
GET
/
api
/
community
/
communitygroups
/
{id}
Get one CommunityGroup
curl --request GET \
  --url https://spaces.nexudus.com/api/community/communitygroups/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "UserId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "GroupAccess": 123,
  "Members": [
    123
  ],
  "TeamGuid": "<string>",
  "CourseGuid": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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 CommunityThread conversations to restrict or open participation. Each group has an access level (GroupAccess) that determines visibility:
ValueMeaning
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
Groups can also be auto-generated by the system: if a 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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the CommunityGroup record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/community/communitygroups/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
ID of the location this group belongs to.
​
BusinessName
string
Location name.
​
UserId
integer
ID of the user account designated as the group administrator.
​
Name
string
Display name of the group.
​
Description
string
Short description of the group’s purpose shown to customers.
​
GroupAccess
integer
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. See eCommunityThreadVisibility enum values: 1 = Restricted, 2 = Public, 3 = Private.
​
Members
integer[]
IDs of customers who are members of this group.
​
TeamGuid
string
GUID of the Team this group was created for. Set when the group was auto-generated because Team.HasCommunityGroup is true.
​
CourseGuid
string
GUID of the Course this group was created for. Set when the group was auto-generated because Course.HasCommunityGroup is true.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "BusinessName": null,
  "UserId": 0,
  "Name": "",
  "Description": null,
  "GroupAccess": 0,
  "Members": [],
  "TeamGuid": null,
  "CourseGuid": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CommunityGroup Example",
  "LocalizationDetails": null,
  "CustomFields": null
}