Box Developer Documentation
Log in
Latest version

Get file version

get
https://api.box.com/2.0
/files/:file_id/versions/:file_version_id

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The unique identifier that represents 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.

stringin pathrequired
1234

The ID of the file version

Query Parameters

string arrayin queryoptional
id,type,name

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Response

application/jsonFile version (Full)

Returns a specific version of a file.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.

application/jsonClient error

An unexpected client error.

get
Get file version
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/versions/456456" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.fileVersions.getFileVersionById(
  file.id,
  fileVersions.entries![0].id,
  {
    queryParams: {
      fields: [
        'trashed_at' as string,
        'trashed_by' as string,
        'restored_at' as string,
        'restored_by' as string,
      ],
    } satisfies GetFileVersionByIdQueryParams,
  } satisfies GetFileVersionByIdOptionalsInput,
);
Python Gen
client.file_versions.get_file_version_by_id(
    file.id,
    file_versions.entries[0].id,
    fields=["trashed_at", "trashed_by", "restored_at", "restored_by"],
)
.NET Gen
await client.FileVersions.GetFileVersionByIdAsync(fileId: file.Id, fileVersionId: NullableUtils.Unwrap(fileVersions.Entries)[0].Id, queryParams: new GetFileVersionByIdQueryParams() { Fields = Array.AsReadOnly(new [] {"trashed_at","trashed_by","restored_at","restored_by"}) });

Response Example

{
  "id": "12345",
  "type": "file_version",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "tigers.jpeg",
  "purged_at": "2012-12-12T10:53:43-08:00",
  "restored_at": "2012-12-12T10:53:43-08:00",
  "restored_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
  "size": 629644,
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "trashed_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "uploader_display_name": "Ellis Wiggins",
  "version_number": "1"
}