Get one HelpDeskComment

GET

api

support

helpdeskcomments

{id}

Get one HelpDeskComment

curl --request GET \
  --url https://spaces.nexudus.com/api/support/helpdeskcomments/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/support/helpdeskcomments/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/support/helpdeskcomments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "HelpDeskMessageId": 123,
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "MessageText": "<string>",
  "Internal": true,
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A HelpDeskComment is a customer or staff reply, including internal notes, on a support ticket; creating one reopens the ticket and follows its notification rules.

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 HelpDeskComment-Read role.

Path Parameters

integer

required

The Id of the HelpDeskComment record to retrieve.

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/support/helpdeskcomments/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the support ticket this reply or note belongs to; it determines the owning location and a new comment reopens the ticket..

integer

ID of the customer or staff member who authored this comment; the author determines the notification path..

string

Display value for Coworker.FullName..

string

Required multiline text of the customer reply or staff note..

boolean

Whether this is an internal staff note; when true it is not sent to the customer..

string

Current file name of the image (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the image.

boolean

Set to true to remove the current image file.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "HelpDeskMessageId": 0,
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "MessageText": "",
  "Internal": false,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": 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": "HelpDeskComment Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one HelpDeskComment

curl --request GET \
  --url https://spaces.nexudus.com/api/support/helpdeskcomments/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/support/helpdeskcomments/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/support/helpdeskcomments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "HelpDeskMessageId": 123,
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "MessageText": "<string>",
  "Internal": true,
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200