HelpDeskComments
Search HelpDeskComments
Search and list HelpDeskComment records with filtering, sorting, and pagination.
GET
Search HelpDeskComments
A HelpDeskComment is a customer or staff reply, including internal notes, on a support ticket; creating one reopens the ticket and follows its notification rules.
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 HelpDeskComment-List role.Query Parameters
Pagination & Sorting
Filters
Filter by iD of the support ticket this reply or note belongs to; it determines the owning location and a new comment reopens the ticket..
Filter by iD of the customer or staff member who authored this comment; the author determines the notification path..
Range Filters
Code Examples
Simple listing
Filtering by MessageText
Range filters
Response
200
The list of HelpDeskComment records matching the query. See the Get one HelpDeskComment endpoint for the full list of properties returned for each record.
Example Response