Folders
TheFolder object is used to represent a collection of files and/or folders in the workspace. Could be within a drive, if it exsts.The Folder object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
nameStringOptional
The folder's name.
folder_urlStringOptional
The URL to access the folder.
sizeIntegerOptional
The folder's size, in bytes.
descriptionStringOptional
The folder's description.
parent_folderStringOptional
The folder that the folder belongs to.
driveStringOptional
The drive that the folder belongs to.
remote_created_atStringOptional
When the third party's folder was created.
remote_updated_atStringOptional
When the third party's folder was updated.
field_mappingsObjectOptional
remote_dataArrayOptional
The Folder object
JSON
{"id": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_id": "14","name": "Platform","folder_url": "https://drive.com/1234","size": 2738000,"description": "This is a wild folder.","parent_folder": "47ce474c-asdf-34a2-754r-629f799f7d31","drive": "31ce474c-asdf-34a2-754r-629f799f7d12","remote_created_at": "2022:02:02T00:00:00Z","remote_updated_at": "2022:02:03T00:00:00Z",Show advanced fields}
GET
/folders
Returns a list of Folder 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.
drive_idStringOptional
If provided, will only return folders in this drive.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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 folders with this name.
page_sizeIntegerOptional
Number of results to return per page.
parent_folder_idStringOptional
If provided, will only return folders in this parent folder. If null, will return folders in root directory.
remote_idStringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_id": "14","name": "Platform","folder_url": "https://drive.com/1234","size": 2738000,"description": "This is a wild folder.","parent_folder": "47ce474c-asdf-34a2-754r-629f799f7d31","drive": "31ce474c-asdf-34a2-754r-629f799f7d12","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
descriptionStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeInteger
Dropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
folder_urlStringnameStringparent_folderStringremote_dataArrayremote_idStringremote_updated_atStringsizeInteger
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringdriveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeInteger
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringdriveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeInteger
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
driveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerHint: Use the /linked-accounts endpoint to pull platform support information.
POST
/folders
Creates a Folder 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 folder's name.
folder_urlStringThe URL to access the folder.
sizeIntegerThe folder's size, in bytes.
descriptionStringThe folder's description.
parent_folderStringThe folder that the folder belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the Parent_folder table.driveStringThe drive that the folder belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the Drive table.integration_paramsObjectlinked_account_paramsObjectPOST v1/folders
JSON
{"model": {"name": "Platform","folder_url": "https://drive.com/1234","size": 2738000,"description": "This is a wild folder.","parent_folder": "47ce474c-asdf-34a2-754r-629f799f7d31","drive": "31ce474c-asdf-34a2-754r-629f799f7d12"}}
Response
JSON
{"model": {"id": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_id": "14","name": "Platform","folder_url": "https://drive.com/1234","size": 2738000,"description": "This is a wild folder.","parent_folder": "47ce474c-asdf-34a2-754r-629f799f7d31","drive": "31ce474c-asdf-34a2-754r-629f799f7d12","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
folder_urlStringOptional
nameStringRequired
parent_folderStringOptional
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sizeIntegerOptional
Dropbox
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
folder_urlStringOptional
nameStringRequired
parent_folderStringOptional
remote_idStringOptional
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
descriptionStringOptional
driveStringOptional
folder_urlStringOptional
nameStringRequired
parent_folderStringOptional
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
driveStringOptional
folder_urlStringOptional
nameStringRequired
parent_folderStringOptional
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sizeIntegerOptional
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
driveStringRequired
folder_urlStringOptional
nameStringRequired
parent_folderStringOptional
remote_created_atStringOptional
remote_idStringOptional
remote_updated_atStringOptional
sizeIntegerOptional
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/folders/{id}
Returns a Folder 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": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_id": "14","name": "Platform","folder_url": "https://drive.com/1234","size": 2738000,"description": "This is a wild folder.","parent_folder": "47ce474c-asdf-34a2-754r-629f799f7d31","drive": "31ce474c-asdf-34a2-754r-629f799f7d12","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
descriptionStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerDropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
folder_urlStringnameStringparent_folderStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerGoogle Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringdriveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerOneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringdriveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerSharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
driveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/folders/meta/post
Returns metadata for FileStorageFolder 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
descriptionStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerDropbox
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
folder_urlStringnameStringparent_folderStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerGoogle Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringdriveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerOneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
descriptionStringdriveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerSharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
driveStringfolder_urlStringnameStringparent_folderStringremote_created_atStringremote_dataArrayremote_idStringremote_updated_atStringsizeIntegerHint: Use the /linked-accounts endpoint to pull platform support information.