Drives
The Drive object is used to represent a drive that contains the folders and files in the user's workspace.
The Drive object
Properties

idString
Required

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

nameString
Optional
The drive's name.

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

drive_urlString
Optional
The drive's url.

field_mappingsObject
Optional

modified_atString
Required
This is the datetime that this object was last updated by Merge

remote_dataArray
Optional

The Drive object
JSON
{
"id": "31ce474c-asdf-34a2-754r-629f799f7d12",
"remote_id": "2039349",
"name": "Documents",
"remote_created_at": "2023-05-26T22:33:40.523Z",
"drive_url": "https://drive.com/drives/2039349",
Show advanced fields
}

GET
/drives

Returns a list of Drive 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.

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, only objects synced by Merge after this date time will be returned.

modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.

nameString
Optional
If provided, will only return drives with this name. This performs an exact match.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "31ce474c-asdf-34a2-754r-629f799f7d12",
"remote_id": "2039349",
"name": "Documents",
"remote_created_at": "2023-05-26T22:33:40.526Z",
"drive_url": "https://drive.com/drives/2039349",
Show advanced fields
}
]
}
Field support by platform
Google Drive
Google Drive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


drive_urlString

nameString

remote_created_atString

remote_dataArray

remote_idString
OneDrive
OneDrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


drive_urlString

nameString

remote_created_atString

remote_dataArray

remote_idString
SharePoint
SharePoint

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


drive_urlString

nameString

remote_created_atString

remote_dataArray

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/drives/{id}

Returns a Drive 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

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": "31ce474c-asdf-34a2-754r-629f799f7d12",
"remote_id": "2039349",
"name": "Documents",
"remote_created_at": "2023-05-26T22:33:40.529Z",
"drive_url": "https://drive.com/drives/2039349",
Show advanced fields
}
Field support by platform
Google Drive
Google Drive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


drive_urlString

nameString

remote_created_atString

remote_dataArray

remote_idString
OneDrive
OneDrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


drive_urlString

nameString

remote_created_atString

remote_dataArray

remote_idString
SharePoint
SharePoint

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


drive_urlString

nameString

remote_created_atString

remote_dataArray

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