Trashed File

Represents a trashed file.

id string

example"123456789"

The 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.

type string

example"file"

file

Value is always file

content_created_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time at which this file was originally created, which might be before it was uploaded to Box.

content_modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time at which this file was last updated, which might be before it was uploaded to Box.

created_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time when the file was created on Box.

created_byUser (Mini) object

The user who created this file

description string

example"Contract for Q1 renewal"max length256

The optional description of this file

etag string

example"1"

The 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.

file_versionFile version (Mini) object

The information about the current version of the file.

item_status string

example"trashed"

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.

Value is one of active,trashed,deleted

modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time when the file was last updated on Box.

modified_byUser (Mini) object

The user who last modified this file

name string

example"Contract.pdf"

The name of the file

owned_byUser (Mini) object

The user who owns this file

parentFolder (Mini) object

The folder that this file is located within.

path_collection object

The tree of folders that this file is contained in, starting at the root.

path_collection.entries object array

Array of folders for this item's path collection

[entries].id string

example"123456789"

The unique identifier that represent a folder.

[entries].type string

example"folder"

folder

Value is always folder

[entries].etag string

examplenull

This field is null for the Trash folder

[entries].name string

example"Trash"

The name of the Trash folder.

[entries].sequence_id string

examplenull

This field is null for the Trash folder

path_collection.total_count integer / int64

example1

The number of folders in this list.

purged_at string / date-time

example"2012-12-12T10:53:43-08:00"

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

sequence_id string

example"3"

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.

sha1 string / digest

example"85136C79CBF9FE36BB9D05D0639C70C265C18D37"

The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.

shared_link string

examplenull

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

size integer

example629644

The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow.

trashed_at string / date-time

example"2012-12-12T10:53:43-08:00"

The 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": [
      {
        "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",
  "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
  "shared_link": "null",
  "size": 629644,
  "trashed_at": "2012-12-12T10:53:43-08:00"
}