Trashed Folder (Restored)

Represents a folder restored from the trash.

string
123456789

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.

string
folder

folder

Value is always folder

string / date-time
2012-12-12T10:53:43-08:00

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

string / date-time
2012-12-12T10:53:43-08:00

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

string / date-time
2012-12-12T10:53:43-08:00

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.

The user who created this folder

Legal contracts for the new ACME deal256

The optional description of this folder

string
1

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.

The folder upload email for this folder. This will be null if a folder has been trashed, even though the original upload email does become active again.

active

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

string / date-time
2012-12-12T10:53:43-08:00

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.

The user who last modified this folder.

string
Contracts

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

The parent folders for this item

1

The number of folders in this list.

string

The time at which this folder is expected to be purged from the trash - becomes null after restore.

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.

integer / int64
629644

The folder size in bytes.

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

string

The time at which this folder was put in the trash - becomes null after restore.

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": "active",
  "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": [
      {
        "id": "12345",
        "etag": "1",
        "type": "folder",
        "sequence_id": "3",
        "name": "Contracts"
      }
    ],
    "total_count": 1
  },
  "purged_at": "null",
  "sequence_id": "3",
  "shared_link": "null",
  "size": 629644,
  "trashed_at": "null"
}