Get Folder
box.get_folder
ActionFiles & storageconnection required
Calls the Box API with the connection's credentials.
Read a folder's metadata — name, parent, description and shared link — without listing its contents.
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
2 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 inspect. Use '0' for the account root. | string | Yes | — | — | 0 |
fields Comma-separated list of extra attributes to return, such as 'shared_link,item_collection'. | string | No | — | — | — |
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 |
|---|---|---|
id The Box folder id. | string | — |
type Always 'folder'. | string | folder |
name The folder name. | string | — |
etag The folder's etag, for optimistic concurrency. | string | — |
parent.id The id of the parent folder. | string | — |
created_at When the folder was created (RFC 3339). | string | — |
{
"created_at": "",
"etag": "",
"id": "",
"name": "",
"parent": {
"id": ""
},
"type": "folder"
}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 Get Folder 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.