Skip to main content

A mini representation of a file, used when nested under another resource.

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