Search CommunityThreads - Nexudus Platform

GET

api

community

communitythreads

Search CommunityThreads

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

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.

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CommunityThread_Business

integer

Filter by iD of the location this conversation belongs to.

CommunityThread_CommunityGroup

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.

CommunityThread_User

integer

Filter by iD of the user account that posted this conversation.

CommunityThread_Coworker

integer

Filter by iD of the customer profile that posted this conversation.

CommunityThread_Subject

string

Filter by title or topic of the conversation.

CommunityThread_Message

string

Filter by body text of the opening message in this conversation.

CommunityThread_InstantDelivery

boolean

Filter by when true, sends notifications to followers immediately after posting instead of waiting for the daily digest.

CommunityThread_Tags

string

Filter by comma-separated tags to help customers find this conversation.

CommunityThread_Private

boolean

Filter by when true, the conversation is visible only to customers explicitly mentioned in the message.

CommunityThread_LastMessageDate

string

Filter by date and time of the most recent reply in this conversation.

CommunityThread_IncludeZoomInvite

boolean

Filter by when true, attaches a Zoom meeting invite to this conversation.

CommunityThread_ZoomEventData

string

Filter by jSON payload containing Zoom meeting details attached to this conversation.

Range Filters

from_CommunityThread_LastMessageDate

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.

to_CommunityThread_LastMessageDate

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.

from_CommunityThread_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CommunityThread_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CommunityThread_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CommunityThread_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/community/communitythreads?page=1&size=15&orderBy=Subject&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Subject

curl -X GET \
  "https://spaces.nexudus.com/api/community/communitythreads?CommunityThread_Subject=example-value&orderBy=Subject&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

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"

Response

200

Records

CommunityThread[]

The list of CommunityThread records matching the query. See the Get one CommunityThread endpoint for the full list of properties returned for each record.

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

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

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

Get one CommunityThreadRetrieve a single CommunityThread record by its Id.

Search CommunityThreads

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Subject

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Subject

Range filters

Response

200