manage\_enterprise\_properties manage\_groups manage\_managed\_users manage\_webhook root\_readonly root\_readwrite

96 actions

Action

Description

Required scopes

List Pending Collaborations

List all pending collaborations for a user

Get Collaboration

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

Create Collaboration

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

Update Collaboration

Update a collaboration's role or path visibility. Requires the authenticated user to be the folder owner, co-owner, or e...

Remove Collaboration

Remove a collaboration, revoking the user's or group's access to the shared file or folder. Requires the collaboration\_i...

List Group Collaborations

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

List Folder Collaborations

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

List File Collaborations

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

Create Comment

Add a comment to a file

Get Comment

Retrieve information about a comment

Update Comment

Update a comment's message

Delete Comment

Remove a comment

Get User And Enterprise Events

List user and enterprise events

Get File Information

Retrieve information about a file

Get File Thumbnail

Retrieve a thumbnail of a file

Update File

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

Search Box for files, folders and web links by name or content.

Unlock File

Remove the lock from a file so other users can move, rename or change it again.

Delete File

Delete a file and move it to trash

Copy File

Copy a file to another folder

Get File Version

Retrieve a specific version of a file

List File Versions

List all versions of a file

Promote File Version

Promote a previous file version to be the current version

Restore File Version

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

Delete File Version

Delete a specific file version

List File Comments

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 File Tasks

List tasks on a file

Get Trashed File

Retrieve information about a file in trash

Restore File From Trash

Restore a file from trash

Permanently Delete File

Permanently delete a trashed file

List Folder Items

List items in a folder. Use folder\_id "0" to list items in the root folder.

Get Folder Information

Retrieve information about a folder

Create Folder

Create a new folder

Update Folder

Update a folder's information

Delete Folder

Delete a folder and move it to trash

Copy Folder

Copy a folder to another folder

Get Trashed Folder

Retrieve information about a folder in trash

Restore Folder From Trash

Restore a folder from trash

Permanently Delete Folder

Permanently delete a trashed folder

List Trashed Items

List all items in trash

List Groups

List all enterprise groups, optionally filtered by name prefix. Returns group IDs, names, and basic details. Use filter\_...

Get Group

Retrieve detailed information about a specific group by its ID, including name, description, invitability\_level, and mem...

Create Group

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

Update Group

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

Delete Group

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

List Group Memberships

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

Add User To Group

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

Update Group Membership

Update a user's membership in a group

Remove User From Group

Remove a user from a group

Get Unified Credentials

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

List Unified Groups

List unified groups in Box.

Get Unified Group

Get a unified Box group by ID.

List Unified Organizations

List unified organizations in Box.

Get Unified Organization

Get a unified Box organization by ID.

List Unified Resource Types

List unified resource types in Box.

List Unified Resource Users

List unified resource users in Box.

List Unified Roles

List unified roles in Box.

Get Unified Role

Get a unified Box role by ID.

List Unified Users

List unified users in Box.

Get Unified User

Get a unified Box user by ID.

List File Metadata Instances

List all metadata instances on a file

Get File Metadata Instance

Retrieve a specific metadata instance on a file

Create File Metadata Instance

Apply a metadata template instance to a file. Requires the file\_id, scope (e.g. 'enterprise\_1452824910' or 'global'), te...

Update File Metadata Instance

Update a metadata instance on a file

Delete File Metadata Instance

Remove a metadata instance from a file

Get Folder Metadata Instance

Retrieve a specific metadata instance on a folder

List Folder Metadata Instances

List all metadata instances on a folder

Create Folder Metadata Instance

Apply a metadata template instance to a folder. Requires the folder\_id, scope, template\_key, and a metadata object with...

Update Folder Metadata Instance

Update a metadata instance on a folder

Delete Folder Metadata Instance

Remove a metadata instance from a folder

Create Metadata Template

Create an enterprise metadata template that can then be applied to files and folders.

List Metadata Templates

List all metadata templates

Get Metadata Template

Retrieve a metadata template

Query By Metadata

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

Create Task

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

Get Task

Retrieve information about a task

Update Task

Update a task's message, due date, action type, or completion rule. Every update body must include message, so pair it w\...

Delete Task

Remove a task

List Task Assignments

List assignments for a task

Assign 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 (...

Get Task Assignment

Retrieve information about a task assignment

Update Task Assignment

Update a task assignment's resolution state or message. For review-type tasks, resolution\_state (approved or rejected) i...

Delete Task Assignment

Remove a task assignment

Upload File

Upload a new file

Upload File Version

Upload a new version of an existing file by providing the file\_id, base64-encoded file content (file\_content), and a fil...

Create Upload Session

Create a chunked upload session for large files

Get Current User

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

List Enterprise Users

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

Get User

Retrieve information about a user

Create User

Create a new managed user account in the enterprise. Requires enterprise admin or co-admin role with manage\_managed\_user...

Update User

Update a user's information

Delete User

Delete a user from the enterprise

Get User Avatar

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

Delete User Avatar

Delete a user's avatar image

List Webhooks

Retrieve all webhooks for the authenticated application

Get Webhook

Retrieve a specific webhook by ID

Assignments Collaborations Comments Files Folders Metadata Shared Links Tasks Webhooks

36 events

Event

Description