Help Desk
List Help Desk Comments
Returns the comments on a help desk message thread.
GET
List Help Desk Comments
Returns all comments on a specific help desk message thread. Used to render the conversation history on the ticket detail page.Authentication
Requires a valid customer bearer token.Path Parameters
Numeric identifier of the help desk message.
Query Parameters
Comma-separated list of field paths to include in the response. When provided, only the
specified fields are returned — useful for reducing payload size. Supports nested paths
using dot notation. Example:
_shape=Records.MessageText,Records.CoworkerId,Records.CreatedOn.Response
Returns anApiListResult<HelpDeskComment> with the comment records.
The top-level response includes standard pagination fields (CurrentPage, TotalItems, TotalPages, etc.). Each item in the Records array has:
Identity
| Field | Type | Description |
|---|---|---|
Id | number | Unique identifier for the comment |
UniqueId | string | GUID identifier |
Content
| Field | Type | Description |
|---|---|---|
MessageText | string | Comment text content |
IsAiGenerated | boolean | Whether the comment was generated by AI |
Author
| Field | Type | Description |
|---|---|---|
Coworker | Coworker | Coworker who posted the comment (nested) |
CoworkerId | number | Coworker identifier |
Media
| Field | Type | Description |
|---|---|---|
HasImage | boolean | Whether the comment has an attached image |
ImageFileName | string | Filename of the attached image |
Timestamps (from base)
| Field | Type | Description |
|---|---|---|
CreatedOn | string | Record creation timestamp (local) |
UpdatedOn | string | Record last-update timestamp (local) |
CreatedOnUtc | string | Record creation timestamp (UTC) |
UpdatedOnUtc | string | Record last-update timestamp (UTC) |