Skip to main content
GET
/
api
/
support
/
helpdeskdepartments
/
{id}
{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "Active": true,
  "Managers": [
    123
  ],
  "TaskListId": 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 HelpDeskDepartment-Read role.

Path Parameters

id
integer
required
The Id of the HelpDeskDepartment record to retrieve.

Code Examples

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

Response

200

BusinessId
integer
Business Id.
Name
string
Name.
Description
string
Description.
Active
boolean
Active.
Managers
integer[]
Managers.
TaskListId
integer
Task List Id.
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,
  "Name": "",
  "Description": "",
  "Active": false,
  "Managers": [],
  "TaskListId": 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": "HelpDeskDepartment Example",
  "LocalizationDetails": null,
  "CustomFields": null
}