Common ModelsFiles

/files/{id}

Returns a File object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
namestring or null<=254 characters
The file's name.
file_urlstring or null<=2000 characters
The URL to access the file.
file_thumbnail_urlstring or null<=2000 characters
The URL that produces a thumbnail preview of the file. Typically an image.
sizelong or null-9223372036854776000-9223372036854776000
The file's size, in bytes.
mime_typestring or null<=128 characters
The file's mime type.
descriptionstring or null<=2000 characters
The file's description.
folderstring or nullformat: "uuid"
The folder that the file belongs to.
checksummap from strings to any or null

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 objects
drivestring or nullformat: "uuid"
The drive that the file belongs to.
remote_created_atdatetime or null
When the third party's file was created.
remote_updated_atdatetime or null
When the third party's file was updated.
remote_was_deletedbooleanRead-only

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 nullRead-only
remote_datalist of objects or nullRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information