Files
TheFile object is used to represent a file in the workspace. The Object typically exists under a folder or drive, if it exists.The File object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
nameStringOptional
The file's name.
file_urlStringOptional
The URL to access the file.
sizeIntegerOptional
The file's size, in bytes.
mime_typeStringOptional
The file's mime type.
descriptionStringOptional
The file's description.
folderStringOptional
The folder that the file belongs to.
remote_created_atStringOptional
When the third party's file was created.
remote_updated_atStringOptional
When the third party's file was updated.
field_mappingsObjectOptional
remote_dataArrayOptional
The File object
JSON
{"id": "45ce474c-dhcj-43a6-754r-629f799f7d68","remote_id": "12","name": "omg_common_model_scope.docx","file_url": "https://drive.com/1234","size": 254,"mime_type": ".docx","description": "This file is OP","folder": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_created_at": "2022:02:02T00:00:00Z","remote_updated_at": "2022:02:03T00:00:00Z",Show advanced fields}
GET
/files
Returns a list of File objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
folder_idStringOptional
If provided, will only return files in this folder. If null, will return files in root directory.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
nameStringOptional
If provided, will only return files with this name.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "45ce474c-dhcj-43a6-754r-629f799f7d68","remote_id": "12","name": "omg_common_model_scope.docx","file_url": "https://drive.com/1234","size": 254,"mime_type": ".docx","description": "This file is OP","folder": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_created_at": "2022:02:02T00:00:00Z","remote_updated_at": "2022:02:03T00:00:00Z",Show advanced fields}]}
Field support by platform
Box
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeInteger
Dropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfolderStringmime_typeStringnameStringremote_dataArrayremote_idStringremote_updated_atStringsizeInteger
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeInteger
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeInteger
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerHint: Use the /linked-accounts endpoint to pull platform support information.
POST
/files
Creates a File object with the given values.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.nameStringThe file's name.
file_urlStringThe URL to access the file.
sizeIntegerThe file's size, in bytes.
mime_typeStringThe file's mime type.
descriptionStringThe file's description.
folderStringThe folder that the file belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the Folder table.integration_paramsObjectlinked_account_paramsObjectPOST v1/files
JSON
{"model": {"name": "omg_common_model_scope.docx","file_url": "https://drive.com/1234","size": 254,"mime_type": ".docx","description": "This file is OP","folder": "56ce474c-asdf-34a2-754r-629f799f7d31"}}
Response
JSON
{"model": {"id": "45ce474c-dhcj-43a6-754r-629f799f7d68","remote_id": "12","name": "omg_common_model_scope.docx","file_url": "https://drive.com/1234","size": 254,"mime_type": ".docx","description": "This file is OP","folder": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_created_at": "2022:02:02T00:00:00Z","remote_updated_at": "2022:02:03T00:00:00Z",Show advanced fields}}
Field support by platform
Box
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
descriptionStringOptional
file_urlStringRequired
folderStringOptional
mime_typeStringOptional
nameStringRequired
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sizeIntegerOptional
Dropbox
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
file_urlStringRequired
folderStringOptional
mime_typeStringOptional
nameStringRequired
remote_idStringOptional
remote_updated_atStringOptional
sizeIntegerOptional
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
file_urlStringRequired
folderStringOptional
mime_typeStringRequired
nameStringRequired
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sizeIntegerOptional
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
file_urlStringRequired
folderStringOptional
mime_typeStringRequired
nameStringRequired
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sizeIntegerOptional
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
file_urlStringRequired
folderStringOptional
mime_typeStringRequired
nameStringRequired
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sizeIntegerOptional
Additional POST Parameters
integration_paramsObjectRequired
drive_merge_idStringRequired
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/files/{id}
Returns a File object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"id": "45ce474c-dhcj-43a6-754r-629f799f7d68","remote_id": "12","name": "omg_common_model_scope.docx","file_url": "https://drive.com/1234","size": 254,"mime_type": ".docx","description": "This file is OP","folder": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_created_at": "2022:02:02T00:00:00Z","remote_updated_at": "2022:02:03T00:00:00Z",Show advanced fields}
Field support by platform
Box
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerDropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfolderStringmime_typeStringnameStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerGoogle Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerOneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerSharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/files/meta/post
Returns metadata for FileStorageFile POSTs.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Response
JSON
{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}
Field support by platform
Box
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerDropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfolderStringmime_typeStringnameStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerGoogle Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerOneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringfile_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerSharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_urlStringfolderStringmime_typeStringnameStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerHint: Use the /linked-accounts endpoint to pull platform support information.