Files
The File object is used to represent a file in the workspace. The Object typically exists under a folder or drive, if it exists.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
nameString
The file's name.
file_urlString
The URL to access the file.
file_thumbnail_urlString
The URL that produces a thumbnail preview of the file. Typically an image.
sizeInteger
The file's size, in bytes.
mime_typeString
The file's mime type.
descriptionString
The file's description.
folderUUID
The folder that the file belongs to.
checksumObject
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.
permissionsPermission[]
The Permission object
The Permission object is used to represent a user's or group's access to a File or Folder. Permissions are unexpanded by default.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
userUUID
The user that is granted this permission. This will only be populated if the type is USER.
groupUUID
The group that is granted this permission. This will only be populated if the type is GROUP.
typeEnum
Denotes what type of people have access to the file. Possible values include: USER, GROUP, COMPANY, ANYONE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
rolesArray
The permissions that the user or group has for the File or Folder. It is possible for a user or group to have multiple roles, such as viewing & uploading. Possible values include: READ, WRITE, OWNER. In cases where there is no clear mapping, the original value passed through will be returned.
driveUUID
The drive that the file belongs to.
remote_created_atDateTime (ISO 8601)
When the third party's file was created.
remote_updated_atDateTime (ISO 8601)
When the third party's file was updated.
remote_was_deletedBoolean
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
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The data returned from the third-party for this object in its original, unnormalized format.
GET
/files

https://api.merge.dev/api/filestorage/v1/files

US
EU
APAC

Returns a list of File objects.


Query & path parameters
created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
drive_idString
Optional
Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
folder_idString
Optional
Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.
include_deleted_dataBoolean
Optional
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.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
mime_typeString
Optional
If provided, will only return files with these mime_types. Multiple values can be separated by commas.
modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.
nameString
Optional
If provided, will only return files with this name. This performs an exact match.
order_byString
Optional
Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Box
Box
Dropbox
Dropbox
Google Drive
Google Drive
OneDrive
OneDrive
SharePoint
SharePoint
POST
/files
Beta

https://api.merge.dev/api/filestorage/v1/files

US
EU
APAC

Creates a File object with the given values.


Query & path parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.
nameString
The file's name.
file_urlString
The URL to access the file.
file_thumbnail_urlString
The URL that produces a thumbnail preview of the file. Typically an image.
sizeInteger
The file's size, in bytes.
mime_typeString
The file's mime type.
descriptionString
The file's description.
folderUUID
The folder that the file belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the Folder object.
checksumObject
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.
permissionsArray
driveUUID
The drive that the file belongs to. Must pass in a valid Merge ID, which can be obtained from the id field in the Drive object.
integration_paramsObject
linked_account_paramsObject
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Box
Box
Dropbox
Dropbox
Google Drive
Google Drive
OneDrive
OneDrive
SharePoint
SharePoint
To include the correct model fields when making POST requests, use the GET /files/meta/post endpoint. Learn more in our /meta guide.
GET
/files/{id}

https://api.merge.dev/api/filestorage/v1/files/{id}

US
EU
APAC

Returns a File object with the given id.


Query & path parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Box
Box
Dropbox
Dropbox
Google Drive
Google Drive
OneDrive
OneDrive
SharePoint
SharePoint
GET
/files/{id}/download

https://api.merge.dev/api/filestorage/v1/files/{id}/download

US
EU
APAC

Returns the File content with the given id as a stream of bytes.


Query & path parameters
idUUID
Required
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
mime_typeString
Optional
If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
GET
/files/{id}/download/request-meta

https://api.merge.dev/api/filestorage/v1/files/{id}/download/request-meta

US
EU
APAC

Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.


Query & path parameters
idUUID
Required
mime_typeString
Optional
If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
GET
/files/download/request-meta

https://api.merge.dev/api/filestorage/v1/files/download/request-meta

US
EU
APAC

Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.


Query & path parameters
created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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.
mime_typesString
Optional
A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article.
modified_afterString
Optional
If provided, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
order_byString
Optional
Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
page_sizeInteger
Optional
Number of results to return per page.
GET
/files/meta/post

https://api.merge.dev/api/filestorage/v1/files/meta/post

US
EU
APAC

Returns metadata for FileStorageFile POSTs.


Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Box
Box
Dropbox
Dropbox
Google Drive
Google Drive
OneDrive
OneDrive
SharePoint
SharePoint
Previous
Drives
Next Up
Folders