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 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-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 community group belongs to.

string

Display value for Business.Name..

integer

ID of the user account that administers this group; the administrator can always view and post in it.

string

Required display name of the community group.

string

Optional description of the community group’s purpose shown to customers.

integer

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. See eCommunityThreadVisibility enum values: 1 = Restricted, 2 = Public, 3 = Private.

integer[]

List of user IDs whose customers are group members; they can post in Restricted groups and view and post in Private groups, while the administrator always has access.

string

Internal GUID linking this automatically maintained group to its Team; change Team.HasCommunityGroup instead.

string

Internal GUID linking this automatically maintained group to its Course; change Course.HasCommunityGroup instead.

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