Skip to main content

Represents a trashed folder.

​
id
string
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.

Example:

"123456789"

​
type
enum<string>
required

The value will always be folder.

Available options:
folder
Example:

"folder"

​
name
string
required

The name of the folder.

Example:

"Contracts"

​
description
string
required

The optional description of this folder.

Maximum string length: 256
Example:

"Legal contracts for the new ACME deal"

​
size
integer<int64>
required

The folder size in bytes.

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

Example:

629644

​
path_collection
Path collection (Trash) · object
required

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

​
created_by
User (Mini) · object
required

The user who created this folder.

​
modified_by
User (Mini) · object
required

The user who last modified this folder.

​
owned_by
User (Mini) · object
required

The user who owns this folder.

​
item_status
enum<string>
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.
Available options:
active,
trashed,
deleted
Example:

"trashed"

​
etag
string | null

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.

Example:

"1"

​
sequence_id
string | null

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.

Example:

"3"

​
created_at
string<date-time> | null

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.

Example:

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

​
modified_at
string<date-time> | null

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.

Example:

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

​
trashed_at
string<date-time> | null

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

Example:

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

​
purged_at
string<date-time> | null

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

Example:

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

​
content_created_at
string<date-time> | null

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

Example:

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

​
content_modified_at
string<date-time> | null

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

Example:

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

​
shared_link
string | null

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

Example:

null

​
folder_upload_email
string | null

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

Example:

null

​
parent
Folder (Mini) · object

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.