---
title: "Return available webmail clients"
method: GET
path: "/WebmailApps/list_webmail_apps"
tags: ["WebmailApps", "Webmail Applications"]
---

# Return available webmail clients

`GET /WebmailApps/list_webmail_apps`

This function lists the account's available webmail clients.

**Important:**

When you disable the [Receive Mail role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.

## Query parameters

- `theme` 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[]
      - `displayname` string — The webmail client name, as it will display in the interface.
      - `icon` string — An icon file's path, relative to the `/usr/local/cpanel/base/frontend` directory.
      - `id` string — The webmail client's ID.
      - `url` string, url-path — The webmail client's URL.
    - `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` 1 | 0 — * `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)