Get one HelpDeskDepartment

GET

api

support

helpdeskdepartments

{id}

Get one HelpDeskDepartment

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

import requests

url = "https://spaces.nexudus.com/api/support/helpdeskdepartments/{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/helpdeskdepartments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

A support department (HelpDeskDepartment) routes customer support tickets to its managers and can add a task list to the customer.

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

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"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the location that owns this support department; it is supplied from the agent context..

string

Required localized name used to identify this support department when assigning support tickets..

string

Required localized text explaining the purpose or scope of this support department..

boolean

Whether customers can select this support department when submitting a support ticket; inactive departments are not offered to customers..

integer[]

List of user IDs for managers notified about new tickets and comments assigned to this support department..

integer

Optional ID of the task list automatically added to the customer when a ticket is created or updated for this support department..

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

{
  "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
}

Get one HelpDeskDepartment

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

import requests

url = "https://spaces.nexudus.com/api/support/helpdeskdepartments/{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/helpdeskdepartments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

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