Trashed File
Represents a trashed file.
123456789The unique identifier that represent a file.
The ID for any file can be determined
by visiting a file in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/files/123
the file_id is 123.
filefile
Value is always file
2012-12-12T10:53:43-08:00The date and time at which this file was originally created, which might be before it was uploaded to Box.
2012-12-12T10:53:43-08:00The date and time at which this file was last updated, which might be before it was uploaded to Box.
2012-12-12T10:53:43-08:00The date and time when the file was created on Box.
The user who created this file
Contract for Q1 renewal256The optional description of this file
1The HTTP etag of this file. This can be used within some API
endpoints in the If-Match and If-None-Match headers to only
perform changes on the file if (no) changes have happened.
The information about the current version of the file.
trashedDefines if this item has been deleted or not.
activewhen the item has is not in the trashtrashedwhen the item has been moved to the trash but not deleteddeletedwhen the item has been permanently deleted.
Value is one of active,trashed,deleted
2012-12-12T10:53:43-08:00The date and time when the file was last updated on Box.
The user who last modified this file
Contract.pdfThe name of the file
The user who owns this file
The folder that this file is located within.
The tree of folders that this file is contained in, starting at the root.
Array of folders for this item's path collection
123456789The unique identifier that represent a folder.
folderfolder
Value is always folder
This field is null for the Trash folder
TrashThe name of the Trash folder.
This field is null for the Trash folder
1The number of folders in this list.
2012-12-12T10:53:43-08:00The time at which this file is expected to be purged from the trash.
3A 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.
85136C79CBF9FE36BB9D05D0639C70C265C18D37The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.
629644The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow.
2012-12-12T10:53:43-08:00The time at which this file was put in the trash.
Response Example
{
"id": "123456789",
"type": "file",
"content_created_at": "2012-12-12T10:53:43-08:00",
"content_modified_at": "2012-12-12T10:53:43-08:00",
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"description": "Contract for Q1 renewal",
"etag": "1",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"item_status": "trashed",
"modified_at": "2012-12-12T10:53:43-08:00",
"modified_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"name": "Contract.pdf",
"owned_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"parent": {
"id": "12345",
"type": "folder",
"etag": "1",
"name": "Contracts",
"sequence_id": "3"
},
"path_collection": {
"entries": [
{
"etag": "null",
"id": "123456789",
"name": "Trash",
"sequence_id": "null",
"type": "folder"
}
],
"total_count": 1
},
"purged_at": "2012-12-12T10:53:43-08:00",
"sequence_id": "3",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"shared_link": "null",
"size": 629644,
"trashed_at": "2012-12-12T10:53:43-08:00"
}