List Help Desk Departments

Returns the available help desk departments for routing support tickets.

GET /api/public/helpdesk/departments

List Help Desk Departments

cURL

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

import requests

url = "https://spaces.nexudus.com/api/public/helpdesk/departments"

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

200

{
  "Departments": [
    {}
  ],
  "Departments[].Id": 123,
  "Departments[].Name": "<string>",
  "Departments[].Description": "<string>"
}

List Help Desk Departments

Returns the list of help desk departments configured by the operator. Used to populate a department selector when creating new support tickets.

Authentication

Requires a valid customer bearer token.

Query Parameters

_shape · string

Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

Response

Departments · Department[] · required

Array of available departments.

Departments[].Id · number · required

Unique identifier for the department. Use as DepartmentId when creating a message.

Departments[].Name · string · required

Display name of the department.

Departments[].Description · string · required

Description of the department’s scope.

Examples

Fetch departments

GET /api/public/helpdesk/departments
Authorization: Bearer {token}

{
  "Departments": [
    { "Id": 1, "Name": "General", "Description": "General enquiries" },
    { "Id": 2, "Name": "Billing", "Description": "Invoice and payment issues" },
    { "Id": 3, "Name": "Facilities", "Description": "Building and equipment" }
  ]
}

TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: departments } = useTypedData(httpClient, endpoints.helpDesk.departments())