---
title: "List Restores"
method: GET
path: "/restores"
tags: ["restores", "Restores"]
---

# List Restores

`GET /restores`

List Restores

## Query parameters

- `cursor` string
- `per_page` integer

## Response `200`

A list of Restores objects.

- RestoreEntity[]
  - `earliest_date` string, date-time — Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
  - `id` integer — Restore Record ID.
  - `dirs_restored` integer — Number of directories that were successfully restored.
  - `dirs_errored` integer — Number of directories that were not able to be restored.
  - `dirs_total` integer — Total number of directories processed.
  - `files_restored` integer — Number of files successfully restored.
  - `files_errored` integer — Number of files that were not able to be restored.
  - `files_total` integer — Total number of files processed.
  - `prefix` string — Prefix of the files/folders to restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items, specify an empty string (`''`) in the prefix field or omit the field from the request.
  - `restoration_type` 'files' | 'users' — Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records.
  - `restore_in_place` boolean — If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
  - `restore_deleted_permissions` boolean — If true, we will also restore any Permissions that match the same path prefix from the same dates.
  - `users_restored` integer — Number of users successfully restored (only present for `restoration_type=users`).
  - `users_errored` integer — Number of users that failed to restore (only present for `restoration_type=users`).
  - `users_total` integer — Total number of users processed (only present for `restoration_type=users`).
  - `api_keys_restored` integer — Number of API keys restored (only present for `restoration_type=users`).
  - `public_keys_restored` integer — Number of public keys restored (only present for `restoration_type=users`).
  - `two_factor_authentication_methods_restored` integer — Number of two factor authentication methods restored (only present for `restoration_type=users`).
  - `status` 'pending' | 'counting' | 'restoring' | 'complete' | 'validating' — Status of the restoration process.
  - `update_timestamps` boolean — If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
  - `workspace_id` integer — Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
  - `error_messages` string[] — Error messages received while restoring files and/or directories. Only present if there were errors.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `409` — Conflict
- `412` — Precondition Failed
- `422` — Unprocessable Entity
- `423` — Locked
- `429` — Too Many Requests

---

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