CommunityThreadFiles
Search CommunityThreadFiles
Search and list CommunityThreadFile records with filtering, sorting, and pagination.
GET
Search CommunityThreadFiles
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
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the conversation this file is attached to.
Filter by display name of the attached file.
Filter by optional description of the attached file.
Filter by stored filename of the uploaded file.
Filter by uRL of a new file to upload and attach to this record.
Filter by when true, removes the currently attached file.
Range Filters
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
The list of CommunityThreadFile records matching the query. See the Get one CommunityThreadFile endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search CommunityThreadFiles