Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Trashed folders

Get trashed folder

Retrieves a folder that has been moved to the trash.

Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the GET /folders/:id/trash API.

To list all items that have been moved to the trash, please use the GET /folders/trash/items API.

get/folders/{folder_id}/trash

Path parameters

folder_idstring required

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123.

The root folder of a Box account is always represented by the ID 0.

Query parameters

fieldsstring[]

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Response

Returns the folder that was trashed, including information about when the it was moved to the trash.

idstring required

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folders/123 the folder_id is 123.

etagstring nullable

The HTTP etag of this folder. This can be used within some API endpoints in the If-Match and If-None-Match headers to only perform changes on the folder if (no) changes have happened.

type'folder' required

The value will always be folder.

sequence_idstring

A numeric identifier that represents the most recent user event that has been applied to this item.

This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

namestring required

The name of the folder.

created_atstring date-time nullable

The date and time when the folder was created. This value may be null for some folders such as the root folder or the trash folder.

modified_atstring date-time nullable

The date and time when the folder was last updated. This value may be null for some folders such as the root folder or the trash folder.

descriptionstring required

The optional description of this folder.

sizeinteger required

The folder size in bytes.

Be careful parsing this integer as its value can get very large.

trashed_atstring date-time nullable

The time at which this folder was put in the trash.

purged_atstring date-time nullable

The time at which this folder is expected to be purged from the trash.

content_created_atstring date-time nullable

The date and time at which this folder was originally created.

content_modified_atstring date-time nullable

The date and time at which this folder was last updated.

shared_linkstring nullable

The shared link for this folder. This will be null if a folder has been trashed, since the link will no longer be active.

folder_upload_emailstring nullable

The folder upload email for this folder. This will be null if a folder has been trashed, since the upload will no longer work.

item_status'active' | 'trashed' | 'deleted' required

Defines if this item has been deleted or not.

  • active when the item has is not in the trash
  • trashed when the item has been moved to the trash but not deleted
  • deleted when the item has been permanently deleted.

Example response

{
  "id": "123456789",
  "etag": "1",
  "type": "folder",
  "sequence_id": "3",
  "name": "Contracts",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "description": "Legal contracts for the new ACME deal",
  "size": 629644,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "folder",
        "id": "123456789",
        "name": "Trash"
      }
    ]
  },
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "purged_at": "2012-12-12T10:53:43-08:00",
  "content_created_at": "2012-12-12T10:53:43-08:00",
  "content_modified_at": "2012-12-12T10:53:43-08:00",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "parent": {
    "id": "12345",
    "etag": "1",
    "type": "folder",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "item_status": "trashed"
}