Skip to main content
GET
/
api
/
support
/
helpdeskmessages
/
{id}
{
  "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>"
}

​
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
Business Id.
​
CoworkerId
integer
Coworker Id.
​
CoworkerFullName
string
Coworker Full Name.
​
HelpDeskDepartmentId
integer
Help Desk Department Id.
​
HelpDeskDepartmentName
string
Help Desk Department Name.
​
Subject
string
Subject.
​
MessageText
string
Message Text.
​
Priority
integer
Priority.
​
AiProcessingResult
integer
Ai Processing Result.
​
Closed
boolean
Closed.
​
ClosedOn
string
Closed On.
​
OwnerId
integer
Owner Id.
​
OwnerFullName
string
Owner Full Name.
​
ImageFileName
string
Image File Name.
​
NewImageUrl
string
New Image Url.
​
ClearImageFile
boolean
Clear Image File.
​
FirstResponseTimeInMinutes
integer
First Response Time In Minutes.
​
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
}