Self Help Documentation
< All Topics

accounts/listaccounts

PostedFebruary 15, 2022
UpdatedApril 25, 2025

Description

Lists all existing SPanel accounts currently on the server.

Parameters

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
actionstringYesThe category and function being executed.
accountuserstringNoThis parameter contains the SPanel user account name to obtain data for.
diskSpaceOptionstringNoFilter accounts based on disk space usage. Possible values: “exactly”, “over”, “under”. If you choose to use this filter, you must include diskSpaceValue and diskSpaceType as well.
diskSpaceValuestringNoThe numeric value of the disk space. Depending on diskSpaceType it could be in megabytes, gigabytes or percentage of the whole server space.
diskSpaceTypestringNoThe type of disk space value set in diskSpaceValue, possible values: “MB”, “GB”, “%”.
statusOptionstringNoFilter accounts by option, possible values: “active”, “suspended”, “scheduled”. The scheduled value is used to display accounts that are scheduled for suspension.
setupOptionstringNoFilter accounts based on setup time. Possible values: “older”, “newer”, “created”. This must be used in combination with setupValue or setupDate.
setupValuestringNoThis must be used in combination with setupOption. Possible values: “1w” for a week, “1m” for a month, “1y” for a year or “custom” if you’d like to provide custom value as the setupDate parameter.
setupDatestringNoThis may be used only if setupOption and setupValue are used. setupValue must be “custom”. The parameter must be a valid date which can be parsed by PHP’s strtotime function.
selectedPackagestringNoFilter accounts by package name.

Example

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'action' => 'accounts/listaccounts',
//Optional parameter:
  'accountuser' => 'spanelio',
// Filter parameters (all optional):
   'diskSpaceOption' => 'over',
   'diskSpaceValue' => 1000,
   'diskSpaceType' => 'MB',
   'statusOption' => 'active',
   'setupOption' => 'newer',
   'setupValue' => 'custom',
   'setupDate' => '2023-12-31',
   'selectedPackage' => 'Premium',
];
 
$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.

Output

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
    "data": [
        {
            "domain": "testdomain.com",
            "user": "testuser",
            "ip": "123.123.123.123",
            "disk": "123",
            "inodes":"123",
            "homedir": "home",
            "numaddons": "0",
            "numsubdomains": "0",
            "numdatabases": "0",
            "numemails": "0",
            "numftpaccts": "0",
            "suspended": "0",
            "disklimit": "Unlimited",
            "inodeslimit": "Unlimited",
            "domainslimit": "Unlimited",
            "emailslimit": "Unlimited",
            "databaseslimit": "Unlimited",
            "setupDate": "01.10.2021",
            "package": "Custom"
        }
    ]
}
Table of Contents