Skip to main content
GET
Search CommunityThreads
A Discussion Board conversation is an opening message with replies that customers can follow; a community group or private guest list controls who can access 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 CommunityThread-List role.

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the location this Discussion Board conversation belongs to.
integer
Filter by optional ID of the community group that controls access to this conversation; its Public, Restricted, or Private access level applies in addition to this thread’s Private setting.
integer
Filter by iD of the user account that authors this conversation.
integer
Filter by optional ID of the customer profile displayed as the author; when omitted on creation, Nexudus uses the author’s matching customer profile at the location.
string
Filter by required title or topic of the Discussion Board conversation.
string
Filter by required body text of the opening message in this conversation.
boolean
Filter by whether to notify followers about this new conversation immediately instead of waiting for their scheduled digest.
string
Filter by comma-separated search tags that help customers find this conversation.
boolean
Filter by whether this conversation is visible only to its author and the users in Guests; a private community group also restricts visibility regardless of this setting.
string
Filter by read-only UTC date and time when this conversation or one of its replies was most recently posted.
boolean
Filter by whether to create a Zoom meeting and attach its invite when this conversation is created.
string
Filter by internal JSON payload containing Zoom meeting details generated and maintained by the Zoom integration.

Range Filters

string
Filter by read-only UTC date and time when this conversation or one of its replies was most recently posted greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by read-only UTC date and time when this conversation or one of its replies was most recently posted less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by Subject

Range filters

Response

200

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.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response