Skip to main content
API version 2024.0 A full representation of a file version, as can be returned from any file version API endpoints by default.
This resource has a few variations that can be encountered when using the API.The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.
​
id
string
example: 12345The unique identifier that represent a file version.
​
type
string
example: file_versionThe value will always be file_version.Value is always file_version
​
created_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the file version object was created.
​
modified_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the file version object was last updated.
​
modified_by
User (Mini)object
The user who last updated the file version.
​
name
string
example: tigers.jpegThe name of the file version.
​
purged_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the file version object will be permanently deleted.
​
restored_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the file version was restored from the trash.
​
restored_by
User (Mini)object
The user who restored the file version from the trash.
​
sha1
string
example: 134b65991ed521fcfe4724b7d814ab8ded5185dcThe SHA1 hash of this version of the file.
​
size
integer(int64)
example: 629644Size of the file version in bytes.
​
trashed_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the file version object was trashed.
​
trashed_by
User (Mini)object
The user who trashed the file version.
​
uploader_display_name
string
example: Ellis WigginsThe display name of the user that uploaded the file. In most cases this is the name of the user logged in at the time of the upload.If the file was uploaded using a File Request form that requires the user to provide an email address, this field is populated with that email address. If an email address was not required in the File Request form, this field is set to return a value of File Request.In all other anonymous cases where no email was provided this field will default to a value of Someone.
​
version_number
string
example: 1The version number of this file version.
{
  "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": "[email protected]",
    "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": "[email protected]",
    "name": "Aaron Levie"
  },
  "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
  "size": 629644,
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "trashed_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "uploader_display_name": "Ellis Wiggins",
  "version_number": "1"
}