Skip to main content

​
Required Scopes

To configure a Sync for Box, you need to request the following scopes from your Box OAuth application:
  • root_readonly
Learn more about configuring scopes for your app in Adding Integrations.

​
Synced Objects

Box supports the following Synced Objects:

​
Files

Send a request to Enable Sync to start a file sync. Syncs for Box can be created with one of the following configurations:
  • Global Sync: All files in the user’s Box account will be synced.
  • Folder Sync: Only files in the specified folder will be synced (recursively including all subfolders).
  • Sync of specific files: Only a group of specific files will be synced.
  • Global Sync
  • Folder Sync
  • Sync of specific files
Example
{
    "integration": "box",
    "pipeline": "files",
    "configuration": {}
}
Configuration options:No configuration options are required for a global Sync.

​
Choosing Files and Folders

You can allow your user to select files from their Box account in your app with the Box File Picker provided by the Paragon SDK.

​
Showing the File Picker

Use the Paragon SDK in your frontend application to show the File Picker in your app. The SDK provides an ExternalFilePicker class to load Box’s JavaScript into your page and authenticate with your user’s connected Box account. 
let picker = new paragon.ExternalFilePicker("box", {
    onFileSelect: (files) => {
        // Handle file selection
    }
});

// Loads external dependencies and user's access token, and sets the folderId to the root folder
await picker.init({ folderId: "0" });

// Open the File Picker
picker.open();
You can configure the File Picker to listen for additional callbacks or to restrict allowed file types. Learn more about configuring File Picker options in the SDK Reference.
⌘I