Get one CommunityGroup

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>'

import requests

url = "https://spaces.nexudus.com/api/community/communitygroups/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/community/communitygroups/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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:

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

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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/community/communitygroups/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/community/communitygroups/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location this group belongs to.

string

Location name.

integer

ID of the user account designated as the group administrator.

string

Display name of the group.

string

Short description of the group’s purpose shown to customers.

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.

integer[]

IDs of customers who are members of this group.

string

GUID of the Team this group was created for. Set when the group was auto-generated because Team.HasCommunityGroup is true.

string

GUID of the Course this group was created for. Set when the group was auto-generated because Course.HasCommunityGroup is true.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple CommunityGroupsRetrieve multiple CommunityGroup records by their Ids in a single request.

Get one CommunityGroup

curl --request GET \
  --url https://spaces.nexudus.com/api/community/communitygroups/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/community/communitygroups/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/community/communitygroups/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200