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 exists.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
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_folderUUIDOptional
The folder that the folder belongs to.
driveUUIDOptional
The drive that the folder belongs to.
permissionsPermission[]Required
The Permission object
The Permission object is used to represent a user's or group's access to a File or Folder. Permissions are unexpanded by default.
Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
userUUIDOptional
The user that is granted this permission. This will only be populated if the type is
USER.groupUUIDOptional
The group that is granted this permission. This will only be populated if the type is
GROUP.typeEnumOptional
Denotes what type of people have access to the file. Possible values include:
USER, GROUP, COMPANY, ANYONE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.rolesArrayOptional
The permissions that the user or group has for the File or Folder. It is possible for a user or group to have multiple roles, such as viewing & uploading. Possible values include:
READ, WRITE, OWNER. In cases where there is no clear mapping, the original value passed through will be returned.remote_created_atDateTime (ISO 8601)Optional
When the third party's folder was created.
remote_updated_atDateTime (ISO 8601)Optional
When the third party's folder was updated.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataArrayOptional
GET
/folders
https://api.merge.dev/api/filestorage/v1/folders
US
EU
APAC
Returns a list of Folder objects.
Query & Path Parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
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
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
nameStringOptional
If provided, will only return folders with this name. This performs an exact match.
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.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Box
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringfolder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)remote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)sizeInteger
Dropbox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
folder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)sizeInteger
Google Drive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringdriveUUIDfolder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)remote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)
OneDrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
driveUUIDfolder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)remote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)sizeInteger
SharePoint
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
driveUUIDfolder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)remote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)sizeIntegerPOST
/folders
Betahttps://api.merge.dev/api/filestorage/v1/folders
US
EU
APAC
Creates a Folder object with the given values.
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_folderUUIDThe folder that the folder belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the Folder object.driveUUIDThe drive that the folder belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the Drive object.permissionsArrayintegration_paramsObjectlinked_account_paramsObjectField support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Box
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
descriptionStringOptional
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
permissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sizeIntegerOptional
Dropbox
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
remote_idStringOptional
Google Drive
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
descriptionStringOptional
driveUUIDOptional
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
permissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
OneDrive
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
driveUUIDOptional
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
permissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sizeIntegerOptional
SharePoint
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
driveUUIDRequired
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
permissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sizeIntegerOptional
To include the correct model fields when making POST requests, use the GET /folders/meta/post endpoint. Learn more in our /meta guide.
GET
/folders/{id}
https://api.merge.dev/api/filestorage/v1/folders/{id}
US
EU
APAC
Returns a Folder object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Box
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringfolder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)remote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)sizeIntegerDropbox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
folder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)sizeIntegerGoogle Drive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
descriptionStringdriveUUIDfolder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)remote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)OneDrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
driveUUIDfolder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)remote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)sizeIntegerSharePoint
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
driveUUIDfolder_urlStringnameStringparent_folderUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)remote_dataArrayremote_idStringremote_updated_atDateTime (ISO 8601)sizeIntegerGET
/folders/meta/post
https://api.merge.dev/api/filestorage/v1/folders/meta/post
US
EU
APAC
Returns metadata for FileStorageFolder POSTs.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Box
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
descriptionStringOptional
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
permissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sizeIntegerOptional
Dropbox
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
remote_idStringOptional
Google Drive
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
descriptionStringOptional
driveUUIDOptional
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
permissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
OneDrive
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
driveUUIDOptional
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
permissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sizeIntegerOptional
SharePoint
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
driveUUIDRequired
folder_urlStringOptional
nameStringRequired
parent_folderUUIDOptional
permissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sizeIntegerOptional