Box

Usage Instructions

Integrate Box into your workflow to manage files, folders, and e-signatures. Upload and download files, search content, create folders, send documents for e-signature, track signing status, and more.

Tools

`box_upload_file`

Input

Parameter	Type	Required	Description
`parentFolderId`	string	Yes	The ID of the folder to upload the file to (use "0" for root)
`file`	file	No	No description
`fileContent`	string	No	No description
`fileName`	string	No	No description

Output

Parameter	Type	Description
`id`	string	File ID
`name`	string	File name
`size`	number	File size in bytes
`sha1`	string	SHA1 hash of file content
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name

`box_download_file`

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	No description

Output

Parameter	Type	Description
`file`	file	Downloaded file stored in execution files
`content`	string	Base64 encoded file content

`box_get_file_info`

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	File ID
`name`	string	File name
`description`	string	File description
`size`	number	File size in bytes
`sha1`	string	SHA1 hash of file content
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`createdBy`	object	User who created the file
`modifiedBy`	object	User who last modified the file
`ownedBy`	object	User who owns the file
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name
`sharedLink`	json	Shared link details
`tags`	array	File tags
`commentCount`	number	Number of comments

`box_list_folder_items`

Input

Parameter	Type	Required	Description
`folderId`	string	Yes	The ID of the folder to list items from (use "0" for root)
`limit`	number	No	No description
`offset`	number	No	No description
`sort`	string	No	No description
`direction`	string	No	No description

Output

Parameter	Type	Description
`entries`	array	List of items in the folder
↳ `type`	string	Item type (file, folder, web_link)
↳ `id`	string	Item ID
↳ `name`	string	Item name
↳ `size`	number	Item size in bytes
↳ `createdAt`	string	Creation timestamp
↳ `modifiedAt`	string	Last modified timestamp
`totalCount`	number	Total number of items in the folder
`offset`	number	Current pagination offset
`limit`	number	Current pagination limit

`box_create_folder`

Input

Parameter	Type	Required	Description
`name`	string	Yes	No description
`parentFolderId`	string	Yes	The ID of the parent folder (use "0" for root)

Output

Parameter	Type	Description
`id`	string	Folder ID
`name`	string	Folder name
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name

`box_delete_file`

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	No description

Output

Parameter	Type	Description
`deleted`	boolean	Whether the file was successfully deleted
`message`	string	Success confirmation message

`box_delete_folder`

Input

Parameter	Type	Required	Description
`folderId`	string	Yes	No description
`recursive`	boolean	No	No description

Output

Parameter	Type	Description
`deleted`	boolean	Whether the folder was successfully deleted
`message`	string	Success confirmation message

`box_copy_file`

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	No description
`parentFolderId`	string	Yes	No description
`name`	string	No	No description

Output

Parameter	Type	Description
`id`	string	File ID
`name`	string	File name
`size`	number	File size in bytes
`sha1`	string	SHA1 hash of file content
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name

`box_search`

Input

Parameter	Type	Required	Description
`query`	string	Yes	No description
`limit`	number	No	No description
`offset`	number	No	No description
`ancestorFolderId`	string	No	No description
`fileExtensions`	string	No	No description
`type`	string	No	No description

Output

Parameter	Type	Description
`results`	array	Search results
↳ `type`	string	Item type (file, folder, web_link)
↳ `id`	string	Item ID
↳ `name`	string	Item name
↳ `size`	number	Item size in bytes
↳ `createdAt`	string	Creation timestamp
↳ `modifiedAt`	string	Last modified timestamp
↳ `parentId`	string	Parent folder ID
↳ `parentName`	string	Parent folder name
`totalCount`	number	Total number of matching results

`box_update_file`

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	No description
`name`	string	No	No description
`description`	string	No	No description
`parentFolderId`	string	No	No description
`tags`	string	No	No description

Output

Parameter	Type	Description
`id`	string	File ID
`name`	string	File name
`description`	string	File description
`size`	number	File size in bytes
`sha1`	string	SHA1 hash of file content
`createdAt`	string	Creation timestamp
`modifiedAt`	string	Last modified timestamp
`createdBy`	object	User who created the file
`modifiedBy`	object	User who last modified the file
`ownedBy`	object	User who owns the file
`parentId`	string	Parent folder ID
`parentName`	string	Parent folder name
`sharedLink`	json	Shared link details
`tags`	array	File tags
`commentCount`	number	Number of comments

