List Folder Items
box.list_folder_items
ActionFiles & storageconnection required
Calls the Box API with the connection's credentials.
List one page of the files and folders directly inside a folder.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Box
- Secret shape
- {"client_id": "…", "client_secret": "…", "box_subject_type": "enterprise|user", "box_subject_id": "…"} for a server-authentication app, or {"client_id": "…", "client_secret": "…", "refresh_token": "…"} for OAuth2
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
folder_id The id of the folder to list. Use '0' for the account root. | string | Yes | — | — | 0 |
limit How many items to return on this page. | number | No | — | 1–1000 | — |
offset How many items to skip before this page starts. | number | No | — | 0–1000000 | — |
fields Comma-separated list of extra attributes to return on each entry, such as 'size,modified_at'. | string | No | — | — | — |
sort Which attribute to order the page by. | string | No | — | one of "id", "name", "date", "size" | — |
direction Whether to sort ascending or descending. | string | No | — | one of "ASC", "DESC" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"folder_id": "0"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
entries The items on this page, each a Box file or folder object. | array | — |
count How many entries this page carries. | number | — |
total_count How many items Box says the collection holds. | number | — |
offset The offset this page started at. | number | — |
limit The page size Box actually applied. | number | — |
{
"count": 0,
"entries": [],
"limit": 0,
"offset": 0,
"total_count": 0
}Notes
- Uploads go to upload.box.com and everything else to api.box.com; the nodes pick the right host for you.
- Use a Box server-authentication (Client Credentials) app for anything unattended: its credential can be exchanged for a token indefinitely. A plain OAuth2 refresh token is spent by its first use, so that connection needs re-authorising.
- The root folder always has the id '0'.
See List Folder Items run in a workflow.
In a technical demo we add the Box connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.