Appearance
Box
Manage files, folders, and collaborations on Box cloud storage.
| Detail | Value |
|---|---|
| Category | Productivity |
| Base URL | https://api.box.com/2.0 |
| Authentication | OAuth2 |
| Endpoints | 6 |
| Connector key | box |
Using Box in a workflow
- Go to Connections and click New Connection.
- Pick Box from the marketplace.
- Enter your credentials (see Authentication above for what's expected).
- In a workflow, drop an API Call node and select this connection.
- Pick the operation you need from the Operation dropdown — the full list is below.
Available endpoints
| Endpoint | Summary |
|---|---|
GET /folders/{folder_id} | Get a folder |
GET /folders/{folder_id}/items | List items in a folder |
GET /files/{file_id} | Get file info |
POST /files/content | Upload a file |
GET /search | Search for content |
POST /collaborations | Add a collaborator |
Each endpoint is documented in full below. Use the outline on the right to jump to one.
GET /folders/{folder_id}
Get a folder
| Detail | Value |
|---|---|
| Operation ID | storage.getFolder |
| Method | GET |
| Path | /folders/{folder_id} |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
folder_id | path | string | Yes |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Box connection from the Connection dropdown.
- In the Operation dropdown, select
storage.getFolder. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.
GET /folders/{folder_id}/items
List items in a folder
| Detail | Value |
|---|---|
| Operation ID | storage.listFolderItems |
| Method | GET |
| Path | /folders/{folder_id}/items |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
folder_id | path | string | Yes |
limit | query | integer | No |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Box connection from the Connection dropdown.
- In the Operation dropdown, select
storage.listFolderItems. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.
GET /files/{file_id}
Get file info
| Detail | Value |
|---|---|
| Operation ID | storage.getFile |
| Method | GET |
| Path | /files/{file_id} |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
file_id | path | string | Yes |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Box connection from the Connection dropdown.
- In the Operation dropdown, select
storage.getFile. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.
POST /files/content
Upload a file
| Detail | Value |
|---|---|
| Operation ID | storage.uploadFile |
| Method | POST |
| Path | /files/content |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
name | string |
parent | object |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Box connection from the Connection dropdown.
- In the Operation dropdown, select
storage.uploadFile. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.
GET /search
Search for content
| Detail | Value |
|---|---|
| Operation ID | storage.search |
| Method | GET |
| Path | /search |
Parameters
| Name | Location | Type | Required |
|---|---|---|---|
query | query | string | Yes |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Box connection from the Connection dropdown.
- In the Operation dropdown, select
storage.search. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.
POST /collaborations
Add a collaborator
| Detail | Value |
|---|---|
| Operation ID | storage.addCollaborator |
| Method | POST |
| Path | /collaborations |
Parameters
No parameters.
Request Body
| Field | Type |
|---|---|
item | object |
accessible_by | object |
role | string |
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Box connection from the Connection dropdown.
- In the Operation dropdown, select
storage.addCollaborator. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.