Get Help Desk Message

Returns the full details of a single help desk message.

GET /api/public/helpdesk/messages/{messageId}

Get Help Desk Message

cURL

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

200

{
  "Id": 123,
  "Subject": "<string>",
  "MessageText": "<string>",
  "Closed": true,
  "CreatedOn": "<string>"
}

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

messageId · number · required

Numeric identifier of the help desk message. Returned as Id from the message list.

Query Parameters

_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=Subject,MessageText,Closed,Comments.

Response

Returns a HelpDeskMessage object.

Id · number · required

Unique identifier for the message.

Subject · string · required

Subject line of the support ticket.

MessageText · string

Full body text of the message.

Closed · boolean

true when the ticket has been closed.

CreatedOn · string

Creation timestamp in ISO 8601 format.

Examples

Fetch message details

GET /api/public/helpdesk/messages/501
Authorization: Bearer {token}

TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: message } = useTypedData(httpClient, endpoints.helpDesk.one(501))