Box Developer Documentation
Log in

File version

A standard representation of a file version

Base
Mini
Standard

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

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
12345

The unique identifier that represent a file version.

string
file_version

Value is always file_version

string
134b65991ed521fcfe4724b7d814ab8ded5185dc

The SHA1 hash of this version of the file.

string / date-time
2012-12-12T10:53:43-08:00

When the file version object was created

string / date-time
2012-12-12T10:53:43-08:00

When the file version object was last updated

User (Mini) object

The user who last updated the file version

string
tigers.jpeg

The name of the file version

string / date-time
2012-12-12T10:53:43-08:00

When the file version object will be permanently deleted.

string / date-time
2012-12-12T10:53:43-08:00

When the file version was restored from the trash.

User (Mini) object

The user who restored the file version from the trash.

integer / int64
629644

Size of the file version in bytes

string / date-time
2012-12-12T10:53:43-08:00

When the file version object was trashed.

User (Mini) object

The user who trashed the file version

string
Ellis Wiggins

The display name of the user that uploaded the file. In most cases this is the name of the logged in user at the time of upload.

If this file was uploaded by a logged out user and an email address was provided on upload, then this field will return that email address.

If this file was uploaded using a File Request form then this field will be set to return a value of File Request. No email address will be added.

In all other anonymous cases where no email was provided this field will default to a value of "Someone".

Full

Response Example

{
  "created_at": "2012-12-12T10:53:43-08:00",
  "id": 12345,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "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,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
  "size": 629644,
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "trashed_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "type": "file_version",
  "uploader_display_name": "Ellis Wiggins"
}