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

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

A **CommunityThread** represents a conversation posted to the Discussion Board. Discussion boards are a community feature that allows customers to communicate on the Members Portal — they can start, follow, like, and reply to conversations, mention other customers, and receive notifications about new messages.

Conversations can be assigned to a group (`CommunityGroupId`) to control who can see and contribute. Conversations not linked to any group are visible to all customers with access to the Discussion Boards page.

Use `Tags` to help customers find relevant conversations. Set `Private` to `true` to limit visibility to only the customers explicitly mentioned in the message. Enable `InstantDelivery` to push notifications to followers immediately rather than waiting for the daily digest.

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

## 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="CommunityThread_Business" type="integer">
  Filter by iD of the location this conversation belongs to.
</ParamField>

<ParamField query="CommunityThread_CommunityGroup" type="integer">
  Filter by iD of the group this conversation is assigned to; the group's access level (Public, Restricted, or Private) determines who can see and contribute to it.
</ParamField>

<ParamField query="CommunityThread_User" type="integer">
  Filter by iD of the user account that posted this conversation.
</ParamField>

<ParamField query="CommunityThread_Coworker" type="integer">
  Filter by iD of the customer profile that posted this conversation.
</ParamField>

<ParamField query="CommunityThread_Subject" type="string">
  Filter by title or topic of the conversation.
</ParamField>

<ParamField query="CommunityThread_Message" type="string">
  Filter by body text of the opening message in this conversation.
</ParamField>

<ParamField query="CommunityThread_InstantDelivery" type="boolean">
  Filter by when true, sends notifications to followers immediately after posting instead of waiting for the daily digest.
</ParamField>

<ParamField query="CommunityThread_Tags" type="string">
  Filter by comma-separated tags to help customers find this conversation.
</ParamField>

<ParamField query="CommunityThread_Private" type="boolean">
  Filter by when true, the conversation is visible only to customers explicitly mentioned in the message.
</ParamField>

<ParamField query="CommunityThread_LastMessageDate" type="string">
  Filter by date and time of the most recent reply in this conversation.
</ParamField>

<ParamField query="CommunityThread_IncludeZoomInvite" type="boolean">
  Filter by when true, attaches a Zoom meeting invite to this conversation.
</ParamField>

<ParamField query="CommunityThread_ZoomEventData" type="string">
  Filter by jSON payload containing Zoom meeting details attached to this conversation.
</ParamField>

### Range Filters

<ParamField query="from_CommunityThread_LastMessageDate" type="string">
  Filter by date and time of the most recent reply in this conversation greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CommunityThread_LastMessageDate" type="string">
  Filter by date and time of the most recent reply in this conversation less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

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

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

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

<ParamField query="to_CommunityThread_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/communitythreads?page=1&size=15&orderBy=Subject&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Subject',
      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/communitythreads',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Subject',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by Subject

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/community/communitythreads?' + new URLSearchParams({
      CommunityThread_Subject: 'example-value',
      orderBy: 'Subject',
      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/communitythreads',
      params={
          'CommunityThread_Subject': 'example-value',
          'orderBy': 'Subject',
          '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/communitythreads?from_CommunityThread_UpdatedOn=2025-01-01T00:00&to_CommunityThread_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/communitythreads?' + new URLSearchParams({
      from_CommunityThread_UpdatedOn: '2025-01-01T00:00',
      to_CommunityThread_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/communitythreads',
      params={
          'from_CommunityThread_UpdatedOn': '2025-01-01T00:00',
          'to_CommunityThread_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="CommunityThread[]">
  The list of CommunityThread records matching the query. See the [Get one CommunityThread](/rest-api/community/get-communitythreads-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 CommunityThread. The following fields are **not populated** in the `Records[]` response: `Message`, `InstantDelivery`, `IncludeZoomInvite`.

  To get all fields, fetch the full record using the [Get one CommunityThread](/rest-api/community/get-communitythreads-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,
      "CommunityGroupId": null,
      "UserId": 0,
      "CoworkerId": null,
      "Subject": "",
      "Tags": null,
      "Private": false,
      "Guests": [],
      "LastMessageDate": null,
      "ZoomEventData": 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": "CommunityThread Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Subject",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```