Drivebase Logo

Folders Methods

Most-used @drivebase/sdk folder methods with examples.

Use client.folders for reading and mutating folder structure.

list

List folders by parent.

const folders = await client.folders.list({
  parentId: "parent_123", // optional
  providerIds: ["provider_1"], // optional
});

Omit parentId to fetch root folders.

get

Get a folder by ID.

const folder = await client.folders.get("folder_123");
if (!folder) {
  console.log("Folder not found");
}

create

Create a folder in a provider (optionally under a parent).

const created = await client.folders.create({
  name: "Invoices",
  providerId: "provider_123",
  parentId: "parent_123", // optional
});

rename, move, delete

await client.folders.rename("folder_123", "Archive");
await client.folders.move("folder_123", "new_parent_id");
await client.folders.delete("folder_123");

Pass null or undefined to move parent ID to move a folder to root.

starred, star, unstar

const starredFolders = await client.folders.starred();
await client.folders.star("folder_123");
await client.folders.unstar("folder_123");

On this page