For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
    • File Picker
          • The Folder object
          • GET/folders
          • POST/folders
          • GET/folders/{id}
          • GET/folders/meta/post
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsFolders

The Folder object

The Folder Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "name": "string",
7  "folder_url": "string",
8  "size": 99999,
9  "description": "string",
10  "parent_folder": "string",
11  "drive": "string",
12  "permissions": [
13    {
14      "id": "string",
15      "remote_id": "string",
16      "created_at": "2023-01-01T00:00:00Z",
17      "modified_at": "2023-01-01T00:00:00Z",
18      "user": "string",
19      "group": "string",
20      "type": "USER",
21      "roles": [
22        "READ"
23      ],
24      "remote_was_deleted": true,
25      "field_mappings": {}
26    }
27  ],
28  "remote_created_at": "2023-01-01T00:00:00Z",
29  "remote_updated_at": "2023-01-01T00:00:00Z",
30  "remote_was_deleted": true,
31  "field_mappings": {},
32  "remote_data": [
33    {
34      "path": "string",
35      "data": {}
36    }
37  ]
38}
Was this page helpful?
Previous

/files/meta/post

Next

/folders

Built with

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.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional<=254 characters
The folder's name.
folder_urlstring or nullOptional<=2000 characters
The URL to access the folder.
sizelong or nullOptional-9223372036854776000-9223372036854776000
The folder's size, in bytes.
descriptionstring or nullOptional<=2000 characters
The folder's description.
parent_folderstring or nullOptionalformat: "uuid"
The folder that the folder belongs to.
drivestring or nullOptionalformat: "uuid"
The drive that the folder belongs to.
permissionslist of objectsOptional
remote_created_atdatetime or nullOptional
When the third party's folder was created.
remote_updated_atdatetime or nullOptional
When the third party's folder was updated.
remote_was_deletedbooleanOptionalRead-only

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_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only