---
title: "Return Support ticket status"
method: GET
path: "/ticket_list"
tags: ["Support Tickets", "Ticket Management"]
---

# Return Support ticket status

`GET /ticket_list`

This function lists all active and open support tickets from the
[cPanel Customer Portal](https://tickets.cpanel.net/).

**Note:**

This function is **not** available through the command line. You **must** call
it as a request body.

## Query parameters

- `server_num` integer, required
- `ticket_id` integer, required
- `ssh_username` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `auths` object[] — An array of objects containing the ticket authorization information.
      - `servers` object[] — An array of objects containing the server information.
        - `auth_status` 'AUTHED' | 'NOT_AUTHED' | 'EXPIRED' — The installation status. * `AUTHED` * `NOT_AUTHED` * `EXPIRED`
        - `auth_time` integer — When the grant happened, in [Unix time format](http://en.wikipedia.org/wiki/Unix_time).
        - `server_name` string — The server's human-readable description, from the [cPanel Customer Portal](https://tickets.cpanel.net/).
        - `server_num` integer — The server's ID number.
        - `ssh` string — The server's IP address and port number for SSH connections.
        - `ssh_username` string — The username for incoming SSH connections before they escalate to the `root` user.
        - `whm_ip` string — The server's IP address for WHM connections.
      - `ticket_id` integer — The ticket's ID number.
      - `ticket_status` 'OPEN' | 'CLOSED' | 'UNKNOWN' — The ticket's status. * `OPEN` * `CLOSED` * `UNKNOWN`
      - `ticket_subject` string — The ticket's subject line.
    - `non_fatals` string[] — Any non-fatal errors. * `ticket_system_log_entry` — The function could not record the grant operation in the ticket. * `audit_log` — The function could not record the grant operation in the local audit log. **Note:** The system stores the local audit log in the `/var/cpanel/logs/supportauth/audit.log` file.
  - `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)