List Help Desk Messages

Returns the authenticated customer’s help desk messages, optionally including closed tickets.

GET /api/public/helpdesk/messages

List Help Desk Messages

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/public/helpdesk/messages \
  --header 'Authorization: Basic <encoded-value>'

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

Field	Type	Description
Id	number	Unique numeric identifier for the message
UniqueId	string	Globally unique identifier

Core

Field	Type	Description
Subject	string	Ticket subject line
MessageText	string	Ticket body text
Closed	boolean	Whether the ticket is closed / resolved
HasImage	boolean	Whether an image attachment exists

Nested Objects

Field	Type	Description
Department	object	Help desk department (Id, Name, Description)
Coworker	object	Customer who opened the ticket (Id, FullName, etc.)
Comments	object[]	Array of reply comments on this ticket

Timestamps (from base)

Field	Type	Description
CreatedOn	string	Date created (business-local time)
UpdatedOn	string | null	Date last updated (business-local time)
CreatedOnUtc	string	Date created (UTC)
UpdatedOnUtc	string | null	Date 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))