v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Mailing Lists

Return cPanel account's mailing list total

This function returns the number of mailing lists for every email address on a cPanel account.

Important:

When you disable the Receive Mail role, the system disables this function.

get/Email/count_lists

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": "count_lists",
  "module": "Email",
  "result": {
    "data": 1,
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}