Skip to main content
API version 2024.0 A mini representation of a file, used when nested under another resource.
This resource has a few variations that can be encountered when using the API.The fields that are part of the mini variant are generally returned when the resource is nested within the response for another resource.
​
id
string
example: 12345The 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.
​
type
string
example: fileThe value will always be file.Value is always file
​
etag
string
example: 1The 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.
​
file_version
File version (Mini)object
The information about the current version of the file.
​
name
string
example: Contract.pdfThe name of the file.
​
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.
​
sha1
string(digest)
example: 85136C79CBF9FE36BB9D05D0639C70C265C18D37The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.
{
  "id": "12345",
  "type": "file",
  "etag": "1",
  "file_version": {
    "id": "12345",
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "name": "Contract.pdf",
  "sequence_id": "3",
  "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
}