Get the support departments and associated ticket counts

Request Parameters

Parameter Type Description Required
action string “GetSupportDepartments” Required
ignore_dept_assignments bool Pass as true to not adhere to the departments the API user is a member of. Optional

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
totalresults int The total number of results available
departments array An array of department information

Example Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, '');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
            'action' => 'GetSupportDepartments',
            // See
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'responsetype' => 'json',
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);

Example Request (Local API)

$command = 'GetSupportDepartments';
$postData = array(
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);

Example Response JSON

    "result": "success",
    "totalresults": 1,
    "departments": {
        "department": [
                "id": "1",
                "name": "Sample Support Department",
                "awaitingreply": "0",
                "opentickets": "0"

Version History

Version Changelog
1.0 Initial Version