---
title: "Return cPanel account summary"
method: GET
path: "/accountsummary"
tags: ["Accounts", "Account Management"]
---

# Return cPanel account summary

`GET /accountsummary`

This function retrieves a summary of a user's account.

**Note:**

You must use either the user or domain parameters.

## Query parameters

- `domain` string
- `search` string
- `searchmethod` string
- `searchtype` string
- `user` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `acct` object[] — An array of objects of account data.
      - `backup` 0 | 1 — Whether backups are enabled. * `1` Enabled. * `0` Disabled.
      - `child_nodes` object[] — An array that contains the the workload and alias values for each of the child nodes.
        - `alias` string — The alias of the child node
        - `workload` 'Mail' — The workload delegated to the child node
      - `disklimit` union — The account's disk space quota. * `unlimited` * A maximum amount of disk space, in mebibyte (MiB).
        - 'unlimited'
        - integer
      - `diskused` string, mebibyte-short — The account's current disk space usage. An integer that represents an amount of disk space, in mebibyte (MiB). For example, 14M represents 14 MiB of disk space.
      - `domain` string, fqdn — The account's main domain. A valid domain name on the account.
      - `email` string, email — The account's contact email address. A valid email address.
      - `inodeslimit` union — The limit on the number of files that the account owns. * `unlimited` * A maximum amount of files as an integer.
        - 'unlimited'
        - integer
      - `inodesused` integer — The number of files that the account owns.
      - `ip` string, ipv4 — The account's main domain's IP address.
      - `ipv6` string[] — The account's main domain's IPv6 addresses.
      - `is_locked` 0 | 1 — Whether the account is currently locked. * `1` Locked. * `0` Not locked.
      - `legacy_backup` 0 | 1 — Whether legacy backups are enabled. * `1` Enabled. * `0` Disabled.
      - `mailbox_format` 'maildir' | 'mbox', mailbox_format — The storage format that the account's email mailboxes use. * `maildir` The account's mail is stored in `maildir` format. * `mbox` The account's mail is stored in `mbox` format.
      - `max_defer_fail_percentage` union — The percentage of failed or deferred email messages that the account can send per hour before outgoing mail is rate-limited. * `unlimited` * An integer that represents a percentage of messages.
        - 'unlimited'
        - integer
      - `max_email_per_hour` union — The maximum number of emails that the account can send in one hour. * `unlimited` * An integer that represents a number of sent emails.
        - 'unlimited'
        - integer
      - `max_emailacct_quota` union — The maximum size that the cPanel account can define when it creates an email account. * `unlimited` * A positive integer that represents the allowable maximum size of an email account, in mebibyte (MiB).
        - 'unlimited'
        - integer
      - `maxaddons` union — The account's maximum number of addon domains. * `unlimited` * `*unknown*` The account cannot use any addon domains. * An integer that represents a number of addon domains.
        - 'unlimited'
        - integer
      - `maxftp` union — The account's maximum number of FTP accounts. * `unlimited` * An integer that represents a number of FTP accounts.
        - 'unlimited'
        - integer
      - `maxlst` union — The account's maximum number of mailing lists. * `unlimited` * An integer that represents a number of mailing lists.
        - 'unlimited'
        - integer
      - `maxparked` union — The account's maximum number of parked domains (aliases). * `unlimited` * `*unknown*` The account cannot use any parked domains. * An integer that represents a number of parked domains.
        - 'unlimited'
        - integer
      - `maxpop` union — The account's maximum number of email addresses. * `unlimited` * An integer that represents a number of email accounts.
        - 'unlimited'
        - integer
      - `maxsql` union — The account's maximum number of SQL databases. * `unlimited` * An integer that represents a number of SQL databases.
        - 'unlimited'
        - integer
      - `maxsub` union — The account's maximum number of subdomains. * `unlimited` * `*unknown*` The account cannot use any subdomains. * An integer that represents a number of subdomains.
        - 'unlimited'
        - integer
      - `min_defer_fail_to_trigger_protection` union — The minimum number of failed or deferred messages that the account can send before outgoing mail is subject to rate-limiting. * `unlimited` * An integer that represents a number of failed or deferred messages.
        - 'unlimited'
        - integer
      - `outgoing_mail_hold` 0 | 1 — Whether to retain outgoing mail in the mail queue for the account's users. * `1` Suspend and force failure of outgoing email. * `0` Unsuspend outgoing email.
      - `outgoing_mail_suspended` 0 | 1 — Whether to suspend outgoing email from the account's users and force failure of any of their mail currently in the mail queue. * `1` - Suspend and force failure of outgoing email. * `0` - Unsuspend outgoing email. **Note:** If mail for a cPanel user's account is suspended, the system will reject their email before the system puts it in the mail server queue.
      - `owner` string, username — The account's owner. * root * A reseller account's username.
      - `partition` string — The partition that contains the account's home directory. The name of a partition on the server.
      - `plan` string, plan — The account's hosting package. The name of a package on the server.
      - `shell` string, shell — The account's shell. A shell location on the server.
      - `startdate` string, YY-Mon-DD-HH-MM — The account creation date. The date in YY-Mon-DD HH-mm human-readable format, where:- YY represents the year. * `Mon` represents the month. * `DD` represents the date. * `HH` represents the hour. * `mm` represents the minute.
      - `suspended` 0 | 1 — Whether the account is currently suspended. * `1` Suspended. * `0` Not suspended.
      - `suspendreason` string, nullable — The reason for account suspension, if one was provided. * `null` The account is not currently suspended. * A blank value, if the suspender did not provide a reason. * A message that explains the suspension.
      - `suspendtime` string, nullable — The time of suspension. * `null` The account is not currently suspended. * The time at which the account became suspended.
      - `temporary` 0 | 1 — Whether the Customer Support Ticket process created this user for temporary access to the system. * `1` - Temporary user. * `0` - Regular user.
      - `is_temporary_domain` 0 | 1 — Whether the main domain is a temporary domain. * `1` - The account's main domain is a temporary domain. * `0` - The account's main domain is not a temporary domain. **Note:** For more information about temporary domains, read our [Temporary Domains](https://go.cpanel.net/cp-temporary-domain) documentation.
      - `theme` string, theme — The account's cPanel interface theme. * Any valid theme on the server.
      - `uid` integer — The account's user ID on the system.
      - `unix_startdate` integer — The account creation date. The account creation date and time, in Unix time format.
      - `user` string, username — The account username. A cPanel account or reseller username on the server.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` Success * `0` Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)