v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Mailing Lists

Return cPanel account's mailing lists

This function lists the account's Mailman mailing lists.

get/Email/list_lists

Query parameters

domainstring domain
Example:example.com

The domain to query. If you do not use this parameter, the function lists mailing lists for all of the cPanel account's domains.

regexstring
Example:user

A Perl Compatible Regular Expression (PCRE) that filters the results.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_lists",
  "module": "Email",
  "result": {
    "data": [
      {
        "accesstype": "public",
        "advertised": 1,
        "diskused": 20379,
        "humandiskused": "19.9\\u00a0KB",
        "list": "list@example.com",
        "listadmin": "admin@example.com,admin2@example.com",
        "listid": "list_example.com",
        "subscribe_policy": 1
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}