Skip to main content
GET
/
api
/
community
/
communitythreadfiles
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
A CommunityThreadFile is a file or image attached to a CommunityThread conversation on the Discussion Board. When starting a conversation, customers can optionally include a picture or file alongside the opening message.

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 CommunityThreadFile-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. 1 for ascending, -1 for descending.

Filters

CommunityThreadFile_CommunityThread
integer
Filter by iD of the conversation this file is attached to.
CommunityThreadFile_Name
string
Filter by display name of the attached file.
CommunityThreadFile_Description
string
Filter by optional description of the attached file.
CommunityThreadFile_FileDataFileName
string
Filter by stored filename of the uploaded file.
CommunityThreadFile_NewFileDataUrl
string
Filter by uRL of a new file to upload and attach to this record.
CommunityThreadFile_ClearFileData
boolean
Filter by when true, removes the currently attached file.

Range Filters

from_CommunityThreadFile_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
to_CommunityThreadFile_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
from_CommunityThreadFile_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
to_CommunityThreadFile_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/communitythreadfiles?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/community/communitythreadfiles?CommunityThreadFile_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/community/communitythreadfiles?from_CommunityThreadFile_UpdatedOn=2025-01-01T00:00&to_CommunityThreadFile_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records
CommunityThreadFile[]
The list of CommunityThreadFile records matching the query. See the Get one CommunityThreadFile endpoint for the full list of properties returned for each record.
CurrentPage
integer
Current page number.
CurrentPageSize
integer
Number of records per page.
CurrentOrderField
string
The field used for sorting.
CurrentSortDirection
integer
The sort direction (1 = 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": [
    {
      "CommunityThreadId": 0,
      "Name": null,
      "Description": null,
      "FileDataFileName": null,
      "NewFileDataUrl": null,
      "ClearFileDataFile": 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": "CommunityThreadFile Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}