---
title: "Return cPanel account's mailbox status"
method: GET
path: "/Mailboxes/get_mailbox_status_list"
tags: ["Mailboxes", "Mailbox Management"]
---

# Return cPanel account's mailbox status

`GET /Mailboxes/get_mailbox_status_list`

This function lists the account's mailbox size and globally unique identifier (GUID) by folder.

## Query parameters

- `account` string, required

## 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[]
      - `guid` string — The mailbox GUID.
      - `mailbox` string — The mailbox name.
      - `messages` integer — The number of messages in the folder.
      - `vsize` integer — The size of the folder, in bytes.
    - `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)