Search HelpDeskMessages

GET

api

support

helpdeskmessages

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

import requests

url = "https://spaces.nexudus.com/api/support/helpdeskmessages"

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/helpdeskmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Help desk messages are location-owned support tickets opened by customers, which can be assigned, categorized, prioritized, and closed.

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-List role.

Enums

eHelpDeskMessagePriority — Priority values

Value	Name
1	Low
2	Normal
3	High
4	Critical

eHelpDeskAiResult — AiProcessingResult values

Value	Name
1	NotProcessed
2	Responded
3	NotResponded

eSupportIssueCategory

Value	Name
1	Printing
2	WiFi
3	Access
4	Billing
5	Noise
6	HVAC
7	Cleaning
8	Booking
9	Other

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location that owns this support ticket; it is supplied from the agent context..

integer

Filter by iD of the customer who opened this support ticket..

string

Filter by display value for Coworker.FullName..

integer

Filter by optional ID of the support department that receives the ticket and can trigger its task-list workflow..

string

Filter by display value for HelpDeskDepartment.Name..

string

Filter by required ticket subject, up to 254 characters..

string

Filter by required initial message describing the customer’s support request; multiline text is allowed..

integer

Filter by ticket urgency: Low, Normal, High, or Critical; new tickets default to Normal when no priority is supplied..

integer

Filter by read-only result of the automatic AI reply attempt: NotProcessed, Responded, or NotResponded..

integer

Filter by read-only AI-generated issue category: Printing, WiFi, Access, Billing, Noise, HVAC, Cleaning, Booking, or Other; it remains empty until classified..

boolean

Filter by whether the ticket is closed; closing records the closure time and reopening clears it..

string

Filter by read-only UTC timestamp set when the ticket is closed and cleared when it is reopened..

integer

Filter by optional ID of the staff user currently assigned to own the ticket..

string

Filter by display value for Owner.FullName..

string

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

string

Filter by uRL of a new file to upload as the image.

boolean

Filter by set to true to remove the current image file.

integer

Filter by read-only first-response duration for this ticket, measured in whole minutes..

integer

Filter by system-managed ID of the AI channel session that escalated this ticket; do not set it through help desk ticket operations..

Range Filters

string

Filter by read-only UTC timestamp set when the ticket is closed and cleared when it is reopened. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC timestamp set when the ticket is closed and cleared when it is reopened. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by read-only first-response duration for this ticket, measured in whole minutes. greater than or equal to this value.

integer

Filter by read-only first-response duration for this ticket, measured in whole minutes. less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/support/helpdeskmessages?page=1&size=15&orderBy=Subject&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/support/helpdeskmessages?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Subject',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/support/helpdeskmessages',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Subject',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Subject

curl -X GET \
  "https://spaces.nexudus.com/api/support/helpdeskmessages?HelpDeskMessage_Subject=example-value&orderBy=Subject&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/support/helpdeskmessages?' + new URLSearchParams({
    HelpDeskMessage_Subject: 'example-value',
    orderBy: 'Subject',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/support/helpdeskmessages',
    params={
        'HelpDeskMessage_Subject': 'example-value',
        'orderBy': 'Subject',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/support/helpdeskmessages?from_HelpDeskMessage_UpdatedOn=2025-01-01T00:00&to_HelpDeskMessage_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/support/helpdeskmessages?' + new URLSearchParams({
    from_HelpDeskMessage_UpdatedOn: '2025-01-01T00:00',
    to_HelpDeskMessage_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/support/helpdeskmessages',
    params={
        'from_HelpDeskMessage_UpdatedOn': '2025-01-01T00:00',
        'to_HelpDeskMessage_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

HelpDeskMessage[]

The list of HelpDeskMessage records matching the query. See the Get one HelpDeskMessage endpoint for the full list of properties returned for each record.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "HelpDeskDepartmentId": null,
      "HelpDeskDepartmentName": null,
      "Subject": "",
      "MessageText": "",
      "Priority": 0,
      "AiProcessingResult": 0,
      "SupportIssueCategory": 0,
      "Closed": false,
      "ClosedOn": null,
      "OwnerId": null,
      "OwnerFullName": null,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "FirstResponseTimeInMinutes": null,
      "AiChannelSessionId": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Subject",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search HelpDeskMessages

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

import requests

url = "https://spaces.nexudus.com/api/support/helpdeskmessages"

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/helpdeskmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Subject

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Subject

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Subject

Range filters

Response

200