Search
box.search
ActionFiles & storageconnection required
Calls the Box API with the connection's credentials.
Search the account's content by keyword, narrowed by item type and by the folder subtrees to look inside.
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
7 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 |
|---|---|---|---|---|---|
query The search terms. Box matches file and folder names as well as indexed file content. | string | Yes | — | — | — |
item_type Restrict the results to one kind of item. | string | No | — | one of "file", "folder", "web_link" | — |
ancestor_folder_ids Comma-separated folder ids; only their subtrees are searched. | string | No | — | — | — |
file_extensions Comma-separated extensions to keep, such as 'pdf,docx'. | string | No | — | — | — |
scope Search only the user's own content, or the whole enterprise. | string | No | — | one of "user_content", "enterprise_content" | — |
limit How many results to return on this page. | number | No | — | 1–200 | — |
offset How many results to skip before this page starts. Box rejects an offset above 10000. | number | No | — | 0–10000 | — |
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 Search 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.