Box

List all pending collaborations for a user

Retrieve details of a specific collaboration by its ID, including the collaborator (user or group), their role, the item…

Add a collaborator (user or group) to a file or folder with a specific role (editor, viewer, previewer, uploader, previe…

Update a collaboration’s role, expiry date, or path visibility. Requires the authenticated user to be the folder owner,…

Remove a collaboration, revoking the user’s or group’s access to the shared file or folder. Requires the collaboration_i…

List all file and folder collaborations for a specific group, showing what content the group has access to and with what…

List all collaborations on a folder, showing which users and groups have access and their roles (editor, viewer, co-owne…

List all collaborations on a file, showing which users and groups have access and their roles. Returns both pending and…

Add a comment to a file

Retrieve information about a comment

Update a comment’s message

Remove a comment

List user and enterprise events

Retrieve information about a file

Retrieve a thumbnail of a file

Update a file’s name, description, parent folder (to move it), shared link, tags, or lock status. To lock a file, provid…

Delete a file and move it to trash

Copy a file to another folder

Download file content

Retrieve a specific version of a file

List all versions of a file

Promote a previous file version to be the current version

Restore a previously deleted file version from the file’s version history. This does NOT restore files from the trash —…

Delete a specific file version

List all comments on a specific file by its file_id. Use list_folder_items first to find the file_id if you only have th…

List tasks on a file

Retrieve information about a file in trash

Restore a file from trash

Permanently delete a trashed file

List items in a folder. Use folder_id “0” to list items in the root folder.

Retrieve information about a folder

Create a new folder

Update a folder’s information

Delete a folder and move it to trash

Copy a folder to another folder

Retrieve information about a folder in trash

Restore a folder from trash

Permanently delete a trashed folder

List all items in trash

List all enterprise groups, optionally filtered by name prefix. Returns group IDs, names, and basic details. Use filter_…

Retrieve detailed information about a specific group by its ID, including name, description, invitability_level, and mem…

Create a new enterprise group with optional invitation and member visibility settings. Requires enterprise admin or co-a…

Update a group’s name, description, invitation settings, or member visibility. Requires enterprise admin or co-admin per…

Permanently delete an enterprise group. This action cannot be undone. Requires enterprise admin or co-admin permissions.

List all members of a specific group, including their user IDs, roles (member or admin), and membership IDs. The members…

Add a user to an enterprise group as a member or admin. Requires enterprise admin or co-admin permissions. Provide the u…

Update a user’s membership in a group

Remove a user from a group

Get the current Box connection’s unified credentials and identity.

List unified groups in Box.

Get a unified Box group by ID.

List unified organizations in Box.

Get a unified Box organization by ID.

List unified resource types in Box.

List unified resource users in Box.

List unified roles in Box.

Get a unified Box role by ID.

List unified users in Box.

Get a unified Box user by ID.

List all metadata instances on a file

Retrieve a specific metadata instance on a file

Apply a metadata template instance to a file. Requires the file_id, scope (e.g. ‘enterprise_1452824910’ or ‘global’), te…

Update a metadata instance on a file

Remove a metadata instance from a file

Retrieve a specific metadata instance on a folder

List all metadata instances on a folder

Apply a metadata template instance to a folder. Requires the folder_id, scope, template_key, and a metadata object with…

Update a metadata instance on a folder

Remove a metadata instance from a folder

List all metadata templates

Retrieve a metadata template

Search for files and folders that have specific metadata values applied. This is a read-only search/query tool — it does…

Create a review or completion task on a file. The task is created unassigned — use assign_task afterwards to assign it t…

Retrieve information about a task

Update a task’s message, due date, action type, or completion rule. Note that updating completion_rule may fail with 400…

Remove a task

List assignments for a task

Assign a task to a user by user ID or email address. The user receives a notification. You can use either assign_to.id (…

Retrieve information about a task assignment

Update a task assignment’s resolution state or message. Only the task creator, the assignee themselves, or enterprise ad…

Remove a task assignment

Upload a new file

Upload a new version of an existing file by providing the file_id, base64-encoded file content (file_content), and a fil…

Create a chunked upload session for large files

Retrieve the profile of the currently authenticated user, including their user ID, name, email, avatar URL, and enterpri…

List all enterprise users with their IDs, names, and email addresses. Requires enterprise admin or co-admin permissions…

Retrieve information about a user

Create a new managed user account in the enterprise. Requires enterprise admin or co-admin role with manage_managed_user…

Update a user’s information

Delete a user from the enterprise

Retrieve a user’s avatar image. Returns 404 if no custom avatar has been uploaded, even when the user profile contains a…

Delete a user’s avatar image

Retrieve all webhooks for the authenticated application

Retrieve a specific webhook by ID

Emitted when a file is uploaded to a monitored folder. Maps to Box trigger FILE.UPLOADED.

Emitted when a file is previewed. Maps to Box trigger FILE.PREVIEWED.

Emitted when a file is downloaded. Maps to Box trigger FILE.DOWNLOADED.

Emitted when a file is moved to the trash. Maps to Box trigger FILE.TRASHED.

Emitted when a file is permanently deleted. Maps to Box trigger FILE.DELETED.

Emitted when a file is restored from the trash. Maps to Box trigger FILE.RESTORED.

Emitted when a file is copied. Maps to Box trigger FILE.COPIED.

Emitted when a file is moved to a different folder. Maps to Box trigger FILE.MOVED.

Emitted when a file is renamed. Maps to Box trigger FILE.RENAMED.

Emitted when a file is locked for editing. Maps to Box trigger FILE.LOCKED.

Emitted when a file lock is released. Maps to Box trigger FILE.UNLOCKED.

Emitted when a new folder is created. Maps to Box trigger FOLDER.CREATED.

Emitted when a folder is renamed. Maps to Box trigger FOLDER.RENAMED.

Emitted when a folder is permanently deleted. Maps to Box trigger FOLDER.DELETED.

Emitted when a folder is moved to the trash. Maps to Box trigger FOLDER.TRASHED.

Emitted when a folder is restored from the trash. Maps to Box trigger FOLDER.RESTORED.

Emitted when a folder is downloaded. Maps to Box trigger FOLDER.DOWNLOADED.

Emitted when a folder is copied. Maps to Box trigger FOLDER.COPIED.

Emitted when a folder is moved to a different location. Maps to Box trigger FOLDER.MOVED.

Emitted when a comment is added to a file. Maps to Box trigger COMMENT.CREATED.

Emitted when a comment is edited. Maps to Box trigger COMMENT.UPDATED.

Emitted when a comment is deleted. Maps to Box trigger COMMENT.DELETED.

Emitted when a collaboration (shared access) is created on a file or folder. Maps to Box trigger COLLABORATION.CREATED…

Emitted when a collaboration invitation is accepted. Maps to Box trigger COLLABORATION.ACCEPTED.

Emitted when a collaboration is removed from a file or folder. Maps to Box trigger COLLABORATION.REMOVED.

Emitted when a shared link is created on a file or folder. Maps to Box trigger SHARED_LINK.CREATED.

Emitted when a shared link is removed. Maps to Box trigger SHARED_LINK.DELETED.

Emitted when a shared link’s settings are changed. Maps to Box trigger SHARED_LINK.UPDATED.

Emitted when a task is assigned to a user on a file. Maps to Box trigger TASK_ASSIGNMENT.CREATED.

Emitted when a task assignment is updated (completed, rejected, etc.). Maps to Box trigger TASK_ASSIGNMENT.UPDATED.

Emitted when metadata is applied to a file or folder. Maps to Box trigger METADATA_INSTANCE.CREATED.

Emitted when metadata on a file or folder is updated. Maps to Box trigger METADATA_INSTANCE.UPDATED.

Emitted when metadata is removed from a file or folder. Maps to Box trigger METADATA_INSTANCE.DELETED.

Emitted when a collaboration invitation is rejected. Maps to Box trigger COLLABORATION.REJECTED.

Emitted when a collaboration’s role or permissions are changed. Maps to Box trigger COLLABORATION.UPDATED.

Emitted when a webhook subscription is deleted. Maps to Box trigger WEBHOOK.DELETED.