Box Developer Documentation
Log in

List trashed items

get
https://api.box.com/2.0
/folders/trash/items

Retrieves the files and folders that have been moved to the trash.

Any attribute in the full files or folders objects can be passed in with the fields parameter to retrieve those specific attributes that are not returned by default.

This endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the marker parameter.

Related Guides

Request

application/json

Query Parameters

stringin queryoptional
ASC

The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.

Value is one of ASC,DESC

string arrayin queryoptional
id,type,name

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.

integer / int64in queryoptional
10001000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

integer / int64in queryoptional
10000

The offset of the item at which to begin the response.

stringin queryoptional
id

Defines the second attribute by which items are sorted.

Items are always sorted by their type first, with folders listed before files, and files listed before web links.

This parameter is not supported when using marker-based pagination.

Value is one of id,name,date,size

booleanin queryoptional
true

Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time.

By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.

Response

application/jsonItems

Returns a list of items that have been deleted

application/jsonClient error

Returns an error if some of the parameters are missing or not valid.

  • invalid_parameter can appear when the sort, direction or offset parameter is provided when using marker based pagination, or when the marker parameter is provided but usemarker is set to false or null.
application/jsonClient error

An unexpected client error.

get
List trashed items
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -X GET https://api.box.com/2.0/folders/trash/items \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
.NET
BoxCollection<BoxItem> trashedItems = await client.FoldersManager.GetTrashItemsAsync(limit: 100);
Python
trashed_items = client.trash().get_items()
for trashed_item in trashed_items:
    print('The item ID is {0} and the item name is {1}'.format(trashed_item.id, trashed_item.name))
Node
client.trash.get()
	.then(trashedItems => {
		/* trashedItems -> {
			total_count: 2,
			entries: 
			[ { type: 'file',
				id: '11111',
				sequence_id: '1',
				etag: '1',
				sha1: '9d976863fc849f6061ecf9736710bd9c2bce488c',
				name: 'file Tue Jul 24 145436 2012KWPX5S.csv' },
				{ type: 'file',
				id: '22222',
				sequence_id: '1',
				etag: '1',
				sha1: '09b0e2e9760caf7448c702db34ea001f356f1197',
				name: 'file Tue Jul 24 010055 20129Z6GS3.csv' } ],
			offset: 0,
			limit: 100 }
		*/
	});