Help Desk
Get Help Desk Message
Returns the full details of a single help desk message.
GET
Get Help Desk Message
Get Help Desk Message
Returns the complete details of a specific help desk message (support ticket), including status and associated metadata.Authentication
Requires a valid customer bearer token. The message must belong to the authenticated customer.Path Parameters
number
required
Numeric identifier of the help desk message. Returned as
Id from the message list.Query Parameters
string
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=Subject,MessageText,Closed,Comments.Response
Returns aHelpDeskMessage object.
number
required
Unique identifier for the message.
string
required
Subject line of the support ticket.
string
Full body text of the message.
boolean
true when the ticket has been closed.string
Creation timestamp in ISO 8601 format.
Examples
Fetch message details
TypeScript Integration
Get Help Desk Message