Skip to main content
GET
/
api
/
public
/
helpdesk
/
departments
{
  "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())