File
object is used to represent a file in the workspace. The Object typically exists under a folder or drive, if it exists.id
UUIDremote_id
Stringname
Stringfile_url
Stringfile_thumbnail_url
Stringsize
Integermime_type
Stringdescription
Stringfolder
UUIDpermissions
Permission[]id
UUIDremote_id
Stringuser
UUIDgroup
UUIDtype
EnumUSER
, GROUP
, COMPANY
, ANYONE
. In cases where there is no clear mapping, the original value passed through will be returned.roles
ArrayREAD
, WRITE
, OWNER
. In cases where there is no clear mapping, the original value passed through will be returned.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)drive
UUIDremote_created_at
DateTime (ISO 8601)remote_updated_at
DateTime (ISO 8601)remote_was_deleted
Booleancreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)field_mappings
Objectremote_data
Arrayhttps://api.merge.dev/api/filestorage/v1/files
Returns a list of File
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringdrive_id
Stringexpand
Stringfolder_id
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)name
Stringpage_size
Integerremote_id
String
Supported Response Fields
description
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
file_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
description
Stringdrive
UUIDfile_thumbnail_url
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integerhttps://api.merge.dev/api/filestorage/v1/files
Creates a File
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectname
Stringfile_url
Stringfile_thumbnail_url
Stringsize
Integermime_type
Stringdescription
Stringfolder
UUIDid
field in the Folder object.permissions
Arraydrive
UUIDid
field in the Drive object.integration_params
Objectlinked_account_params
Object
Supported POST Model Parameters
description
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported POST Model Parameters
file_url
Stringfolder
UUIDmime_type
Stringname
Stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported POST Model Parameters
drive
UUIDfile_thumbnail_url
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported POST Model Parameters
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported POST Model Parameters
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integerhttps://api.merge.dev/api/filestorage/v1/files/{id}
Returns a File
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Boolean
Supported Response Fields
description
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
file_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
description
Stringdrive
UUIDfile_thumbnail_url
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integerhttps://api.merge.dev/api/filestorage/v1/files/{id}/download
Returns a File
object with the given id
.
id
UUIDmime_type
String
Supported Response Fields
description
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
file_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
description
Stringdrive
UUIDfile_thumbnail_url
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integerhttps://api.merge.dev/api/filestorage/v1/files/meta/post
Returns metadata for FileStorageFile
POSTs.

Supported Response Fields
description
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
file_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
description
Stringdrive
UUIDfile_thumbnail_url
Stringfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer
Supported Response Fields
drive
UUIDfile_url
Stringfolder
UUIDmime_type
Stringname
Stringpermissions
Permission[]id
stringremote_id
stringuser
stringgroup
stringtype
stringroles
arraycreated_at
stringmodified_at
stringremote_created_at
DateTime (ISO 8601)remote_data
Arrayremote_id
Stringremote_updated_at
DateTime (ISO 8601)size
Integer