---
title: "Return whether email account uses BoxTrapper"
method: GET
path: "/BoxTrapper/get_status"
tags: ["BoxTrapper", "Spam Prevention (BoxTrapper)"]
---

# Return whether email account uses BoxTrapper

`GET /BoxTrapper/get_status`

This function checks whether BoxTrapper is enabled for an email account.

**Important:**

When you disable the [Receive Mail role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Query parameters

- `email` string, email, 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` 0 | 1 — Whether BoxTrapper is enabled for the email account. * `1` — Enabled. * `0` — Disabled.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `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)