Access Token

Refresh Token

Collections

Files

Folders

Constructed from the id and type of the item

Compound Item ID

Items

Users

Web Links

Download File

Get Connected Account Details

Authorize a user by sending them through the [Box](https://box.com)
website and request their permission to act on their behalf.

This is the first step when authenticating a user using
OAuth 2.0. To request a user's authorization to use the Box APIs
on their behalf you will need to send a user to the URL with this
format.

Authorize user

Request an Access Token using either a client-side obtained OAuth 2.0
authorization code or a server-side JWT assertion.

An Access Token is a string that enables Box to verify that a
request belongs to an authorized session. In the normal order of
operations you will begin by requesting authentication from the
[authorize](#get-authorize) endpoint and Box will send you an
authorization code.

You will then send this code to this endpoint to exchange it for
an Access Token. The returned Access Token can then be used to to make
Box API calls.

Request access token

Refresh an Access Token using its client ID, secret, and refresh token.

Refresh access token

Revoke an active Access Token, effectively logging a user out
that has been previously authenticated.

Revoke access token

Get file information

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the
original folder has been deleted.

Restore file

Updates a file. This can be used to rename or move a file,
create a shared link, or lock a file.

Update file

Deletes a file, either permanently or by moving it to
the trash.

The the enterprise settings determine whether the item will
be permanently deleted from Box or moved to the trash.

Delete file

Returns the contents of a file in binary format.

Download file

Update a file's content. For file sizes over 50MB we recommend
using the Chunk Upload APIs.

# Request body order

The `attributes` part of the body must come **before** the
`file` part. Requests that do not follow this format when
uploading the file will receive a HTTP `400` error with a
`metadata_after_file_contents` error code.

Upload file version

Uploads a small file to Box. For file sizes over 50MB we recommend
using the Chunk Upload APIs.

# Request body order

The `attributes` part of the body must come **before** the
`file` part. Requests that do not follow this format when
uploading the file will receive a HTTP `400` error with a
`metadata_after_file_contents` error code.

Upload file

Creates an upload session for a new file.

Create upload session

Creates an upload session for an existing file.

Create upload session for existing file

Return information about an upload session.

Get upload session

Updates a chunk of an upload session for a file.

Upload part of file

Abort an upload session and discard all data uploaded.

This cannot be reversed.

Remove upload session

Return a list of the chunks uploaded to the upload
session so far.

List parts

Close an upload session and create a file from the
uploaded chunks.

Commit upload session

Copy file

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in
the `.png` format and sizes of `32x32`, `160x160`, and `320x320`
can be returned in the `.jpg` format.

Thumbnails can be generated for the image and video file formats listed
[found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

Get file thumbnail

Retrieves a list of pending and active collaborations for a
file. This returns all the users that have access to the file
or have been invited to the file.

List file collaborations

List file comments

Retrieves a list of all the tasks for a file. This
endpoint does not support pagination.

List tasks on file

Retrieves a file that has been moved to the trash.

Please note that only if the file itself has been moved to the
trash can it be retrieved with this API call. If instead one of
its parent folders was moved to the trash, only that folder
can be inspected using the
[`GET /folders/:id/trash`](e://get_folders_id_trash) API.

To list all items that have been moved to the trash, please
use the [`GET /folders/trash/items`](e://get-folders-trash-items/)
API.

Get trashed file

Permanently deletes a file that is in the trash.
This action cannot be undone.

Permanently remove file

Retrieve a list of the past versions for a file.

Versions are only tracked by Box users with premium accounts. To fetch the ID
of the current version of a file, use the `GET /file/:id` API.

List all file versions

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

Get file version

Move a file version to the trash.

Versions are only tracked for Box users with premium accounts.

Remove file version

Restores a specific version of a file after it was deleted.
Don't use this endpoint to restore Box Notes,
as it works with file formats such as PDF, DOC,
PPTX or similar.

Restore file version

Promote a specific version of a file.

If previous versions exist, this method can be used to
promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the
top of the versions history. The file will have the exact same contents
as the older version, with the the same hash digest, `etag`, and
name as the original.

Other properties such as comments do not get updated to their
former values.

Don't use this endpoint to restore Box Notes,
as it works with file formats such as PDF, DOC,
PPTX or similar.

Promote file version

List metadata instances on file

Retrieves the classification metadata instance that
has been applied to a file.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Get classification on file

Adds a classification to a file by specifying the label of the
classification to add.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Add classification to file

Updates a classification on a file.

The classification can only be updated if a classification has already been
applied to the file before. When editing classifications, only values are
defined for the enterprise will be accepted.

Update classification on file

Removes any classifications from a file.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Remove classification from file

Retrieves the instance of a metadata template that has been applied to a
file.

Get metadata instance on file

Applies an instance of a metadata template to a file.

In most cases only values that are present in the metadata template
will be accepted, except for the `global.properties` template which accepts
any key-value pair.

Create metadata instance on file

Updates a piece of metadata on a file.

The metadata instance can only be updated if the template has already been
applied to the file before. When editing metadata, only values that match
the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the
application of the operations, the metadata instance will not be changed.

Update metadata instance on file

Remove metadata instance from file

List the Box Skills metadata cards that are attached to a file.

List Box Skill cards on file

Applies one or more Box Skills metadata cards to a file.

Create Box Skill cards on file

Updates one or more Box Skills metadata cards to a file.

Update Box Skill cards on file

Removes any Box Skills cards metadata from a file.

Remove Box Skill cards from file

Get watermark on file

Apply watermark to file

Remove watermark from file

Retrieves the information about a file request.

Get file request

Updates a file request. This can be used to activate or
deactivate a file request.

Update file request

Delete file request

Copies an existing file request that is already present on one folder,
and applies it to another folder.

Copy file request

Retrieves details for a folder, including the first 100 entries
in the folder.

Passing `sort`, `direction`, `offset`, and `limit`
parameters in query allows you to manage the
list of returned
[folder items](r://folder--full#param-item-collection).

To fetch more items within the folder, use the
[Get items in a folder](e://get-folders-id-items) endpoint.

Get folder information

Restores a folder that has been moved to the trash.

An optional new parent ID can be provided to restore the folder to in case the
original folder has been deleted.

# Folder locking

During this operation, part of the file tree will be locked, mainly
the source folder and all of its descendants, as well as the destination
folder.

For the duration of the operation, no other move, copy, delete, or restore
operation can performed on any of the locked folders.

Restore folder

Updates a folder. This can be also be used to move the folder,
create shared links, update collaborations, and more.

Update folder

Deletes a folder, either permanently or by moving it to
the trash.

Delete folder

Retrieves a page of items in a folder. These items can be files,
folders, and web links.

To request more information about the folder itself, like its size,
use the [Get a folder](#get-folders-id) endpoint instead.

List items in folder

Creates a new empty folder within the specified parent folder.

Create folder

Creates a copy of a folder within a destination folder.

The original folder will not be changed.

Copy folder

Retrieves a list of pending and active collaborations for a
folder. This returns all the users that have access to the folder
or have been invited to the folder.

List folder collaborations

Retrieves a folder that has been moved to the trash.

Please note that only if the folder itself has been moved to the
trash can it be retrieved with this API call. If instead one of
its parent folders was moved to the trash, only that folder
can be inspected using the
[`GET /folders/:id/trash`](e://get_folders_id_trash) API.

To list all items that have been moved to the trash, please
use the [`GET /folders/trash/items`](e://get-folders-trash-items/)
API.

Get trashed folder

Permanently deletes a folder that is in the trash.
This action cannot be undone.

Permanently remove folder

Retrieves all metadata for a given folder. This can not be used on the root
folder with ID `0`.

List metadata instances on folder

Retrieves the classification metadata instance that
has been applied to a folder.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Get classification on folder

Adds a classification to a folder by specifying the label of the
classification to add.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Add classification to folder

Updates a classification on a folder.

The classification can only be updated if a classification has already been
applied to the folder before. When editing classifications, only values are
defined for the enterprise will be accepted.

Update classification on folder

Removes any classifications from a folder.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

Remove classification from folder

Retrieves the instance of a metadata template that has been applied to a
folder. This can not be used on the root folder with ID `0`.

Get metadata instance on folder

Applies an instance of a metadata template to a folder.

In most cases only values that are present in the metadata template
will be accepted, except for the `global.properties` template which accepts
any key-value pair.

To display the metadata template in the Box web app the enterprise needs to be
configured to enable **Cascading Folder Level Metadata** for the user in the
admin console.

Create metadata instance on folder

Updates a piece of metadata on a folder.

The metadata instance can only be updated if the template has already been
applied to the folder before. When editing metadata, only values that match
the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the
application of the operations, the metadata instance will not be changed.

Update metadata instance on folder

Remove metadata instance from folder

Retrieves the files and folders that have been moved
to the trash.

Any attribute in the full files or folders objects can be passed
in with the `fields` parameter to retrieve those specific
attributes that are not returned by default.

This endpoint defaults to use offset-based pagination, yet also supports
marker-based pagination using the `marker` parameter.

List trashed items

Get watermark for folder

Applies or update a watermark on a folder.

Apply watermark to folder

Remove watermark from folder

Retrieves folder lock details for a given folder.

You must be authenticated as the owner or co-owner of the folder to
use this endpoint.

List folder locks

Creates a folder lock on a folder, preventing it from being moved and/or
deleted.

You must be authenticated as the owner or co-owner of the folder to
use this endpoint.

Create folder lock

Deletes a folder lock on a given folder.

You must be authenticated as the owner or co-owner of the folder to
use this endpoint.

Delete folder lock

Finds a metadata template by searching for the ID of an instance of the
template.

Find metadata template by instance ID

Retrieves the classification metadata template and lists all the
classifications available to this enterprise.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.

List all classifications

Adds one or more new classifications to the list of classifications
available to the enterprise.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.

Add classification

Updates the labels and descriptions of one or more classifications
available to the enterprise.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.

Update classification

Retrieves a metadata template by its `scope` and `templateKey` values.

To find the `scope` and `templateKey` for a template, list all templates for
an enterprise or globally, or list all templates applied to a file or folder.

Get metadata template by name

Updates a metadata template.

The metadata template can only be updated if the template
already exists.

The update is applied atomically. If any errors occur during the
application of the operations, the metadata template will not be changed.

Update metadata template

Delete a metadata template and its instances.
This deletion is permanent and can not be reversed.

Remove metadata template

Get metadata template by ID

Used to retrieve all generic, global metadata templates available to all
enterprises using Box.

List all global metadata templates

Used to retrieve all metadata templates created to be used specifically within
the user's enterprise

List all metadata templates for enterprise

Creates a new metadata template that can be applied to
files and folders.

Create metadata template

When an enterprise does not yet have any classifications, this API call
initializes the classification template with an initial set of
classifications.

If an enterprise already has a classification, the template will already
exist and instead an API call should be made to add additional
classifications.

Add initial classifications

Retrieves a list of all the metadata cascade policies
that are applied to a given folder. This can not be used on the root
folder with ID `0`.

List metadata cascade policies

Creates a new metadata cascade policy that applies a given
metadata template to a given folder and automatically
cascades it down to any files within that folder.

In order for the policy to be applied a metadata instance must first
be applied to the folder the policy is to be applied to.

Create metadata cascade policy

Retrieve a specific metadata cascade policy assigned to a folder.

Get metadata cascade policy

Remove metadata cascade policy

Force the metadata on a folder with a metadata cascade policy to be applied to
all of its children. This can be used after creating a new cascade policy to
enforce the metadata to be cascaded down to all existing files within that
folder.

Force-apply metadata cascade policy to folder

Create a search using SQL-like syntax to return items that match specific
metadata.

By default, this endpoint returns only the most basic info about the items for
which the query matches. To get additional fields for each item, including any
of the metadata, use the `fields` attribute in the query.

Query files/folders by metadata

Retrieves the metadata query indices for a given scope and template key.

List metadata query indices

Retrieves the message and metadata for a specific comment, as well
as information on the user who created the comment.

Get comment

Update comment

Remove comment

Dropbox

Google Drive

Microsoft Sharepoint

MS OneDrive

# Continuous Import of Files and Folders (Drive Items) to Your App

This scenario enables your application to continuously sync and download Files and Folders (Drive Items) from any external application to your app's API. It handles the initial import of Drive Items and keeps them synchronized when a drive item is created, updated, or deleted in the external application.

When receiving Files data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

3. **Download File**:
   - Make a single API request to start file download from external app, it will return download file URI, that you can use to download file from any source in the same way

Continuously Import Files and Folders to my App

Import files and folders, download files and receive created/updated or deleted events

Salesforce

HubSpot

# Continuous Import of Users to Your App

This scenario enables your application to continuously sync Users from any external application to your app's API. It handles the initial import of Users and keeps them synchronized when a User is created, updated, or deleted in the external application.

When receiving Users data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Users to my App

Import Users and receive created/updated or deleted events

	Files automatically maps to	Users automatically maps to	Folders automatically maps to	Drive Items automatically maps to
Microsoft Sharepoint	Drive Items	Users	Folders	Drive Items
Salesforce	Content Documents	Users	—	—
MS OneDrive	Drive Items	—	Drive Items	Drive Items
Google Drive	Files	—	Files	Files
Dropbox	Files	—	Files	Files
AWS S3	Objects	—	Buckets	—
SalesForce Pardot	—	Users	—	—
Microsoft Dynamics 365	—	Systemusers	—	—
Capsule CRM	—	Users	—	—
Freshsales	—	Owners	—	—

Box API Integration Profile

Getting Started

Data Collections

Operations

Integration Scenarios

Continuously Import Files and Folders to my App

Continuously Import Users to my App

Continuously Import Folders to my App

Get all Folders

Update Folder

Create Drive Item

Use the same code to integrate with Box and 100+ other applications

Files

Users

Folders

Drive Items

Build every single integration your customers need with AI