Accounts
Account Management
Return cPanel account summary
This function retrieves a summary of a user's account.
Note:
You must use either the user or domain parameters.
get/accountsummary
Query parameters
domainstring
Example:example.com
The account's main domain.
searchstring
Example:example.com
The search term.
searchmethodstring
Example:exact
The search method to use.
searchtypestring
Example:domain
The type of search to perform.
userstring
Example:username
The account's username.
Response
HTTP Request was successful.
Example response
{
"data": {
"acct": [
{
"child_nodes": [
{
"alias": "nodealias",
"workload": "Mail"
}
],
"diskused": "14M",
"domain": "example.com",
"email": "username@example.com",
"inodesused": 1,
"ip": "192.168.0.128",
"ipv6": [
"0101:ca75:0101:ca75:0101:ca75:0101:ca77"
],
"mailbox_format": "maildir",
"owner": "root",
"partition": "home",
"plan": "packagename",
"shell": "/bin/bash",
"startdate": "13 May 22 16:03",
"suspendreason": "not suspended",
"theme": "jupiter",
"unix_startdate": 1369256589,
"user": "username"
}
]
},
"metadata": {
"command": "accountsummary",
"reason": "OK",
"result": 1,
"version": 1
}
}