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

# Search CommunityGroups

> Search and list CommunityGroup records with filtering, sorting, and pagination.

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-List`** role.
</Note>

## Enums

<Accordion title="eCommunityThreadVisibility — GroupAccess values">
  | Value | Name       |
  | ----- | ---------- |
  | 1     | Restricted |
  | 2     | Public     |
  | 3     | Private    |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="CommunityGroup_Business" type="integer">
  Filter by iD of the location this group belongs to.
</ParamField>

<ParamField query="CommunityGroup_Business_Name" type="string">
  Filter by location name.
</ParamField>

<ParamField query="CommunityGroup_User" type="integer">
  Filter by iD of the user account designated as the group administrator.
</ParamField>

<ParamField query="CommunityGroup_Name" type="string">
  Filter by display name of the group.
</ParamField>

<ParamField query="CommunityGroup_Description" type="string">
  Filter by short description of the group's purpose shown to customers.
</ParamField>

<ParamField query="CommunityGroup_GroupAccess" type="integer">
  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.
</ParamField>

<ParamField query="CommunityGroup_TeamGuid" type="string">
  Filter by gUID of the Team this group was created for. Set when the group was auto-generated because `Team.HasCommunityGroup` is true.
</ParamField>

<ParamField query="CommunityGroup_CourseGuid" type="string">
  Filter by gUID of the Course this group was created for. Set when the group was auto-generated because `Course.HasCommunityGroup` is true.
</ParamField>

### Range Filters

<ParamField query="from_CommunityGroup_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CommunityGroup_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CommunityGroup_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CommunityGroup_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitygroups',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups?CommunityGroup_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups?' + new URLSearchParams({
      CommunityGroup_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitygroups',
      params={
          'CommunityGroup_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/community/communitygroups?from_CommunityGroup_UpdatedOn=2025-01-01T00:00&to_CommunityGroup_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitygroups?' + new URLSearchParams({
      from_CommunityGroup_UpdatedOn: '2025-01-01T00:00',
      to_CommunityGroup_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/community/communitygroups',
      params={
          'from_CommunityGroup_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityGroup_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="Records" type="CommunityGroup[]">
  The list of CommunityGroup records matching the query. See the [Get one CommunityGroup](/rest-api/community/get-communitygroups-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CommunityGroup. The following fields are **not populated** in the `Records[]` response: `Description`.

  To get all fields, fetch the full record using the [Get one CommunityGroup](/rest-api/community/get-communitygroups-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "UserId": 0,
      "Name": "",
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```