Skip to content

getclientgroups.md

Latest commit

 

History

History
93 lines (75 loc) · 2.1 KB

getclientgroups.md

File metadata and controls

93 lines (75 loc) · 2.1 KB

+++ title = "GetClientGroups" toc = true +++

Obtain an array of client groups

Request Parameters

Parameter Type Description Required
action string "GetClientGroups" Required

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
totalresults int The total number of results available
groups array The client group entries returned

Example Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'GetClientGroups',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Example Request (Local API)

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

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

Example Response JSON

{
    "result": "success",
    "totalresults": 2,
    "groups": {
        "group": [
            {
                "id": 1,
                "groupname": "Client Group 1",
                "groupcolour": "#28C99B",
                "discountpercent": "10.00",
                "susptermexempt": "on",
                "separateinvoices": "on"
            },
            {
                "id": 2,
                "groupname": "Client Group 2",
                "groupcolour": "#FFFFFF",
                "discountpercent": "0.00",
                "susptermexempt": "",
                "separateinvoices": ""
            }
        ]
    }
}

Version History

Version Changelog
1.0 Initial Version