Search HelpDeskMessages - Nexudus Platform

GET

api

support

helpdeskmessages

Search HelpDeskMessages

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

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

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-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

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

HelpDeskMessage_Business

integer

Filter by iD of the business linked to this record.

HelpDeskMessage_Coworker

integer

Filter by iD of the coworker linked to this record.

HelpDeskMessage_Coworker_FullName

string

Filter by display name of the linked coworker full (read-only).

HelpDeskMessage_HelpDeskDepartment

integer

Filter by iD of the help desk department linked to this record.

HelpDeskMessage_HelpDeskDepartment_Name

string

Filter by display name of the linked help desk department (read-only).

HelpDeskMessage_Subject

string

Filter by the subject value for this help desk message.

HelpDeskMessage_MessageText

string

Filter by the message text value for this help desk message.

HelpDeskMessage_Priority

integer

Filter by the priority value for this help desk message.

HelpDeskMessage_AiProcessingResult

integer

Filter by the ai processing result value for this help desk message.

HelpDeskMessage_Closed

boolean

Filter by whether closed is enabled.

HelpDeskMessage_ClosedOn

string

Filter by date/time value for closed on.

HelpDeskMessage_Owner

integer

Filter by iD of the owner linked to this record.

HelpDeskMessage_Owner_FullName

string

Filter by display name of the linked owner full (read-only).

HelpDeskMessage_ImageFileName

string

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

HelpDeskMessage_NewImageUrl

string

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

HelpDeskMessage_ClearImage

boolean

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

HelpDeskMessage_FirstResponseTimeInMinutes

integer

Filter by the first response time in minutes value for this help desk message.

Range Filters

from_HelpDeskMessage_ClosedOn

string

Filter by date/time value for closed on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_HelpDeskMessage_ClosedOn

string

Filter by date/time value for closed on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_HelpDeskMessage_FirstResponseTimeInMinutes

integer

Filter by the first response time in minutes value for this help desk message greater than or equal to this value.

to_HelpDeskMessage_FirstResponseTimeInMinutes

integer

Filter by the first response time in minutes value for this help desk message less than or equal to this value.

from_HelpDeskMessage_CreatedOn

string

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

to_HelpDeskMessage_CreatedOn

string

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

from_HelpDeskMessage_UpdatedOn

string

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

to_HelpDeskMessage_UpdatedOn

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"

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"

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"

Response

200

Records

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.

Partial records — The listing endpoint returns a summary representation of each HelpDeskMessage. The following fields are not populated in the Records[] response: Priority, AiProcessingResult.To get all fields, fetch the full record using the Get one HelpDeskMessage endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "HelpDeskDepartmentId": null,
      "HelpDeskDepartmentName": null,
      "Subject": "",
      "MessageText": "",
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Subject",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one HelpDeskMessageRetrieve a single HelpDeskMessage record by its Id.

Search HelpDeskMessages

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

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

​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