Skip to main content
GET
/
api
/
public
/
helpdesk
/
messages

​
List Help Desk Messages

Returns a list of help desk messages (support tickets) belonging to the authenticated customer. By default returns only open tickets; set showClosed=true to include resolved tickets.

​
Authentication

Requires a valid customer bearer token.

​
Query Parameters

​
showClosed
boolean
required
true — include closed/resolved tickets. false — return only open tickets.
​
_shape
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=Records.Subject,Records.Closed,Records.CreatedOn.

​
Response

Returns a HelpDeskMessages object containing an array of support ticket records.

​
Help Desk Message Fields

​
Identity

FieldTypeDescription
IdnumberUnique numeric identifier for the message
UniqueIdstringGlobally unique identifier

​
Core

FieldTypeDescription
SubjectstringTicket subject line
MessageTextstringTicket body text
ClosedbooleanWhether the ticket is closed / resolved
HasImagebooleanWhether an image attachment exists

​
Nested Objects

FieldTypeDescription
DepartmentobjectHelp desk department (Id, Name, Description)
CoworkerobjectCustomer who opened the ticket (Id, FullName, etc.)
Commentsobject[]Array of reply comments on this ticket

​
Timestamps (from base)

FieldTypeDescription
CreatedOnstringDate created (business-local time)
UpdatedOnstring | nullDate last updated (business-local time)
CreatedOnUtcstringDate created (UTC)
UpdatedOnUtcstring | nullDate last updated (UTC)

​
Examples

​
Fetch open tickets

GET /api/public/helpdesk/messages?showClosed=false
Authorization: Bearer {token}

​
Fetch all tickets including closed

GET /api/public/helpdesk/messages?showClosed=true
Authorization: Bearer {token}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: messages } = useTypedData(httpClient, endpoints.helpDesk.list(false))