< All Topics



Lists all available user permissions. User permissions are expected to be used when working with an subuser, for example when using the user/addsubuser and user/editsubuserprivileges API functions. This list is pulled real-time directly from the SPanel system.


tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
labelsboolNoDefault: false (unset). If set to true, API call results will include human-readable labels for each category and its pages.

The user permissions are subject to change overtime as we add new features to SPanel. A good idea is to run a cron to update these permissions in your system regularly if you are using some form of caching.

Please note that the permission list differs from the categories and pages placement that you can see in the SPanel UI because of the way the functions are organized into categories in the SPanel API.


$endpointUrl = '';

$postData = [
  'token' => 'provided_auth_token', // Check API Basics for more information
  'accountuser' => 'spanelio',
  'action' => 'user/listuserpermissions',
//'labels' => true

$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );

You can find more information about the Endpoint URL in our API Basics article.


    "result": "success",
    "data": {
        "email": {
            "category": "email",
            "pages": [
        "mysql": {
            "category": "mysql",
            "pages": [
        "user": {
            "category": "user",
            "pages": [
        "domain": {
            "category": "domain",
            "pages": [
        "file": {
            "category": "file",
            "pages": [
        "tool": {
            "category": "tool",
            "pages": [
        "software": {
            "category": "software",
            "pages": [
Previous user/addsubuser
Next user/editsubuserprivileges
Table of Contents