`box_sign_create_request`

Input

Parameter	Type	Required	Description
`sourceFileIds`	string	Yes	No description
`signerEmail`	string	Yes	No description
`signerRole`	string	No	No description
`additionalSigners`	string	No	JSON array of additional signers, e.g. [{"email":"user@example.com","role":"signer"}]
`parentFolderId`	string	No	No description
`emailSubject`	string	No	No description
`emailMessage`	string	No	No description
`name`	string	No	No description
`daysValid`	number	No	No description
`areRemindersEnabled`	boolean	No	No description
`areTextSignaturesEnabled`	boolean	No	No description
`signatureColor`	string	No	No description
`redirectUrl`	string	No	No description
`declinedRedirectUrl`	string	No	No description
`isDocumentPreparationNeeded`	boolean	No	No description
`externalId`	string	No	No description

Output

Parameter	Type	Description
`id`	string	Sign request ID
`status`	string	Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
`name`	string	Sign request name
`shortId`	string	Human-readable short ID
`signers`	array	List of signers
`sourceFiles`	array	Source files for signing
`emailSubject`	string	Custom email subject line
`emailMessage`	string	Custom email message body
`daysValid`	number	Number of days the request is valid
`createdAt`	string	Creation timestamp
`autoExpireAt`	string	Auto-expiration timestamp
`prepareUrl`	string	URL for document preparation (if preparation is needed)
`senderEmail`	string	Email of the sender

`box_sign_get_request`

Input

Parameter	Type	Required	Description
`signRequestId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	Sign request ID
`status`	string	Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
`name`	string	Sign request name
`shortId`	string	Human-readable short ID
`signers`	array	List of signers
`sourceFiles`	array	Source files for signing
`emailSubject`	string	Custom email subject line
`emailMessage`	string	Custom email message body
`daysValid`	number	Number of days the request is valid
`createdAt`	string	Creation timestamp
`autoExpireAt`	string	Auto-expiration timestamp
`prepareUrl`	string	URL for document preparation (if preparation is needed)
`senderEmail`	string	Email of the sender

`box_sign_list_requests`

Input

Parameter	Type	Required	Description
`limit`	number	No	No description
`marker`	string	No	No description

Output

Parameter	Type	Description
`signRequests`	array	List of sign requests
↳ `id`	string	Sign request ID
↳ `status`	string	Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
↳ `name`	string	Sign request name
↳ `shortId`	string	Human-readable short ID
↳ `signers`	array	List of signers
↳ `sourceFiles`	array	Source files for signing
↳ `emailSubject`	string	Custom email subject line
↳ `emailMessage`	string	Custom email message body
↳ `daysValid`	number	Number of days the request is valid
↳ `createdAt`	string	Creation timestamp
↳ `autoExpireAt`	string	Auto-expiration timestamp
↳ `prepareUrl`	string	URL for document preparation (if preparation is needed)
↳ `senderEmail`	string	Email of the sender
`count`	number	Number of sign requests returned in this page
`nextMarker`	string	Marker for next page of results

`box_sign_cancel_request`

Input

Parameter	Type	Required	Description
`signRequestId`	string	Yes	No description

Output

Parameter	Type	Description
`id`	string	Sign request ID
`status`	string	Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing)
`name`	string	Sign request name
`shortId`	string	Human-readable short ID
`signers`	array	List of signers
`sourceFiles`	array	Source files for signing
`emailSubject`	string	Custom email subject line
`emailMessage`	string	Custom email message body
`daysValid`	number	Number of days the request is valid
`createdAt`	string	Creation timestamp
`autoExpireAt`	string	Auto-expiration timestamp
`prepareUrl`	string	URL for document preparation (if preparation is needed)
`senderEmail`	string	Email of the sender

`box_sign_resend_request`

Input

Parameter	Type	Required	Description
`signRequestId`	string	Yes	No description

Output

Parameter	Type	Description
`message`	string	Success confirmation message

On this page