Common ModelsFiles

The File object

The File object is used to represent a file in the workspace. The Object typically exists under a folder or drive, if it exists.

idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
The datetime that this object was modified by Merge.
namestring or nullOptional<=254 characters
The file's name.
file_urlstring or nullOptional<=2000 characters
The URL to access the file.
file_thumbnail_urlstring or nullOptional<=2000 characters
The URL that produces a thumbnail preview of the file. Typically an image.
sizelong or nullOptional
The file's size, in bytes.
mime_typestring or nullOptional<=128 characters
The file's mime type.
descriptionstring or nullOptional<=2000 characters
The file's description.
folderstring or nullOptionalformat: "uuid"
The folder that the file belongs to.
checksummap from strings to any or nullOptional

This field stores file checksum data. ‘type’ indicates the algorithm (e.g. crc_32, sha1, sha256, quickXor, or md5), and ‘content_hash’ is the unique hash used to verify file integrity and detect alterations.

permissionslist of objectsOptional
drivestring or nullOptionalformat: "uuid"
The drive that the file belongs to.
remote_created_atdatetime or nullOptional
When the third party's file was created.
remote_updated_atdatetime or nullOptional
When the third party's file was updated.
remote_was_deletedbooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptional
remote_datalist of objects or nullOptional