UAPI Functions - Resellers::list_accounts

Description

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

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Resellers/list_accounts

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// List reseller accounts on example.com
$list_reseller_acounts $cpanel->uapi(
    'Resellers''list_accounts'
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List reseller accounts on example.com
my $list_reseller_accounts $cpliveapi->uapi(
    'Resellers''list_accounts',
);

 cPanel Template Toolkit

<!-- Get a hash of all the data, then display the domain values. -->
[% data = execute( 'Reseller', 'list_accounts' ); %]
[% FOREACH q = data.domain %]
     <p>
         [% q %]
     </p>
[% END %]
    
<!-- Get only the domain value. -->
[% execute('Reseller', 'list_accounts').data.domain %]

 Command Line

uapi --user=username Resellers list_accounts

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "domain": "example.com",
      "user": "exampleuser",
      "select": "1"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

This function does not accept parameters.

Returns

Return

Type

Description

Possible values

Example

 domain 

string

The account's domain.

A valid domain on the server.

 example.com 

user

string

The account's username.

 A valid username on the server. 

exampleuser

select

 Boolean 

 Whether the account's user is currently logged in. 

  • 1 — Logged in.
  • 0 — Not logged in.

1

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....