View as Markdown
Box icon

Box ACTION

List Folders

Lists the subfolders directly inside a Box folder. Use 0 for the root folder. Returns one page of results (default 100, max 1000). Use List Folder Items instead to also include files and web links. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Box account once, then configure and run List Folders from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "box-list-folders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    box: { authProvisionId: "apn_xxxxxxx" },
    folderId: "Folder",
    fields: ["Fields"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Folders inputs
Property Type Description
folderId Folder string
The folder to list subfolders from. Use 0 for the root folder.
Required Dynamic
fields Fields string[]
A comma-separated list of attributes to include in the response (e.g. id,type,name,size,created_at). See available fields.
Optional
sort Sort string
Defines the attribute by which items are sorted. Valid values: id, name, date, size (e.g. name). Not supported for the root folder (0) — Box does not allow sorting root-folder results with marker-based pagination.
Optional
direction Direction string
The direction to sort results in. Valid values: ASC (ascending) or DESC (descending) (e.g. ASC).
Optional
limit Limit integer
The maximum number of folders to return per page (max 1000)
Optional
marker Marker string
The position marker at which to begin returning results. Pass the next_marker value returned by a previous run of this action to continue listing beyond the first page, e.g. JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
box-list-folders
Version
0.0.2
App
Box
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes