Skip to Content
HelvetlyDocs
API referenceDocuments

List the Trash

Needs a token with the read:documents scope (or write:documents). Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

GET
/api/v1/documents/trash

Files and folders in the Trash, newest first. A trashed folder is listed once (its contents come back with it). Each entry shows purge_at: after 30 days it is deleted forever by a background job. Restore with bulk_documents (action restore). Emptying the Trash or deleting forever is not part of the public API.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/documents/trash'
Example Response
{  "data": [    {      "type": "file",      "id": "string",      "name": "string",      "content_type": "string",      "size": 0,      "item_count": 0,      "location": {        "id": "string",        "name": "string"      },      "retained_until": "2019-08-24",      "deleted_at": "2019-08-24T14:15:22Z",      "deleted_by": {        "id": "string",        "name": "string"      },      "purge_at": "2019-08-24T14:15:22Z"    }  ]}