Skip to main content
GET
/
api
/
support
/
helpdeskmessages
/
{id}
Get one HelpDeskMessage
curl --request GET \
  --url https://spaces.nexudus.com/api/support/helpdeskmessages/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "HelpDeskDepartmentId": 123,
  "HelpDeskDepartmentName": "<string>",
  "Subject": "<string>",
  "MessageText": "<string>",
  "Priority": 123,
  "AiProcessingResult": 123,
  "Closed": true,
  "ClosedOn": "<string>",
  "OwnerId": 123,
  "OwnerFullName": "<string>",
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "FirstResponseTimeInMinutes": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A HelpDeskMessage represents a support ticket submitted by a customer or created by staff. Each message has a priority level, can be assigned to a department, and tracks its resolution status.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the HelpDeskMessage-Read role.

​
Path Parameters

​
id
integer
required
The Id of the HelpDeskMessage record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/support/helpdeskmessages/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
CoworkerId
integer
ID of the coworker linked to this record.
​
CoworkerFullName
string
Display name of the linked coworker full (read-only).
​
HelpDeskDepartmentId
integer
ID of the help desk department linked to this record.
​
HelpDeskDepartmentName
string
Display name of the linked help desk department (read-only).
​
Subject
string
The subject value for this help desk message.
​
MessageText
string
The message text value for this help desk message.
​
Priority
integer
The priority value for this help desk message. See eHelpDeskMessagePriority enum values: 1 = Low, 2 = Normal, 3 = High, 4 = Critical.
​
AiProcessingResult
integer
The ai processing result value for this help desk message. See eHelpDeskAiResult enum values: 1 = NotProcessed, 2 = Responded, 3 = NotResponded.
​
Closed
boolean
Whether closed is enabled.
​
ClosedOn
string
Date/time value for closed on.
​
OwnerId
integer
ID of the owner linked to this record.
​
OwnerFullName
string
Display name of the linked owner full (read-only).
​
ImageFileName
string
Current file name of the image (read-only; upload via the corresponding URL field).
​
NewImageUrl
string
URL of a new file to upload as the image.
​
ClearImageFile
boolean
Set to true to remove the current image file.
​
FirstResponseTimeInMinutes
integer
The first response time in minutes value for this help desk message.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "HelpDeskDepartmentId": null,
  "HelpDeskDepartmentName": null,
  "Subject": "",
  "MessageText": "",
  "Priority": 0,
  "AiProcessingResult": 0,
  "Closed": false,
  "ClosedOn": null,
  "OwnerId": null,
  "OwnerFullName": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "FirstResponseTimeInMinutes": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "HelpDeskMessage Example",
  "LocalizationDetails": null,
  "CustomFields": null
}