Box Developer Documentation
Log in

File (Base)

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

The bare basic representation of a file, the minimal amount of fields returned when using the fields query parameter.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

string
12345

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.

string
file

The value will always be file.

Value is always file

string
1

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.

Response Example

{
  "id": "12345",
  "type": "file",
  "etag": "1"
}