> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one CommunityGroup

> Retrieve a single CommunityGroup record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CommunityGroup record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

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

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the location this group belongs to.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="UserId" type="integer">
  ID of the user account designated as the group administrator.
</ResponseField>

<ResponseField name="Name" type="string">
  Display name of the group.
</ResponseField>

<ResponseField name="Description" type="string">
  Short description of the group's purpose shown to customers.
</ResponseField>

<ResponseField name="GroupAccess" type="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.
</ResponseField>

<ResponseField name="Members" type="integer[]">
  IDs of customers who are members of this group.
</ResponseField>

<ResponseField name="TeamGuid" type="string">
  GUID of the Team this group was created for. Set when the group was auto-generated because `Team.HasCommunityGroup` is true.
</ResponseField>

<ResponseField name="CourseGuid" type="string">
  GUID of the Course this group was created for. Set when the group was auto-generated because `Course.HasCommunityGroup` is true.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```
