# cPanel API 2 Functions - Resellers::get_sub_accounts

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function lists all of a reseller's cPanel accounts.

Warning:
We **strongly** recommend that you use the following [UAPI](/openapi/whm/operation/listresellers/) function instead of this function: - `Resellers::list_accounts` — This function lists all of a reseller's cPanel accounts.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Resellers&cpanel_jsonapi_func=get_sub_accounts
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List sub accounts owned by 'reseller'
$get_sub_accounts = $cpanel->api2(
    'Resellers', 'get_sub_accounts'
    )
 );
```

div
Note:
br
For more information, read our Guide to the LiveAPI System.

br
LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List sub accounts owned by 'reseller'
my $get_sub_accounts = $cpliveapi->api2(
    'Resellers', 'get_sub_accounts',
 );
```

div
Note:
br
For more information, read our Guide to the LiveAPI System.

br
cPanel Tag System (deprecated)

div
Warnings:

- cPanel tags are deprecated. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


br
Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Resellers get_sub_accounts
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{  
   "cpanelresult":{  
      "apiversion":2,
      "func":"resellers",
      "data":[  
         {  
            "domain":"example.com",
            "user":"example",
            "select":"1"
         },
         {  
            "domain":"example1.com",
            "user":"example1",
            "select":""
         }
      ],
      "event":{  
         "result":1
      },
      "module":"Reseller"
   }
}
```

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
data
br
td
em
array of hashes
td
An array of hashes that contains information about the domains that the currently-authenticated user owns.
td
This array of hashes includes the 
code
domain
, 
code
user
, and 
code
select
 returns.
td
br
tr
td
p
code
domain
td
em
string
td
p
The domain that the account owns.
p
The function returns this value in the unnamed hash.
td
One or more valid domains on the server.
td
code
example.com
tr
td
p
code
user
td
em
string
td
p
The cPanel account's username.
p
span
The function returns this value in the unnamed hash.
td
One or more valid usernames.
td
code
example
tr
td
p
code
select
td
em
Boolean
td
p
Whether the specified account is the currently-authenticated user.
p
span
The function returns this value in the unnamed hash.
td
ul
li
code
1
 — Authenticated.
li
code
0
 — 
strong
Not
 authenticated.
td
code
1
tr
td
code
reason
td
em
string
td
div
p
A reason for failure.
p
This function only returns a 
code
reason
 value if there was an error.
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1