Box
API actions for the Box integration.
Box
Upload, share, and manage files stored in Box.
Create shared link
Create a shared link for a Box file. You can control whether the link allows downloads and previews.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_id | string | Yes | |
access | string | No | Who can open the link. |
allow_download | boolean | No | Set to true to let people who can open the link to download the file. |
allow_preview | boolean | No | Set to true to let people who can open the link to preview the file. |
Response
{
"shared_link": "https://box.com/s/abc123xyz789def456"
}Download file
Download a file from Box.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_id | string | Yes |
Response
{
"document_ref": "doc_0123456789abcdef0123456789abcdef",
"file_name": "report.pdf"
}List folder items
List the files and subfolders inside a Box folder.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folder_id | string | Yes | The ID of the Box folder to look in. |
Response
{
"items": [
{
"id": "987654321",
"name": "report.pdf",
"type": "file"
}
]
}Upload file
Upload a file to a Box folder and get a shareable link.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
folder_id | string | Yes | |
file_path | string | Yes | |
file_name | string | No | A different name to save the file as in Box. If left blank, the original file name is used. |
Response
{
"file_id": "123456789",
"file_link": "https://app.box.com/file/123456789"
}