> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one HelpDeskMessage

> Retrieve a single HelpDeskMessage record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the HelpDeskMessage record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/support/helpdeskmessages/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/support/helpdeskmessages/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/support/helpdeskmessages/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the coworker linked to this record.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Display name of the linked coworker full (read-only).
</ResponseField>

<ResponseField name="HelpDeskDepartmentId" type="integer">
  ID of the help desk department linked to this record.
</ResponseField>

<ResponseField name="HelpDeskDepartmentName" type="string">
  Display name of the linked help desk department (read-only).
</ResponseField>

<ResponseField name="Subject" type="string">
  The subject value for this help desk message.
</ResponseField>

<ResponseField name="MessageText" type="string">
  The message text value for this help desk message.
</ResponseField>

<ResponseField name="Priority" type="integer">
  The priority value for this help desk message. See `eHelpDeskMessagePriority` enum values: `1` = Low, `2` = Normal, `3` = High, `4` = Critical.
</ResponseField>

<ResponseField name="AiProcessingResult" type="integer">
  The ai processing result value for this help desk message. See `eHelpDeskAiResult` enum values: `1` = NotProcessed, `2` = Responded, `3` = NotResponded.
</ResponseField>

<ResponseField name="Closed" type="boolean">
  Whether closed is enabled.
</ResponseField>

<ResponseField name="ClosedOn" type="string">
  Date/time value for closed on.
</ResponseField>

<ResponseField name="OwnerId" type="integer">
  ID of the owner linked to this record.
</ResponseField>

<ResponseField name="OwnerFullName" type="string">
  Display name of the linked owner full (read-only).
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Current file name of the image (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new file to upload as the image.
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the current image file.
</ResponseField>

<ResponseField name="FirstResponseTimeInMinutes" type="integer">
  The first response time in minutes value for this help desk message.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```