Skip to main content
API version 2024.0 Represents a folder restored from the trash.
​
id
string
example: 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.
​
type
string
example: folderThe value will always be folder.Value is always folder
​
content_created_at
string(date-time)
example: 2012-12-12T10:53:43-08:00The date and time at which this folder was originally created.
​
content_modified_at
string(date-time)
example: 2012-12-12T10:53:43-08:00The date and time at which this folder was last updated.
​
created_at
string(date-time)
example: 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.
​
created_by
User (Mini)object
The user who created this folder.
​
description
string
example: Legal contracts for the new ACME dealThe optional description of this folder.
​
etag
string
example: 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.
​
folder_upload_email
string
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.
​
item_status
string
example: activeDefines 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: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.
​
modified_by
User (Mini)object
The user who last modified this folder.
​
name
string
example: ContractsThe name of the folder.
​
owned_by
User (Mini)object
The user who owns this folder.
​
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.
​
path_collection
object
The tree of folders that this file is contained in, starting at the root.
​
purged_at
string
The time at which this folder is expected to be purged from the trash - becomes null after restore.
​
sequence_id
string
example: 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.
​
shared_link
string
The shared link for this file. This will be null if a folder had been trashed, even though the original shared link does become active again.
​
size
integer(int64)
example: 629644The folder size in bytes.Be careful parsing this integer as its value can get very large.
​
trashed_at
string
The time at which this folder was put in the trash - becomes null after restore.
{
  "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": "[email protected]",
    "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": "[email protected]",
    "name": "Aaron Levie"
  },
  "name": "Contracts",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "1",
        "id": "12345",
        "type": "folder",
        "name": "Contracts",
        "sequence_id": "3"
      }
    ],
    "total_count": 1
  },
  "purged_at": "null",
  "sequence_id": "3",
  "shared_link": "null",
  "size": 629644,
  "trashed_at": "null"
}