---
title: "Return cPanel account's mailing lists"
method: GET
path: "/Email/list_lists"
tags: ["Email", "Mailing Lists"]
---

# Return cPanel account's mailing lists

`GET /Email/list_lists`

This function lists the account's Mailman mailing lists.

## Query parameters

- `domain` string, domain
- `regex` string

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[]
      - `accesstype` 'private' | 'public' — The level of access that users have to the mailing list. * `private` - The list has **all** of the following settings: * The list has private archives. * The administrator **must** approve subscriptions. * The Mailman directory page does **not** display the list. * `public` - The list has **any** of the following settings: * The list has public archives. * Anyone can subscribe. * The Mailman directory page displays the list.
      - `advertised` 0 | 1 — Whether the Mailman directory page displays the list. * `1` - The Mailman directory page displays the list. * `0` - The Mailman directory page does not display the list.
      - `archive_private` 0 | 1 — Whether the mailing list archive is `private`. * `1` - The mailing list archive is `private`. * `0` - The mailing list archive is `public`.
      - `desthost` union — The IP address or domain name that handles mail for the mailing list's domain. * A valid hostname. * An IPv4 address. **Note:** If the function **cannot** resolve the IP address to a hostname, it will return the IP address.
        - string, domain
        - string, ipv4
      - `diskused` integer — The disk space that the mailing list currently uses, measured in megabytes (MB).
      - `humandiskused` string — The disk space that the mailing list uses, in human-readable format.
      - `list` string, email — The mailing list name and domain.
      - `listadmin` string — The mailing list's administrators' email addresses. A comma-separated list of email addresses.
      - `listid` string — The mailing list's name and domain. The mailing list name, an underscore (_), and the domain.
      - `subscribe_policy` 1 | 2 | 3 — The level of control that the mailing list administrator has over new subscribers. * `1` - Anyone can subscribe. The system sends a confirmation email. * `2` - The administrator **must** approve subscriptions. The system does **not** send a confirmation email. * `3` - The administrator **must** approve subscriptions. The system sends a confirmation email.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

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