View as Markdown
Box icon

Box ACTION

List Folder Items

Lists files, folders, and web links in a Box folder. Use 0 for the root folder. Returns one page of results (default 100, max 1000), with next_marker for paging, or total_count and offset when Offset is set or the root folder is sorted. To find items by name or metadata across all folders, use Search Content instead. 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 Folder Items 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-folder-items",
  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 Folder Items inputs
Property Type Description
folderId Folder string
The folder to list items 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, e.g. name. Sorting the root folder (0) switches to offset-based pagination, so page with Offset instead of Marker.
Optional
direction Direction string
The direction to sort results in
Optional
limit Limit integer
The maximum number of items 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. Keep the same Sort and Direction across pages. Cannot be combined with Offset or with Sort on the root folder (0).
Optional
offset Offset integer
The index of the first item to return, e.g. 100. Switches to offset-based pagination, which is also used automatically when sorting the root folder (0). To get the next page, add Limit to the previous offset; stop when it reaches total_count. Box notes offset pagination may be unreliable at very high offsets. Cannot be combined with Marker.
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-folder-items
Version
0.1.0
App
Box
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes