Trashed Folder
Represents a trashed folder.
123456789The 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.
folderfolder
Value is always folder
2012-12-12T10:53:43-08:00The date and time at which this folder was originally created.
2012-12-12T10:53:43-08:00The date and time at which this folder was last updated.
2012-12-12T10:53:43-08:00The 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.
The user who created this folder
Legal contracts for the new ACME deal256The optional description of this folder
1The 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.
The folder upload email for this folder. This will
be null if a folder has been trashed, since the upload will no longer
work.
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 folder was last updated. This value may
be null for some folders such as the root folder or the trash
folder.
The user who last modified this folder.
ContractsThe name of the folder.
The user who owns this folder.
The optional folder that this folder is located within.
This value may be null for some folders such as the
root folder or the trash folder.
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 folder 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.
629644The folder size in bytes.
Be careful parsing this integer as its value can get very large.
2012-12-12T10:53:43-08:00The time at which this folder was put in the trash.
Response Example
{
"id": "123456789",
"type": "folder",
"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": "Legal contracts for the new ACME deal",
"etag": "1",
"folder_upload_email": "null",
"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": "Contracts",
"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": [
{
"type": "folder",
"id": "123456789",
"sequence_id": "null",
"etag": "null",
"name": "Trash"
}
],
"total_count": 1
},
"purged_at": "2012-12-12T10:53:43-08:00",
"sequence_id": "3",
"shared_link": "null",
"size": 629644,
"trashed_at": "2012-12-12T10:53:43-08:00"
}