File Storage API

Files

Folders

Shared Links

Upload Sessions

Drives

DriveGroups

Box empowers your teams by making it easy to work with people inside and outside your organization, protect your valuable content, and connect all your apps.

connection

oauth_credentials

Box does not separate testing from production: one app's credentials work against any Box account, so whatever you do while testing happens in the live account you connected.

Connect a Box account you created for testing rather than one holding real files.

Authorization (when an administrator must act)

Create your first application

Application scopes

Rate limits

Files and folders

Sharing

Large uploads

The date and time when the object was created.

Created at (timestamp)

Created by

When custom mappings are configured on the resource, the result is included here.

Whether the current user can download this file

The third-party API ID of original entity

The available file formats when exporting this file.

An available file format (typically MIME type) to export this file.

Whether the current file is exportable to other file formats. This property is relevant for proprietary file formats such as Google Docs or Dropbox Paper.

The parent folders of the file, starting from the root

Whether the list of parent folders is complete. Some connectors only return the direct parent of a file

The full path of the file or folder (includes the file name)

Permissions the current user has on this file.

Whether the current user can download this file.

The type of resource. Could be file, folder or url

The date and time when the object was last updated.

Updated at (timestamp)

Updated by

critical

Whether the current user can download the contents of this folder

Whether the list of parent folder is complete. Some connectors only return the direct parent of a folder

The full path of the folder (includes the folder name)

The URL that can be used to download the file.

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Indicated if the shared link is password protected.

The URL that can be used to view the file.

Indicates if parts of the file can uploaded in parallel.

Size in bytes of each part of the file that you will upload. Uploaded parts need to be this size for the upload to be successful.

Indicates if the upload session was completed successfully.

The range of bytes that was successfully uploaded.

Box requires a SHA1 digest of the uploaded chunk to be sent. More info in the Box API documentation [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest).

Box requires a SHA1 digest of the whole file to be sent when committing the upload session. More info in the Box API documentation [here](https://developer.box.com/reference/post-files-upload-sessions-id-commit/#param-digest).

Upload files to File Storage connectors such as Google Drive, Box, Sharepoint, OneDrive and Dropbox.

Task	You (Customer)	Your Consumer	Apideck
Registering the Box app and choosing its scopes	✓	—	—
Authorising the Box account	—	✓	—
Enabling the app where an enterprise restricts unpublished apps	—	✓ (their Box admin, if required)	—
Exchanging and refreshing tokens	—	—	✓

Box

At a Glance

What are Apideck credentials?

Responsibility matrix

Environments

🚨Important to Know About Box