Documentation

FoldersResource

Access via client.folders

tree()

Get the complete folder tree

async def tree() -> FolderTree
Returns: FolderTree - All folders as a flat list with parent relationships

get()

Get folder contents including subfolders and file info

async def get(
folder_id: str,
*,
limit: int = 50, # 1-100
offset: int = 0,
) -> FolderContents
Returns: FolderContents - Folder metadata, breadcrumbs, subfolders, and file counts

get_breadcrumbs()

Get the breadcrumb path for a folder

async def get_breadcrumbs(folder_id: str) -> FolderBreadcrumbs
Returns: FolderBreadcrumbs - Ancestor chain from root to this folder

create()

Create a new folder

async def create(
name: str, # 1-255 chars, no / \ or null bytes
*,
parent_id: Optional[str] = None, # None for root level
) -> Folder
Returns: Folder

rename()

Rename a folder

async def rename(
folder_id: str,
name: str, # 1-255 chars
) -> Folder
Returns: Folder

move()

Move a folder to a new parent

async def move(
folder_id: str,
*,
new_parent_id: Optional[str] = None, # None to move to root
) -> Folder
Returns: Folder

delete()

Delete a folder with configurable content handling

async def delete(
folder_id: str,
*,
mode: str = "move_to_parent", # "move_to_parent" | "delete_all"
) -> DeleteFolderResult

move_files()

Move files to a folder (max 100 per request)

async def move_files(
file_ids: list[str], # 1-100, no duplicates
*,
folder_id: Optional[str] = None, # None to move to root
) -> MoveFilesResult