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
id
Stringremote_id
Stringname
Stringfile_url
Stringsize
Integermime_type
Stringdescription
Stringfolder
Stringremote_created_at
Stringremote_updated_at
Stringfield_mappings
Objectremote_data
Array{"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}
/files
Returns a list of File
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringexpand
Stringfolder_id
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringname
Stringpage_size
Integerremote_id
String{"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}]}

Box
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
Dropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer/files
Creates a File
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
View app-specific writable fields under “Field support by platform” in this section.name
Stringfile_url
Stringsize
Integermime_type
Stringdescription
Stringfolder
Stringid
field in the Folder table.integration_params
Objectlinked_account_params
Object{"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"}}
{"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}}

Box
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringsize
Integer
Dropbox
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_id
Stringremote_updated_at
Stringsize
Integer
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringsize
Integer
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringsize
Integer
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringsize
IntegerAdditional POST Parameters
integration_params
Objectdrive_merge_id
String/files/{id}
Returns a File
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Boolean{"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}

Box
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
Dropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer/files/meta/post
Returns metadata for FileStorageFile
POSTs.
Header Parameters
Authorization
StringX-Account-Token
String{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

Box
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
Dropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
description
Stringfile_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
file_url
Stringfolder
Stringmime_type
Stringname
Stringremote_created_at
Stringremote_data
Arrayremote_id
Stringremote_updated_at
Stringsize
Integer