> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Box

> How to set up the Box connector, plus the actions and events that are available.

![Box](https://stackone-logos.com/api/box/filled/svg)

v3.0.0[See changelog](https://docs.stackone.com/connectors/box/changelog.md)

[124 actions](#actions) · [36 events](#events) · 3 auth methods

Storage
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [MCP (OAuth) · Connector Profile](https://docs.stackone.com/connectors/box/guides/connector-profile/mcp-oauth.md)
>
> Authorize through the MCP server. Endpoints and client registration are discovered at connect time.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/box/guides/connector-profile/oauth-2-0.md)
>
> OAuth 2.0 authentication provides secure access to Box APIs. Create a Custom App in the Box Developer Console to generat...

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/box/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Server-to-server access with no user sign-in, using a Box Server Authentication app with Client Credentials Grant that a...

Optionally, configure receiving Events for Box into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/box/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [MCP (OAuth) · Link Account](https://docs.stackone.com/connectors/box/guides/link-account/mcp-oauth.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/box/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/box/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

MCP (OAuth)

OAuth 2.0

OAuth 2.0 (Client Credentials)

No auth methods found

Scopes

Select all
|
Clear

manage\_enterprise\_properties

manage\_groups

manage\_managed\_users

manage\_webhook

root\_readonly

root\_readwrite

No scopes found

124 actions

ActionDescriptionRequired scopes

List Pending Collaborations`box_list_pending_collaborations`

List all pending collaborations for a user

`root_readonly`

Get Collaboration`box_get_collaboration`

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

`root_readonly`

Create Collaboration`box_create_collaboration`

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

`root_readwrite`

Update Collaboration`box_update_collaboration`

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

`root_readwrite`

Remove Collaboration`box_delete_collaboration`

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

`root_readwrite`

List Group Collaborations`box_list_group_collaborations`

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

`manage_groups`

List Folder Collaborations`box_list_folder_collaborations`

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

`root_readonly`

List File Collaborations`box_list_file_collaborations`

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

`root_readonly`

Create Comment`box_create_comment`

Add a comment to a file

`root_readwrite`

Get Comment`box_get_comment`

Retrieve information about a comment

`root_readonly`

Update Comment`box_update_comment`

Update a comment's message

`root_readwrite`

Delete Comment`box_delete_comment`

Remove a comment

`root_readwrite`

Get User And Enterprise Events`box_get_events`

List user and enterprise events

`manage_enterprise_properties`

Get File Information`box_get_file`

Retrieve information about a file

`root_readonly`

Get File Thumbnail`box_get_file_thumbnail`

Retrieve a thumbnail of a file

`root_readonly`

Update File`box_update_file`

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

`root_readwrite`

Search`box_search_content`

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

`root_readonly`

Unlock File`box_unlock_file`

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

`root_readwrite`

Delete File`box_delete_file`

Delete a file and move it to trash

`root_readwrite`

Copy File`box_copy_file`

Copy a file to another folder

`root_readwrite`

Get File Version`box_get_file_version`

Retrieve a specific version of a file

`root_readonly`

List File Versions`box_list_file_versions`

List all versions of a file

`root_readonly`

Promote File Version`box_promote_file_version`

Promote a previous file version to be the current version

`root_readwrite`

Restore File Version`box_restore_file_version`

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

`root_readwrite`

Delete File Version`box_delete_file_version`

Delete a specific file version

`root_readwrite`

List File Comments`box_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...

`root_readonly`

List File Tasks`box_list_file_tasks`

List tasks on a file

`root_readonly`

Get Trashed File`box_get_trashed_file`

Retrieve information about a file in trash

`root_readonly`

Restore File From Trash`box_restore_file`

Restore a file from trash

`root_readwrite`

Permanently Delete File`box_permanently_delete_file`

Permanently delete a trashed file

`root_readwrite`

List Folder Items`box_list_folder_items`

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

`root_readonly`

Get Folder Information`box_get_folder`

Retrieve information about a folder

`root_readonly`

Create Folder`box_create_folder`

Create a new folder

`root_readwrite`

Update Folder`box_update_folder`

Update a folder's information

`root_readwrite`

Delete Folder`box_delete_folder`

Delete a folder and move it to trash

`root_readwrite`

Copy Folder`box_copy_folder`

Copy a folder to another folder

`root_readwrite`

Get Trashed Folder`box_get_trashed_folder`

Retrieve information about a folder in trash

`root_readonly`

Restore Folder From Trash`box_restore_folder`

Restore a folder from trash

`root_readwrite`

Permanently Delete Folder`box_permanently_delete_folder`

Permanently delete a trashed folder

`root_readwrite`

List Trashed Items`box_list_trashed_items`

List all items in trash

`root_readonly`

List Groups`box_list_groups`

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

`manage_groups`

Get Group`box_get_group`

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

`manage_groups`

Create Group`box_create_group`

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

`manage_groups`

Update Group`box_update_group`

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

`manage_groups`

Delete Group`box_delete_group`

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

`manage_groups`

List Group Memberships`box_list_group_memberships`

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

`manage_groups`

Add User To Group`box_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...

`manage_groups`

Update Group Membership`box_update_group_membership`

Update a user's membership in a group

`manage_groups`

Remove User From Group`box_remove_user_from_group`

Remove a user from a group

`manage_groups`

Get Unified Credentials`box_unified_get_me`

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

`root_readonly`

List Unified Groups`box_unified_list_groups`

List unified groups in Box.

`manage_groups`

Get Unified Group`box_unified_get_group`

Get a unified Box group by ID.

`manage_groups`

List Unified Organizations`box_unified_list_organizations`

List unified organizations in Box.

`root_readonly`

Get Unified Organization`box_unified_get_organization`

Get a unified Box organization by ID.

`root_readonly`

List Unified Resource Types`box_unified_list_resource_types`

List unified resource types in Box.

`root_readonly`

List Unified Resource Users`box_unified_list_resource_users`

List unified resource users in Box.

`root_readonly`

List Unified Roles`box_unified_list_roles`

List unified roles in Box.

`root_readonly`

Get Unified Role`box_unified_get_role`

Get a unified Box role by ID.

`root_readonly`

List Unified Users`box_unified_list_users`

List unified users in Box.

`manage_managed_users`

Get Unified User`box_unified_get_user`

Get a unified Box user by ID.

`manage_managed_users`

Who Am I`box_who_am_i`

Returns detailed information about the currently authenticated Box user. This tool provides comprehensive user profile d...

Search Folders By Name`box_search_folders_by_name`

Searches for folders by name within Box using keyword matching. This tool helps locate specific folders by their names a...

List Folder Content`box_list_folder_content_by_folder_id`

Lists files, folders, and web links contained in a folder. Returns a paginated list of items with at least fields. Field...

Search Files By Keyword`box_search_files_keyword`

Searches for files using keywords and supports metadata filters, file extension filtering (without dots), and field sele...

Get File Content`box_get_file_content`

Get the text content of a file from Box. Prefers the markdown representation (preserves document structure for better LL...

List Tasks`box_list_tasks`

Lists all tasks associated with a specific file. This tool retrieves task information including task details, message, s...

Get File Details`box_get_file_details`

Gets comprehensive file information from Box. Returns essential fields by default (id, name, extension, createdBy, modif...

Get Folder Details`box_get_folder_details`

Retrieves comprehensive information about a folder in Box. Returns essential fields by default (id, name, createdBy, mod...

List File Comments`box_mcp_list_file_comments`

Lists all comments on a specific file. Returns a paginated list of comments with configurable fields. Default fields (id...

List Item Collaborations`box_list_item_collaborations`

Lists all collaborations for multiple files and folders in a single request. This tool efficiently aggregates collaborat...

List Metadata Templates`box_mcp_list_metadata_templates`

Lists available Box metadata templates so you can discover scope and templateKey for search\_files\_metadata. Use this fir...

Get Metadata Template Schema`box_get_metadata_template_schema`

Returns the schema for a metadata template. Shield template "securityClassification-6VMVochwUWo": option colorID is norm...

Search Files By Metadata`box_search_files_metadata`

Searches for files using SQL-like metadata queries. Requires: from (e.g. enterprise\_123456.templateKey from list\_metadat...

Upload File`box_mcp_upload_file`

Uploads a new file to Box. This tool creates a new file in Box using the provided text content. The file name including...

Create Folder`box_mcp_create_folder`

Creates new folders in Box. \<examples> Create folder in root: \<input> \{ "name": "Project Documents" } \</input> Create...

Create File Comment`box_create_file_comment`

Creates a new comment on a specific file. This tool allows you to add comments to files for collaboration, feedback, or...

Copy File`box_mcp_copy_file`

Copies an existing file to a destination folder in Box (see Box API Copy file). The source file is not modified. Provide...

Copy Folder`box_mcp_copy_folder`

Copies an existing folder to a destination parent folder in Box (see Box API Copy folder). The source folder is not modi...

Create Metadata Template`box_mcp_create_metadata_template`

Creates a new enterprise metadata template. scope must be "enterprise"; each field needs type, key, and display\_name. Op...

List Hubs`box_list_hubs`

Lists all hubs accessible to the current user with pagination support. Provides an overview of available collaborative w\...

Get Hub Details`box_get_hub_details`

Retrieves comprehensive information about a specific hub including metadata, creation details, and administrative inform...

Get Hub Items`box_get_hub_items`

Retrieves all items within a specific hub including files, folders, and web links. Essential for exploring the contents...

Create Hub`box_create_hub`

Creates new collaborative hubs for organizing content around specific topics, projects, or teams. Enables the establishm...

Add Items To Hub`box_add_items_to_hub`

Adds files, folders, or web links to a specific hub, enabling content organization within collaborative workspaces. Esse...

Copy Hub`box_copy_hub`

Creates a copy of an existing Box Hub via the Hubs v3 API (`POST /v3/hubs/&#123;id&#125;:copy`). The source hub is not modified. C...

Create Box Note`box_create_box_note`

Creates a new Box Note in Box from markdown content. A Box Note is Box's native collaborative document format (.boxnote)...

Get File Preview`box_get_file_preview`

Displays an interactive preview widget for a Box file directly in chat. Supports: ai, bmp, cr2, crw, csv, dng, doc, docx...

Get Preview Page`box_get_preview_page`

Use when user asks follow-up question to a file previewed with get\_file\_preview ("Explain this...", "What does \_\_\_\_ mean...

List File Metadata Instances`box_list_file_metadata`

List all metadata instances on a file

`root_readonly`

Get File Metadata Instance`box_get_file_metadata`

Retrieve a specific metadata instance on a file

`root_readonly`

Create File Metadata Instance`box_create_file_metadata`

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

`root_readwrite`

Update File Metadata Instance`box_update_file_metadata`

Update a metadata instance on a file

`root_readwrite`

Delete File Metadata Instance`box_delete_file_metadata`

Remove a metadata instance from a file

`root_readwrite`

Get Folder Metadata Instance`box_get_folder_metadata`

Retrieve a specific metadata instance on a folder

`root_readonly`

List Folder Metadata Instances`box_list_folder_metadata`

List all metadata instances on a folder

`root_readonly`

Create Folder Metadata Instance`box_create_folder_metadata`

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

`root_readwrite`

Update Folder Metadata Instance`box_update_folder_metadata`

Update a metadata instance on a folder

`root_readwrite`

Delete Folder Metadata Instance`box_delete_folder_metadata`

Remove a metadata instance from a folder

`root_readwrite`

Create Metadata Template`box_create_metadata_template`

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

`root_readwrite`

List Metadata Templates`box_list_metadata_templates`

List all metadata templates

`root_readonly`

Get Metadata Template`box_get_metadata_template`

Retrieve a metadata template

`root_readonly`

Query By Metadata`box_query_by_metadata`

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

`root_readonly`

Create Task`box_create_task`

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

`root_readwrite`

Get Task`box_get_task`

Retrieve information about a task

`root_readonly`

Update Task`box_update_task`

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

`root_readwrite`

Delete Task`box_delete_task`

Remove a task

`root_readwrite`

List Task Assignments`box_list_task_assignments`

List assignments for a task

`root_readonly`

Assign Task`box_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 (...

`root_readwrite`

Get Task Assignment`box_get_task_assignment`

Retrieve information about a task assignment

`root_readonly`

Update Task Assignment`box_update_task_assignment`

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

`root_readwrite`

Delete Task Assignment`box_delete_task_assignment`

Remove a task assignment

`root_readwrite`

Upload File`box_upload_file`

Upload a new file

`root_readwrite`

Upload File Version`box_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...

`root_readwrite`

Create Upload Session`box_create_upload_session`

Create a chunked upload session for large files

`root_readwrite`

Get Current User`box_get_current_user`

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

`root_readonly`

List Enterprise Users`box_list_users`

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

`manage_managed_users`

Get User`box_get_user`

Retrieve information about a user

`root_readonly`

Create User`box_create_user`

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

`manage_managed_users`

Update User`box_update_user`

Update a user's information

`manage_managed_users`

Delete User`box_delete_user`

Delete a user from the enterprise

`manage_managed_users`

Get User Avatar`box_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...

`root_readonly`

Delete User Avatar`box_delete_user_avatar`

Delete a user's avatar image

`manage_managed_users`

List Webhooks`box_list_webhooks`

Retrieve all webhooks for the authenticated application

`manage_webhook`

Get Webhook`box_get_webhook`

Retrieve a specific webhook by ID

`manage_webhook`

## Events

Tags

Select all
|
Clear

Assignments

Collaborations

Comments

Files

Folders

Metadata

Shared Links

Tasks

Webhooks

No tags found

36 events

EventDescriptionTags

File Uploaded`box_webhook_file_uploaded`

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

FilesWebhooks

File Previewed`box_webhook_file_previewed`

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

FilesWebhooks

File Downloaded`box_webhook_file_downloaded`

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

FilesWebhooks

File Trashed`box_webhook_file_trashed`

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

FilesWebhooks

File Deleted`box_webhook_file_deleted`

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

FilesWebhooks

File Restored`box_webhook_file_restored`

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

FilesWebhooks

File Copied`box_webhook_file_copied`

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

FilesWebhooks

File Moved`box_webhook_file_moved`

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

FilesWebhooks

File Renamed`box_webhook_file_renamed`

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

FilesWebhooks

File Locked`box_webhook_file_locked`

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

FilesWebhooks

File Unlocked`box_webhook_file_unlocked`

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

FilesWebhooks

Folder Created`box_webhook_folder_created`

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

FoldersWebhooks

Folder Renamed`box_webhook_folder_renamed`

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

FoldersWebhooks

Folder Deleted`box_webhook_folder_deleted`

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

FoldersWebhooks

Folder Trashed`box_webhook_folder_trashed`

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

FoldersWebhooks

Folder Restored`box_webhook_folder_restored`

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

FoldersWebhooks

Folder Downloaded`box_webhook_folder_downloaded`

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

FoldersWebhooks

Folder Copied`box_webhook_folder_copied`

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

FoldersWebhooks

Folder Moved`box_webhook_folder_moved`

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

FoldersWebhooks

Comment Created`box_webhook_comment_created`

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

CommentsWebhooks

Comment Updated`box_webhook_comment_updated`

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

CommentsWebhooks

Comment Deleted`box_webhook_comment_deleted`

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

CommentsWebhooks

Collaboration Created`box_webhook_collaboration_created`

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

CollaborationsWebhooks

Collaboration Accepted`box_webhook_collaboration_accepted`

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

CollaborationsWebhooks

Collaboration Removed`box_webhook_collaboration_removed`

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

CollaborationsWebhooks

Shared Link Created`box_webhook_shared_link_created`

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

Shared LinksWebhooks

Shared Link Deleted`box_webhook_shared_link_deleted`

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

Shared LinksWebhooks

Shared Link Updated`box_webhook_shared_link_updated`

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

Shared LinksWebhooks

Task Assignment Created`box_webhook_task_assignment_created`

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

TasksAssignmentsWebhooks

Task Assignment Updated`box_webhook_task_assignment_updated`

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

TasksAssignmentsWebhooks

Metadata Instance Created`box_webhook_metadata_instance_created`

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

MetadataWebhooks

Metadata Instance Updated`box_webhook_metadata_instance_updated`

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

MetadataWebhooks

Metadata Instance Deleted`box_webhook_metadata_instance_deleted`

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

MetadataWebhooks

Collaboration Rejected`box_webhook_collaboration_rejected`

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

CollaborationsWebhooks

Collaboration Updated`box_webhook_collaboration_updated`

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

CollaborationsWebhooks

Webhook Deleted`box_webhook_webhook_deleted`

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

Webhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.