---
title: "Return suspended cPanel accounts and information"
method: GET
path: "/listsuspended"
tags: ["Suspensions"]
---

# Return suspended cPanel accounts and information

`GET /listsuspended`

This function lists suspended accounts on the server.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `account` object[] — A list of objects containing suspended account data.
      - `is_locked` 0 | 1 — Whether the account is locked. * `1` - Locked. * `0` - Not locked.
      - `owner` string — The cPanel account's owner. - `root` - A reseller's username. - The account's username.
      - `reason` string — The reason why the account is suspended, if one exists.
      - `time` string — The current date and time in `Day Mon DD HH:mm:SS YYYY` human-readable format, where: * `Day` - represents the day of the week as a three-letter abbreviation. * `Mon` - represents the month's three-letter abbreviation. * `DD` - represents the date. * `HH` - represents the hour. * `mm` - represents the minute. * `SS` - represents the second. * `YYYY` - represents the year.
      - `unixtime` integer — The current date and time.
      - `user` string — The cPanel account's username.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

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