Skip to main content

A standard representation of a file, as returned from any file API endpoints by default.

​
id
string
required

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.

Example:

"12345"

​
type
enum<string>
required

The value will always be file.

Available options:
file
Example:

"file"

​
etag
string | null

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.

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"

​
name
string

The name of the file.

Example:

"Contract.pdf"

​
sha1
string<digest>

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

Example:

"85136C79CBF9FE36BB9D05D0639C70C265C18D37"

​
file_version
File version (Mini) · object

The information about the current version of the file.

​
description
string

The optional description of this file. If the description exceeds 255 characters, the first 255 characters are set as a file description and the rest of it is ignored.

Maximum string length: 255
Example:

"Contract for Q1 renewal"

​
size
integer

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

Example:

629644

​
path_collection
Path collection · object

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

​
created_at
string<date-time>

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

Example:

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

​
modified_at
string<date-time>

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

Example:

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

​
trashed_at
string<date-time> | null

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

Example:

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

​
purged_at
string<date-time> | null

The time at which this file 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 file was originally created, which might be before it was uploaded to Box.

Example:

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

​
content_modified_at
string<date-time> | null

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

Example:

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

​
created_by
User (Mini) · object

The user who created this file.

​
modified_by
User (Mini) · object

The user who last modified this file.

​
owned_by
User (Mini) · object

The user who owns this file.

​
shared_link
Shared link · object

The shared link for this file. This value will be null if no shared link has been created for this file.

​
parent
Folder (Mini) · object

The folder that this file is located within. This value may be null for some folders such as the root folder or the trash folder.

​
item_status
enum<string>

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:

"active"