Box
API actions for the Box integration.
Box
Upload, share, and manage files stored in Box.
Create shared link
Create or fetch a shared link for a Box file with optional permissions.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_id | string | Yes | Box file ID |
access | string | No | Access level |
allow_download | boolean | No | Allow downloads |
allow_preview | boolean | No | Allow previews |
Response
{
"shared_link": "https://box.com/s/abc123xyz789def456"
}Download file
Download a Box file to a specific path on disk.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_id | string | Yes | Box file ID |
destination_path | string | Yes | Destination file path |
Response
{
"downloaded_path": "/tmp/downloads/report.pdf"
}List folder items
Return the files and subfolders for a given Box folder.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folder_id | string | Yes | Box folder ID |
limit | number | No | Maximum items to return |
offset | number | No | First item index |
Response
{
"items": [
{
"id": "987654321",
"name": "report.pdf",
"type": "file"
}
]
}Upload file
Upload a local file into a Box folder and return a shareable link.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folder_id | string | Yes | Box folder ID |
file_path | string | Yes | Uploaded file reference for the file to upload. |
file_name | string | No | Uploaded file name override |
Response
{
"file_id": "123456789",
"file_link": "https://app.box.com/file/123456789"
}