---
title: "Return cPanel accounts"
method: GET
path: "/listaccts"
tags: ["Accounts", "Account Management"]
---

# Return cPanel accounts

`GET /listaccts`

This function lists the accounts on the server.

## Query parameters

- `search` string
- `searchmethod` 'exact' | 'regex'
- `searchtype` 'domain' | 'owner' | 'user' | 'ip' | 'package'
- `want` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `acct` object[] — An array of objects containing 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` — The account has unlimited disk space quota. * A maximum amount of disk space, in megabytes (MB).
        - 'unlimited'
        - integer
      - `diskused` string — The account's current disk space usage, in megabytes (MB), appended with `M`. For example, `14M` represents 14 megabytes of current disk space usage.
      - `domain` string, domain — The account's main domain.
      - `email` string, email — The account's contact email address.
      - `has_backup` 0 | 1 — Whether a backup of the account exists. * `1` - A backup of the account exists. * `0` - A backup of the account does **not** exist.
      - `inodeslimit` union — The limit on the number of files that the account owns. * `unlimited` — The account can own an unlimited number files. * A positive integer.
        - 'unlimited'
        - integer
      - `inodesused` integer — The number of files that the account owns.
      - `ip` string, ipv4 — The IPv4 address of the account's main domain.
      - `ipv6` string[] — The IPv6 address of the account's main domain.
      - `is_locked` 0 | 1 — Whether the account is currently locked. * `1` - The account is locked. * `0` - The account is **not** locked.
      - `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.
      - `legacy_backup` 0 | 1 — Whether legacy backups are enabled. * `1` - Enabled. * `0` - Disabled.
      - `mailbox_format` 'mdbox' | 'maildir' — The type of mailbox the account uses. * `mdbox` * `maildir`
      - `max_defer_fail_percentage` union — The [percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam) that the account can send per hour before outgoing mail is rate-limited. * `unlimited` — The account can send unlimited emails per hour. * An integer that represents a precentage of messages.
        - 'unlimited'
        - integer
      - `max_email_per_hour` union — The [maximum number of emails](https://go.cpanel.net/howtopreventspam) that the account can send in one hour. * `unlimited` — The account can send unlimited emails per hour. * An integer that represents a number of sent emails.
        - 'unlimited'
        - integer
      - `max_emailacct_quota` union — The maximum size, in megabytes (MB), that the account can define when it creates an email account. * `unlimited` — The account can set unlimited quotas. * A positive integer that represents the allowable maximum size of an email account, in megabytes (MB).
        - 'unlimited'
        - integer
      - `maxaddons` union — The account's maximum number of addon domains. * `unlimited` — The account can create unlimited addon domains. * `*unknown*` — The account cannot create addon domains. * An integer that represents a number of addon domains.
        - 'unlimited' | '*unknown*'
        - integer
      - `maxftp` union — The account's maximum number of FTP accounts. * `unlimited` — The account can create unlimited FTP accounts. * An integer that represents a number of FTP accounts.
        - 'unlimited'
        - integer
      - `maxlst` union — The account's maximum number of mailing lists. * `unlimited` — The account can create unlimited mailing lists. * An integer that represents a number of mailing lists.
        - 'unlimited'
        - integer
      - `maxparked` union — The account's maximum number of parked domains (aliases). * `unlimited` — The account can create unlimited parked domains. * `*unknown*` — The account cannot use parked domains. * An integer that represents a number of parked domains.
        - 'unlimited' | '*unknown*'
        - integer
      - `maxpop` union — The account's maximum number of email addresses. * `unlimited` — The account can create unlimited email addresses. * An integer that represents a number of email accounts.
        - 'unlimited'
        - integer
      - `maxsql` union — The account's maximum number of each available type of SQL database. For example, if you set this value to `5` and the system administrator allows MySQL® and PostgreSQL® databases, users can create up to five MySQL databases and up to five PostgreSQL databases. * `unlimited` — The account can create unlimited SQL databases. * An integer that represents a number of SQL databases.
        - 'unlimited'
        - integer
      - `maxsub` union — The account's maximum number of subdomains. * `unlimited` — The account can create unlimited subdomains. * `*unknown*` - The account cannot use subdomains. * An integer that represents a number of subdomains.
        - 'unlimited' | '*unknown*'
        - integer
      - `min_defer_fail_to_trigger_protection` union — The [minimum number of failed or deferred messages](https://go.cpanel.net/howtopreventspam) that the account can send before outgoing mail is subject to rate-limiting. * `unlimited` — The account can send unlimited emails. * An integer that represents a number of failed or deferred messages.
        - 'unlimited'
        - integer
      - `outgoing_mail_hold` 1 | 0 — Whether to retain outgoing mail in the mail queue for the account's users. * `1` - Hold outgoing email in the mail queue. * `0` - Do **not** hold outgoingemail in the mail queue.
      - `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 forcefailure of outgoing email. * `0` - Do **not** suspend and forcefailure of 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 — The reseller account username or `root` user that owns the account.
      - `partition` string — The partition that contains the account's home directory.
      - `plan` string — The account's hosting package.
      - `shell` string — The absolute path of the account's shell location.
      - `startdate` string — The account creation date, in `YY Mon DD HH:mm` format.
      - `suspended` 0 | 1 — Whether the account is currently suspended. * `1` - Suspended. * `0` - **Not** suspended.
      - `suspendreason` union — The reason for account suspension, if one was provided.
        - 'not suspended' — If the account is **not** suspended, `suspendreason` will return `not suspended`.
        - string, nullable — If the account is suspended, `suspendreason` will return either: * A blank value, if the suspender did not provide a reason. * A message that explains the suspension.
      - `suspendtime` integer, 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.
      - `theme` string — The account's cPanel interface theme.
      - `uid` integer — The account's user ID on the system.
      - `unix_startdate` integer — The account creation date.
      - `user` string, username — The account username.
      - `standalone_feature` string — The unique ID of the standalone feature associated with the account's package, if any. * An empty string if the package has no standalone features.
      - `standalone_feature_name` string — The name of the standalone feature associated with the account's package, if any. * An empty string if the package has no standalone features. * The feature's name if a standalone feature exists.
  - `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)