---
title: "Return users with a backup file"
method: GET
path: "/backup_user_list"
tags: ["Backups", "Backup Settings"]
---

# Return users with a backup file

`GET /backup_user_list`

This function lists users with a backup file, stored locally or on additional backup destinations, on a specified date.

## Query parameters

- `restore_point` string, ISO-8601 Date, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `user` object[] — An array of objects containing user backup information.
      - `status` 'active' | 'inactive' | 'no_backup' — The account's backup status * `active` * `inactive` * `no_backup`
      - `username` string, username — The user'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)