fetch_folder
List a folder you already have an id for, or the warehouse root. Pass folderId to list that folder's name, an optional parentFolderId to fetch and go up, and its direct contents. Each child folder and document includes its id, name, updatedAt, createdBy, and isPrivate. Each folder also includes contentCount, its direct documents plus subfolders, and subfolderCount, its direct child folders. Each document also includes its status: DRAFT, REVIEW, or PUBLISHED. A child folder also includes parentFolderId when it is nested, including a shared folder that shows up in the root listing but lives somewhere else; parentFolderId is omitted for a true top-level folder. Pass deep true with a folderId to return that folder and every nested folder as a tree, up to 15 levels, with each folder's documents inside it. deep is rejected for the warehouse root. Omit folderId to list the root one level: the top-level folders plus shared folders this user can see, not the whole warehouse and not other people's private folders. Not a search — use search to find a folder by name. Not a document read — use fetch to read a document.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deep | No | With folderId, return that folder and every nested folder as a tree of names and ids, up to 15 levels. Omit or pass false to list only direct children. Rejected when listing the warehouse root. | |
| folderId | No | The folder to list. Pass deep true to return this folder and every nested folder. Omit deep to list only direct children. Omit to list the warehouse root one level. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The folder name. Omitted when listing the root. | |
| folders | Yes | Child folders. Without deep, each entry is identity plus updatedAt, createdBy, isPrivate, and parentFolderId when nested. With deep, each entry also nests its own documents and folders. | |
| folderId | No | The folder you fetched. Omitted when listing the root. | |
| documents | Yes | ||
| resultType | Yes | ||
| parentFolderId | No | The parent folder. Fetch it to go up. Omitted at the root and for a top-level folder. |