Retrieve a list of permissions that can be used when creating a user
| Parameter | Type | Description | Required |
|---|---|---|---|
| action | string | "GetPermissionsList" | Required |
| Parameter | Type | Description |
|---|---|---|
| result | string | The result of the operation: success or error |
$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' => 'GetPermissionsList',
// 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);$command = 'GetPermissionsList';
$postData = array(
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later
$results = localAPI($command, $postData, $adminUsername);
print_r($results);{
"status": "success",
"permissions": {
"permission": [
"profile",
"contacts",
"products",
"manageproducts",
"productsso",
"domains",
"managedomains",
"invoices",
"quotes",
"tickets",
"affiliates",
"emails",
"orders"
]
}
}| Version | Changelog |
|---|---|
| 1.0 | Initial Version |