Folders

The Folder 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


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The folder's name.

folder_urlString
Optional
The URL to access the folder.

sizeInteger
Optional
The folder's size, in bytes.

descriptionString
Optional
The folder's description.

parent_folderString
Optional
The folder that the folder belongs to.

driveString
Optional
The drive that the folder belongs to.

remote_created_atString
Optional
When the third party's folder was created.

remote_updated_atString
Optional
When the third party's folder was updated.

field_mappingsObject
Optional

remote_dataArray
Optional

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


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

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.

drive_idString
Optional
If provided, will only return folders in this drive.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

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.

nameString
Optional
If provided, will only return folders with this name.

page_sizeInteger
Optional
Number of results to return per page.

parent_folder_idString
Optional
If provided, will only return folders in this parent folder. If null, will return folders in root directory.

remote_idString
Optional
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

Box

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

Dropbox

Dropbox

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


folder_urlString

nameString

parent_folderString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

Google Drive

Google Drive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

OneDrive

OneDrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

SharePoint

SharePoint

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST

/folders

Creates a Folder object with the given values.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

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 folder's name.

folder_urlString
The URL to access the folder.

sizeInteger
The folder's size, in bytes.

descriptionString
The folder's description.

parent_folderString
The 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.

driveString
The 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_paramsObject

linked_account_paramsObject

POST 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

Box

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


descriptionString
Optional

folder_urlString
Optional

nameString
Required

parent_folderString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

sizeInteger
Optional

Dropbox

Dropbox

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


folder_urlString
Optional

nameString
Required

parent_folderString
Optional

remote_idString
Optional

Google Drive

Google Drive

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


descriptionString
Optional

driveString
Optional

folder_urlString
Optional

nameString
Required

parent_folderString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

OneDrive

OneDrive

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


driveString
Optional

folder_urlString
Optional

nameString
Required

parent_folderString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

sizeInteger
Optional

SharePoint

SharePoint

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


driveString
Required

folder_urlString
Optional

nameString
Required

parent_folderString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

sizeInteger
Optional
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/folders/{id}

Returns a Folder object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
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

Box

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

Dropbox

Dropbox

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


folder_urlString

nameString

parent_folderString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

Google Drive

Google Drive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

OneDrive

OneDrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

SharePoint

SharePoint

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/folders/meta/post

Returns metadata for FileStorageFolder POSTs.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
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

Box

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

Dropbox

Dropbox

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


folder_urlString

nameString

parent_folderString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

Google Drive

Google Drive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

OneDrive

OneDrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger

SharePoint

SharePoint

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


driveString

folder_urlString

nameString

parent_folderString

remote_created_atString

remote_dataArray

remote_idString

remote_updated_atString

sizeInteger
Hint: Use the /linked-accounts endpoint to pull platform support information.