Team
Shared credential for production and unattended runs.
Connect Box with Hookshot™ and your stack
Box is a cloud content management platform for secure file storage, sharing, collaboration, and governance.
Tools and triggers
What Agents can do in Box
Available tools and events after Box is connected.
-
Add Classification to File
Adds a classification to a file by specifying the label of the classification to add. **Enterprise-only feature**: This action requires a Box enterprise account with classification templates configured. Users without…
-
Add Classification to Folder
Adds a classification to a folder by specifying the label of the classification to add. **Enterprise-only feature**: This action requires a Box enterprise account with classification templates configured. Users without…
-
Add Domain to List of Allowed Collaboration Domains
Creates a new entry in the list of allowed domains for collaboration within your enterprise. This allows you to whitelist specific domains for external collaboration. Use 'inbound' to allow users from the specified…
-
Add Initial Classifications
Initializes the classification template for an enterprise with an initial set of classification options. IMPORTANT: This action requires admin permissions and should only be called once per enterprise when no…
-
Add or Update User Avatar
Adds or updates a user avatar.
-
Add Shared Link to File
Adds a shared link to a file.
-
Add Shared Link to Folder
Adds a shared link to a folder, allowing it to be shared with others via a URL. This action creates or updates a shared link on a folder. The shared link can be configured with different access levels: - 'open': Anyone…
-
Add Shared Link to Web Link
Adds a shared link to a web link.
-
Add User to Group
Creates a group membership. Only users with admin-level permissions will be able to use this API.
-
Append Metadata Taxonomy Level
Appends a new level to a metadata taxonomy structure. Use when adding hierarchical categories to organize metadata. If no levels exist, this creates the first level.
-
Apply Watermark to File
Applies or update a watermark on a file.
-
Apply Watermark to Folder
Applies or update a watermark on a folder.
-
Ask Question
Ask questions about Box files using Box AI. Use this action to query one or more files with natural language questions. Box AI will analyze the file contents and provide an answer based on the information found in the…
-
Assign Legal Hold Policy
Assign a legal hold policy to a file, file version, folder, or user. Legal hold policies preserve content for litigation or compliance purposes by preventing the deletion of specified items. When assigned to a folder…
-
Assign Retention Policy
Assigns a retention policy to an item in Box to enforce content retention. Use this action to apply a retention policy to: - An entire enterprise (assign_to_type='enterprise', no ID needed) - A specific folder…
-
Assign Storage Policy
Creates a storage policy assignment for an enterprise or user. Storage policies control where data is stored geographically (data residency). This action requires Box Zones or similar enterprise feature to be enabled…
-
Assign Task
Assigns a task to a user. A task can be assigned to more than one user by creating multiple assignments.
-
Authorize User
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…
-
Cancel Box Sign Request
Cancels a pending Box Sign request that has not yet been fully signed or declined. After cancellation, any outstanding signers will no longer be able to sign the document. Only the user who created the request (the…
-
Change Shield Information Barrier Status
Change the status of a shield information barrier. Shield information barriers are ethical walls that prevent exchanges or communication between individuals/groups within the same enterprise to avoid conflicts of…
-
Commit Upload Session
Commits an upload session and creates a file from the uploaded chunks. This is the final step in a chunked upload workflow: 1. Create an upload session using 'create_upload_session' 2. Upload file parts using…
-
Copy File
Creates a copy of a file.
-
Copy File Request
Copies an existing file request to a new folder. File requests allow external users to upload files to a specific folder without needing a Box account. This action creates a copy of an existing file request and…
-
Copy Folder
Creates a copy of a folder within a destination folder. The original folder will not be changed.
-
Create AI Agent
Creates a custom AI agent in Box AI Studio. At least one capability required: ask (Q&A), text_gen (content generation), or extract (metadata extraction). Requirements: Box Enterprise Advanced account, Box AI Studio…
-
Create Box Sign Request
Creates a Box Sign request to send documents for electronic signing. Prepares documents and sends signature requests to signers via email. Signers do not need Box accounts. Supports up to 10 files, 35 signers…
-
Create Box Skill Cards on File
Applies one or more Box Skills metadata cards to a file. NOTE: This action creates NEW Box Skill cards on a file. If Box Skill cards already exist on the file, this action will fail with a 409 Conflict error. In that…
-
Create Collaboration
Adds a collaboration for a single user or a single group to a file or folder. Collaborations can be created using email address, user IDs, or a group IDs. If a collaboration is being created with a group, access to…
-
Create Comment
Adds a comment by the user to a specific file, or as a reply to an other comment.
-
Create Email Alias
Adds a new email alias to a user account. The email domain must be registered to your enterprise. Returns the newly created email alias object with id, type, email, and is_confirmed fields.
-
Create Folder
Creates a new empty folder within the specified parent folder.
-
Create Folder Lock
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 Group
Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.
-
Create Jobs to Terminate User Group Session
Terminates all active sessions for users belonging to the specified Box enterprise groups. This action validates the roles and permissions of each group, then creates asynchronous background jobs to terminate sessions…
-
Create Jobs to Terminate Users Session
Creates asynchronous jobs to terminate active Box sessions for specified users. Use this when a user account may be compromised, a device is lost/stolen, or you need to force users to re-authenticate. This logs out…
-
Create Legal Hold Policy
Create a new legal hold policy in Box. Legal hold policies are used to prevent permanent deletion of content during ongoing litigation. Once created, the policy can be assigned to specific users, folders, or files…
-
Create Metadata Cascade Policy
Creates a new metadata cascade policy that automatically applies a metadata template to all files and subfolders within a specified folder. Prerequisites: - A metadata instance must already be applied to the target…
-
Create Metadata Instance on File
Applies an instance of a metadata template to a file. The metadata_fields parameter contains key-value pairs that match the fields defined in the template. In most cases only field keys present in the metadata template…
-
Create 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…
-
Create Metadata Taxonomy
Tool to create a new metadata taxonomy in Box. Use when you need to set up a hierarchical classification system for organizing and categorizing metadata templates.
-
Create Metadata Taxonomy Levels
Creates new hierarchical levels for a metadata taxonomy in Box. Use this to define the structure of your taxonomy by specifying levels like Continent -> Country -> City. Each level must have a unique level number…
-
Create Metadata Taxonomy Node
Tool to create a new metadata taxonomy node within a specified taxonomy. Use when you need to add a new classification or category to an existing metadata taxonomy hierarchy.
-
Create Metadata Template
Creates a new metadata template that can be applied to files and folders.
-
Create Retention Policy
Creates a retention policy for managing content lifecycle in Box. Retention policies prevent permanent deletion of content for a specified duration. Once created, policies can be assigned to folders or the entire…
-
Create Shield Information Barrier
Creates a shield information barrier to establish an "ethical wall" that separates individuals/groups within an enterprise and prevents confidential information sharing. Prerequisites: Box Shield add-on must be…
-
Create Shield Information Barrier Report
Creates a shield information barrier report for a given barrier. Shield information barrier reports track the configuration status of information barriers in Box Shield. When created, reports start with status…
-
Create Shield Information Barrier Segment
Creates a new shield information barrier segment for compliance and information isolation. Segments represent organizational divisions (e.g., Investment Banking, Research, Trading) that need to be isolated from each…
-
Create Shield Information Barrier Segment Member
Adds a Box user to a shield information barrier segment for compliance and information security. This assigns users to segments that restrict collaboration between departments (e.g., Investment Banking vs Research in…
-
Create Shield Information Barrier Segment Restriction
Creates a ONE-WAY shield information barrier segment restriction preventing collaboration between members of two segments (e.g., Investment Banking cannot collaborate with Research). Prerequisites: - Box Shield add-on…
-
Create Slack Integration Mapping
Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this…
-
Create Task
Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately.
-
Create Teams Integration Mapping
Creates a Microsoft Teams integration mapping that links a Teams channel or team to a Box folder. Once mapped, files shared in the Teams channel are automatically stored in the linked Box folder. Requires…
-
Create Terms of Service
Creates a terms of service for a given enterprise and type of user. This action requires enterprise admin permissions with 'Edit settings for your company' enabled. The Terms of Service feature must also be enabled for…
-
Create Terms of Service Status for New User
Creates a terms of service status record for a user who has not previously accepted or rejected the terms. This action records whether a user has accepted or rejected a specific terms of service. Use this for users who…
-
Create Upload Session
Creates an upload session for chunked upload of large files (20MB+). This is the first step in Box's chunked upload process. After creating the session, you must: (1) upload file chunks using the upload_part endpoint…
-
Create Upload Session for Existing File
Creates an upload session for uploading a new version of an existing file using chunked upload. Use this for files larger than 20MB. The session provides endpoints for uploading file parts, committing the upload, and…
-
Create User
Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.
-
Create User Exemption From Collaboration Domain Restrictions
Exempts a specific user from the enterprise's collaboration domain restrictions. This allows the specified user to collaborate with external parties from any domain, bypassing the enterprise's allowed collaboration…
-
Create User Invite
Invites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to…
-
Create Web Link
Creates a web link object within a folder.
-
Create Webhook
Creates a webhook to monitor a file or folder for specific events. Webhooks allow you to receive notifications at a specified URL when events occur on Box content. When an event triggers, Box sends an HTTP POST request…
-
Create Zip Download
Creates a request to download multiple files and folders as a single `zip` archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and…
-
Delete AI Agent
Permanently deletes a custom AI agent from Box AI Studio. This action removes the specified AI agent and all its configuration, including any custom instructions and capability settings. This operation cannot be…
-
Delete File
Deletes a file from Box by moving it to trash or permanently (based on enterprise settings). Use the `if_match` parameter with the file's ETag for safe concurrent operations. To permanently delete a trashed file, use…
-
Delete File Request
Deletes a file request permanently. File requests allow external users to upload files to a specific folder without needing a Box account. This action permanently deletes a file request. IMPORTANT LIMITATION: File…
-
Delete Folder
Deletes a folder, either permanently or by moving it to the trash.
-
Delete Folder Lock
Deletes a folder lock on a given folder, removing restrictions on move and delete operations. You must be authenticated as the owner or co-owner of the folder to use this endpoint. This action removes a lock that was…
-
Delete Retention Policy
Permanently deletes a retention policy from the Box enterprise. This action removes the specified retention policy. Once deleted, the policy cannot be recovered. Only modifiable retention policies can be deleted…
-
Delete Shield Information Barrier Segment
Permanently deletes a shield information barrier segment by its ID. Shield information barriers help prevent conflicts of interest by restricting collaboration between user segments within an organization. This action…
-
Delete Shield Information Barrier Segment Member by Id
Removes a user from a shield information barrier segment by deleting their membership. Shield information barriers are used to prevent conflicts of interest by restricting communication and collaboration between…
-
Delete Shield Information Barrier Segment Restriction by Id
Deletes a shield information barrier segment restriction by its unique ID. Shield information barrier segment restrictions define which segments cannot communicate with each other. When a restriction is deleted, users…
-
Delete Slack Integration Mapping
Deletes a Slack integration mapping that links a Box folder to a Slack channel. This endpoint removes an existing mapping between a Slack channel and a Box folder created through the Box for Slack integration. After…
-
Delete Teams Integration Mapping
Deletes a Microsoft Teams integration mapping that links a Box folder to a Teams channel. This endpoint removes an existing mapping between a Microsoft Teams channel or team and a Box folder created through the Box for…
-
Delete User
Permanently deletes a user from the enterprise. By default, deletion fails if the user still owns content, was recently active, or recently joined from a free account. Use the `force` parameter to bypass these…
-
Delete User Avatar
Deletes a user's custom avatar image from Box. This operation is irreversible. After deletion, the user will revert to the default Box avatar. If the user does not have a custom avatar set (only the default avatar)…
-
Download File
Returns the contents of a file in binary format.
-
Download Zip Archive
Downloads a zip archive containing files and/or folders from Box. **Prerequisites**: You must first call 'BOX_CREATE_ZIP_DOWNLOAD' to create a zip download request. The response from that action contains a…
-
Extract Metadata Freeform
Extract metadata from Box files using AI with freeform prompts. Use this action to extract custom metadata from files without needing a predefined metadata template. Box AI will analyze the file contents and extract…
-
Extract Metadata Structured
Extract structured metadata from files using Box AI. Uses Large Language Models (LLMs) to extract metadata as key-value pairs from files. Requires Box AI access (ai.readwrite scope). Supports two extraction approaches…
-
Find File for Shared Link
Returns the file represented by a shared link. A shared file can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve…
-
Find Folder for Shared Link
Return the folder represented by a shared link. A shared folder can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve…
-
Find Item for Shared Link
Returns the file, folder, web link, or app item represented by a shared link. This endpoint allows you to retrieve information about any Box item (file, folder, web link, or app item) using its shared link URL. The…
-
Find Metadata Template by Instance Id
Finds a metadata template by searching for the ID of an instance of the template. This action is useful when you have a metadata instance ID (the '$id' field from a metadata instance on a file or folder) and need to…
-
Force Apply Metadata Cascade Policy to Folder
Forces a metadata cascade policy to immediately apply the folder's metadata template to all existing child files and subfolders. This operation is asynchronous and returns immediately with HTTP 202 Accepted. Use cases…
-
Generate Text
Generate text using Box AI based on a prompt and file context. This action sends a request to Box AI's text generation endpoint, which uses Large Language Models (LLMs) to generate text based on your prompt and the…
-
Get AI Agent by ID
Retrieves detailed information about a specific AI Agent by its unique identifier. **Use Cases:** - Get the current configuration and capabilities of an AI agent - Check the access state and allowed users/groups for an…
-
Get Ai Agent Default Configuration
Retrieve the default AI agent configuration for a specific mode. Returns the default AI agent settings used by Box AI features. The configuration includes model settings, token limits, LLM endpoint parameters, and tool…
-
Get Allowed Collaboration Domain
Retrieves details of a specific allowed collaboration domain entry within your enterprise. This endpoint returns information about a domain that has been whitelisted for collaboration, including the domain name, the…
-
Get Box Sign Request by Id
Retrieves the details of a specific Box Sign request by its unique ID. Returns comprehensive information about the signature request including: - Request status (e.g., 'converting', 'created', 'sent', 'viewed'…
-
Get Box Sign Template by ID
Retrieves details of a specific Box Sign template by its unique ID. Returns template configuration including name, email subject/message, signers, source files, destination folder, and various lock settings that…
-
Get Collaboration
Retrieves details of a single collaboration by its ID. A collaboration represents shared access between a user/group and a file or folder in Box. This action returns information about who has access, what role they…
-
Get Collection by Id
Retrieves details of a specific collection by its unique identifier. Collections in Box are used to organize items (files and folders). Currently, Box only supports the 'favorites' collection, which contains items that…
-
Get Comment
Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.
-
Get Current User
Retrieves information about the user who is currently authenticated. In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app. In the case of a JWT, server-side…
-
Get Device Pin
Retrieves information about an individual device pin in the enterprise. Device pins are created when users access Box from mobile or desktop devices that support device pinning. This endpoint returns details about a…
-
Get File Information
Retrieves the details about a file.
-
Get File Request
Retrieves detailed information about a file request in Box. File requests are forms that allow external users to upload files to a specific folder without needing a Box account. This action returns the file request's…
-
Get File Thumbnail
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…
-
Get File Version
Retrieve detailed information about a specific version of a file. This action returns metadata about a file version including its SHA1 hash, size, creation date, and who modified it. Versions are only tracked for Box…
-
Get File Version Legal Hold
Retrieves detailed information about a specific file version legal hold by its ID. A file version legal hold represents the preservation of a specific file version due to legal hold policies. This action returns the…
-
Get File Versions Under Retention
Returns a list of file versions under retention for a specified retention policy assignment. A retention policy assignment links a retention policy to content (enterprise, folder, or metadata template). This endpoint…
-
Get Files Under Retention
Returns a paginated list of files under retention for a specific retention policy assignment. This endpoint is part of Box Governance and requires: - 'manage_retention_policies' scope enabled for the application -…
-
Get Folder Information
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…
-
Get Group
Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.
-
Get Group Membership
Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
-
Get Legal Hold Policy
Retrieve detailed information about a specific legal hold policy by its ID. Legal hold policies preserve content for litigation or compliance purposes by preventing deletion or modification. This action returns the…
-
Get Legal Hold Policy Assignment
Retrieves detailed information about a specific legal hold policy assignment by its ID. Legal hold policy assignments link a legal hold policy to specific items (files, folders, file versions, users, ownership-based…
-
Get Metadata Cascade Policy
Retrieve a specific metadata cascade policy assigned to a folder.
-
Get Metadata Instance on File
Retrieves a specific metadata template instance that has been applied to a file. This action returns the metadata key-value pairs for a particular template on a file. Use BOX_LIST_METADATA_INSTANCES_ON_FILE first to…
-
Get Metadata Instance on 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 Taxonomies for Namespace
Retrieves all metadata taxonomies within a specific namespace. Use this when you need to list all taxonomy templates available in an enterprise namespace.
-
Get Metadata Taxonomy by Taxonomy Key
Retrieves a metadata taxonomy by its namespace and taxonomy key. Use when you need to fetch detailed information about a specific taxonomy structure.
-
Get Metadata Taxonomy Node by ID
Retrieves a specific node from a metadata taxonomy by its identifier. Use when you need to get details about a particular taxonomy node including its display name, level, and ancestor information.
-
Get Metadata Template by Id
Retrieves a metadata template by its ID.
-
Get Metadata Template by Name
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…
-
Get Real-Time Server URL for Long-Polling Events
Returns a list of real-time servers that can be used for long-polling user events. Long-polling allows applications to listen for events in real-time without repeatedly polling the /events endpoint. After calling this…
-
Get Retention Policy
Retrieves a retention policy by its unique ID. Retention policies define how long content is retained before being automatically deleted or having the retention removed. This is an enterprise-level feature that…
-
Get Retention Policy Assignment
Retrieves a retention policy assignment by its unique ID. A retention policy assignment represents a link between a retention policy and its target (a folder, the enterprise, or a metadata template). This action…
-
Get Shared Items Web Links
Tool to retrieve web link information for a shared link. Use when you have a Box shared link URL and need to get details about the web link object it points to.
-
Get Shared Link for File
Retrieves the shared link information for a file. This action fetches details about an existing shared link, including the URL, access level, permissions, and usage statistics. If the file does not have a shared link…
-
Get Shared Link for Folder
Retrieves shared link information for a folder. This action fetches the shared link details for a specified folder, including the public URL, access level, permissions, and usage statistics. If the folder does not have…
-
Get Shield Information Barrier Report by Id
Retrieves a shield information barrier report by its ID. Shield information barrier reports provide information about users and groups that are affected by shield information barriers in the enterprise. Reports include…
-
Get Shield Information Barrier Segment Member by Id
Retrieves a shield information barrier segment member by its unique ID. Shield Information Barriers enforce compliance by restricting collaboration between departments (e.g., Investment Banking vs Research in financial…
-
Get Shield Information Barrier Segment Restriction by Id
Retrieves a shield information barrier segment restriction by its unique ID. Shield information barrier segment restrictions define which segments cannot communicate or collaborate with each other. This action fetches…
-
Get Shield Information Barrier Segment with Specified Id
Retrieves a shield information barrier segment by its unique identifier. Shield information barriers are used to prevent conflicts of interest by restricting communication between specific groups of users. Segments…
-
Get Shield Information Barrier with Specified Id
Retrieves a shield information barrier by its unique ID. Shield information barriers are used to separate individuals/groups within the same enterprise and prevent confidential information from passing between them…
-
Get Storage Policy
Fetches a specific storage policy by its ID. Storage policies define the geographic location where content is stored (data residency). This is an enterprise feature that requires Box Zones or similar subscription. Use…
-
Get Storage Policy Assignment
Retrieves information about a specific storage policy assignment. Storage policies control where data is physically stored (data residency). This action requires the Box Zones add-on or equivalent enterprise feature…
-
Get Task
Retrieves detailed information about a specific task in Box. A task is a to-do item that can be assigned to users for a specific file. Tasks can be of type 'review' (approval workflow) or 'complete' (general task). Use…
-
Get Task Assignment
Retrieves detailed information about a specific task assignment in Box. A task assignment represents a task that has been assigned to a specific user. This endpoint returns information including: - The file associated…
-
Get Terms of Service
Retrieves a specific terms of service by its unique identifier. Returns the full terms of service object including: - Status (enabled/disabled) - Terms text content - Type (managed users or external collaborators) -…
-
Get Trashed 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…
-
Get Trashed Folder
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…
-
Get Trashed Web Link
Retrieves a web link that has been moved to the trash. Returns detailed information about a trashed web link including its original URL, name, description, creator, when it was trashed, and when it will be permanently…
-
Get Upload Session
Retrieves detailed information about an existing chunked upload session. Returns the session status including: - Total number of parts expected for the file upload - Size of each part in bytes - Number of parts already…
-
Get User
Retrieves information about a user in the enterprise. The application and the authenticated user need to have the permission to look up users in the entire enterprise. This endpoint also returns a limited set of…
-
Get User Avatar
Retrieves the avatar image of a Box user. Returns 404 if the user has no avatar set.
-
Get User Exempt From Collaboration Domain Restrictions
Retrieves details of a specific user exemption from collaboration domain restrictions. This endpoint returns information about a user who has been granted an exemption from the enterprise's collaboration domain…
-
Get User Invite Status
Returns the status of a user invite. This endpoint retrieves detailed information about a specific invite, including: - The invited user's details (email, name, ID) - The enterprise they were invited to - The user who…
-
Get Watermark for Folder
Retrieve the watermark for a folder.
-
Get Watermark on File
Retrieve the watermark for a file. Returns the watermark information (created_at and modified_at timestamps) for a file that has a watermark applied. If the file does not have a watermark, a 404 Not Found error is…
-
Get Web Link
Retrieve detailed information about a web link (bookmark) in Box. Returns the full web link object including its URL, name, description, parent folder, path collection, creation and modification timestamps, and…
-
Get Webhook
Retrieves detailed information about a specific webhook by its ID. Use this action to get the configuration of an existing webhook, including the target item being monitored (file or folder), the notification URL, the…
-
Get Zip Download Status
Get the download status of a zip archive, including progress, skipped items, and current state. **Prerequisites:** Call 'BOX_CREATE_ZIP_DOWNLOAD' first to get a zip_download_id, then initiate the download via…
-
List Ai Agents
Lists AI agents based on the provided parameters.
-
List All Classifications
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…
-
List All Collections
Retrieves all collections for a given user. Currently, only the `favorites` collection is supported.
-
List All File Versions
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 Global Metadata Templates
Used to retrieve all generic, global metadata templates available to all enterprises using Box.
-
List All Legal Hold Policies
Retrieves a list of legal hold policies that belong to an enterprise.
-
List All Metadata Templates for Enterprise
Used to retrieve all metadata templates created to be used specifically within the user's enterprise
-
List All Webhooks
Returns all defined webhooks for the requesting application. This API only returns webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin can not see webhooks…
-
List Allowed Collaboration Domains
Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.
-
List Box Hubs
Tool to list all Box Hubs for the authenticated user or enterprise. Use when you need to retrieve, search, or filter Box Hubs.
-
List Box Sign Requests
Gets signature requests created by a user. If the `sign_files` and/or `parent_folder` are deleted, the signature request will not return in the list.
-
List Box Sign Templates
Gets Box Sign templates created by a user.
-
List Box Skill Cards on File
List the Box Skills metadata cards that are attached to a file.
-
List Collection Items
Retrieves the files and/or folders contained within a Box collection. Collections in Box are used to organize content. Currently, Box supports one type of collection: 'Favorites', which allows users to mark files and…
-
List Enterprise Device Pins
Retrieves all the device pins within an enterprise. The user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.
-
List Enterprise Users
Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`. The application and the authenticated user need to have the permission to look up users in the entire enterprise.
-
List File App Item Associations
**This is a beta feature, which means that its availability might be limited.** Returns all app items the file is associated with. This includes app items associated with ancestors of the file. Assuming the context…
-
List File Collaborations
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 Comments
Retrieves a list of comments for a file.
-
List File Version Legal Holds
Get a list of file versions on legal hold for a legal hold assignment. Due to ongoing re-architecture efforts this API might not return all file versions for this policy ID. Instead, this API will only return file…
-
List Folder App Item Associations
**This is a beta feature, which means that its availability might be limited.** Returns all app items the folder is associated with. This includes app items associated with ancestors of the folder. Assuming the context…
-
List Folder Collaborations
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 Locks
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 Group Collaborations
Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups. Each collaboration object has details on which files or folders the group has access to and with what…
-
List Groups for Enterprise
Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.
-
List Items in 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 Legal Hold Policy Assignments
Retrieves a list of items a legal hold policy has been assigned to.
-
List Members of Group
Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.
-
List Metadata Cascade Policies
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 Instances on File
Retrieves all metadata instances applied to a file. Returns all metadata template instances that have been applied to the specified file, including both enterprise and global templates. The API does not support…
-
List Metadata Instances on Folder
Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.
-
List Metadata Taxonomy Nodes
Retrieves metadata taxonomy nodes based on the specified parameters. Use when you need to browse or search hierarchical metadata classifications in Box. Results are sorted in lexicographic order unless a query…
-
List Pending Collaborations
Retrieves all pending collaboration invites for this user.
-
List Previous File Versions for Legal Hold Policy Assignment
Retrieves a list of previous (non-current) file versions that are on legal hold for a specific legal hold policy assignment. This endpoint returns file versions held under the new Box architecture. For current (latest)…
-
List Recently Accessed Items
Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.
-
List Retention Policies
Retrieves all of the retention policies for an enterprise.
-
List Retention Policy Assignments
Retrieves all retention policy assignments for a specified retention policy. Retention policies can be assigned to: - 'enterprise': Apply to all content in the enterprise - 'folder': Apply to a specific folder -…
-
List Shield Information Barrier Reports
Lists shield information barrier reports for a specified barrier. Shield information barrier reports contain details about barrier violations and compliance status. This feature requires Box Shield enterprise license…
-
List Shield Information Barrier Segment Members
Lists shield information barrier segment members based on provided segment IDs.
-
List Shield Information Barrier Segment Restrictions
Lists all shield information barrier segment restrictions for a specific segment. Shield information barrier segment restrictions define which segments are prevented from collaborating with each other. This endpoint…
-
List Shield Information Barrier Segments
Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID. Shield Information Barriers are used to separate individuals/groups within the same enterprise to prevent…
-
List Shield Information Barriers
Retrieves a list of shield information barrier objects for the enterprise of JWT.
-
List Slack Integration Mappings
Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
-
List Storage Policies
Fetches all the storage policies in the enterprise.
-
List Storage Policy Assignments
Fetches all the storage policy assignment for an enterprise or user.
-
List Task Assignments
Lists all of the assignments for a given task. Returns a collection of task assignment objects showing who has been assigned to complete or review a task. Each assignment includes the assigned user's details, the…
-
List Tasks on File
Retrieves a list of all the tasks for a file. This endpoint does not support pagination.
-
List Teams Integration Mappings
Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
-
List Terms of Service User Statuses
Retrieves a list of users and their acceptance status for a specific terms of service. Returns information about whether each user has accepted the terms, including: - User details (ID, name, email) - Acceptance status…
-
List Terms of Services
Returns the current terms of service text and settings for the enterprise.
-
List Trashed Items
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…
-
List Upload Session Parts
List the parts (chunks) that have been uploaded to a chunked upload session. This is useful for tracking upload progress, verifying which parts have been successfully uploaded, and determining which parts still need to…
-
List User and Enterprise Events
Returns up to a year of past events for a given user or for the entire enterprise. By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to…
-
List User's Email Aliases
Retrieves all email aliases for a user. The collection does not include the primary login for the user.
-
List User's Groups
Retrieves all group memberships for a user, including the groups they belong to and their role in each group (member or admin). Only members of this group or users with admin-level permissions will be able to use this…
-
List Users Exempt From Collaboration Domain Restrictions
Returns a list of users who have been exempt from the collaboration domain restrictions. Note: This endpoint requires an enterprise account with collaboration domain restrictions enabled. A 403 Forbidden error will be…
-
List Workflows
Lists Box Relay workflows configured for a specific folder. Use the 'trigger_type' parameter to filter workflows by trigger type (e.g., 'WORKFLOW_MANUAL_START' for workflows that can be manually started via API). Your…
-
Permanently Remove File
Permanently deletes a file from the trash. This action is irreversible and cannot be undone. The file must already be in the trash before it can be permanently removed. To move a file to trash first, use the 'Delete…
-
Permanently Remove Folder
Permanently deletes a folder that is in the trash. This action cannot be undone.
-
Permanently Remove Web Link
Permanently deletes a web link that is in the trash. This action cannot be undone.
-
Preflight Check Before Upload
Performs a preflight check to verify that a file will be accepted by Box before uploading the entire file. This helps verify permissions, quota, and filename conflicts before starting the actual upload. A successful…
-
Promote 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…
-
Query Files Folders by Metadata
Query files and folders by metadata using SQL-like syntax. Returns items that have metadata instances matching the specified template and optional query conditions. Use this action when you need to find files/folders…
-
Refresh Access Token
Refresh an Access Token using its client ID, secret, and refresh token. This endpoint exchanges a refresh token for a new access token. The refresh token must be valid (they expire after 60 days). Each time a refresh…
-
Remove Box Skill Cards From File
Removes any Box Skills cards metadata from a file.
-
Remove Collaboration
Removes a collaboration from a file or folder, revoking the collaborator's access. A collaboration in Box represents shared access granted to a user or group on a file or folder. Removing a collaboration will: - Revoke…
-
Remove Comment
Permanently deletes a comment from a file or folder in Box. This action removes a comment that was previously added to a Box item. Once deleted, the comment cannot be recovered. The operation returns HTTP 204 (No…
-
Remove Device Pin
Deletes an individual device pin from the enterprise. Device pins are created when users access Box from mobile or desktop devices that support device pinning. Removing a device pin will require the user to…
-
Remove Domain From List of Allowed Collaboration Domains
Removes a domain from the list of allowed collaboration domains (whitelist) within your enterprise. This action deletes a specific collaboration whitelist entry, preventing users from that domain from collaborating on…
-
Remove Email Alias
Removes an email alias from a user. This endpoint permanently deletes an email alias associated with a user account. Note: You cannot remove a user's primary email address. To change the primary email, you must first…
-
Remove File Version
Move a file version to the trash. Versions are only tracked for Box users with premium accounts.
-
Remove Group
Permanently deletes a group. Only users with admin-level permissions will be able to use this API.
-
Remove Legal Hold Policy
Permanently delete an existing legal hold policy from Box. This is an asynchronous operation - the policy deletion is initiated but may not complete immediately. A successful response (HTTP 202) indicates the deletion…
-
Remove Metadata Cascade Policy
Permanently deletes a metadata cascade policy from a folder. When deleted, existing metadata on files/subfolders remains, but new items will no longer automatically inherit the template. Prerequisites: Requires…
-
Remove Metadata Instance From File
Removes a metadata instance from a file. Deletes all metadata associated with a specific template from a file. This operation cannot be undone. The metadata template itself is not deleted, only the instance of metadata…
-
Remove Metadata Instance From Folder
Remove a metadata instance from a folder. Deletes a specific metadata template instance that has been applied to a folder. This operation is idempotent and will return a 404 error if the metadata instance doesn't…
-
Remove Metadata Taxonomy
Permanently deletes a metadata taxonomy from the enterprise. This deletion is permanent and cannot be reverted. Once deleted, the taxonomy and all associated metadata will be removed from files and folders. Use with…
-
Remove Metadata Taxonomy Node
Permanently deletes a metadata taxonomy node from Box. Metadata taxonomies in Box allow you to organize and classify content using hierarchical structures. This action removes a specific node from a taxonomy. Important…
-
Remove Metadata Template
Permanently delete a metadata template and all its instances from files and folders. **WARNING**: This operation is destructive and cannot be undone. Once deleted: - The template definition is permanently removed - All…
-
Remove Retention Policy Assignment
Removes a retention policy assignment from content in Box. This action permanently removes the link between a retention policy and its assigned target (folder, enterprise, or metadata template). Once removed, the…
-
Remove Shared Link From File
Removes a shared link from a file in Box. This action disables the shared link for the specified file, making it no longer accessible via the previously shared URL. The file itself is not deleted - only the shared link…
-
Remove Shared Link From Folder
Removes a shared link from a folder in Box. This action disables the shared link for the specified folder, making it no longer accessible via the previously shared URL. The folder itself is not deleted - only the…
-
Remove Shared Link From Web Link
Removes a shared link from a web link in Box. This action disables the shared link for the specified web link, making it no longer accessible via the previously shared URL. The web link itself is not deleted - only the…
-
Remove Task
Permanently deletes a task from Box. Tasks are work assignments on files that can be assigned to collaborators for review or completion. Once deleted, the task and its assignments are permanently removed and cannot be…
-
Remove Upload Session
Abort and permanently remove a chunked upload session, discarding all uploaded data. This action is irreversible - once removed, all uploaded file parts are permanently deleted and the upload session cannot be…
-
Remove User Domain Exemption
Removes a user's exemption from the enterprise's collaboration domain restrictions. After removal, the user will be subject to the allowed collaboration domain list configured for the enterprise and can no longer…
-
Remove User From Group
Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
-
Remove Watermark From File
Removes the watermark from a file. This action deletes the watermark that was previously applied to the specified file. After removal, the file will no longer display watermark overlays when viewed or downloaded…
-
Remove Watermark From Folder
Removes the watermark from a folder. This action deletes the watermark applied to a specified folder. The folder must have a watermark applied to it, otherwise the API will return a 404 error. Only users with Owner…
-
Remove Web Link
Deletes a web link.
-
Remove Webhook
Permanently deletes a webhook from the Box account. Webhooks are used to receive notifications at a specified URL when events occur on Box content. Once deleted, the webhook will no longer send notifications for its…
-
Request Access Token
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…
-
Resend Box Sign Request
Resends signature request emails to all outstanding signers. Use this when a signer did not receive the original email, the email was lost, or the signer accidentally deleted it. The email is sent asynchronously after…
-
Restore File
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 Version
Restores a specific version of a file after it was deleted (trashed). This action restores a file version that was previously moved to the trash by setting its trashed_at field back to null. Do not use this endpoint to…
-
Restore Folder
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. During this operation, part of the file tree will be…
-
Restore Web Link
Restores a web link that has been moved to the trash. This action recovers a trashed web link and restores it to its original parent folder. If the original folder has been deleted, you can optionally specify an…
-
Review Files on Legal Hold Policy Assignment
Get a list of files with current file versions for a legal hold assignment. In some cases you may want to get previous file versions instead. In these cases, use the `GET…
-
Revoke Access Token
Revoke an active Access Token, effectively logging a user out that has been previously authenticated.
-
Search for Content
Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.
-
Starts Workflow Based on Request Body
Starts a Box Relay workflow with trigger type `WORKFLOW_MANUAL_START`. Prerequisites: - Your application must have the 'Manage Box Relay' scope enabled in the Box Developer Console. - Use the 'List Workflows' endpoint…
-
Transfer Owned Folders
Transfers all files and folders owned by one user to another user's account in Box. This creates a new folder in the destination user's root directory containing all the source user's content. The operation is commonly…
-
Trim Metadata Taxonomy Levels
Deletes the last level from a metadata taxonomy by trimming it. Use when you need to remove the deepest hierarchical level from a taxonomy structure.
-
Unassign Legal Hold Policy
Remove a legal hold policy assignment from an item (user, folder, file, or file version). This endpoint unassigns a legal hold policy by deleting the assignment record. When successful, the API returns a 202 Accepted…
-
Unassign Storage Policy
Deletes a storage policy assignment, causing the assigned user to inherit the enterprise's default storage policy (Box Zone). Use this action when you want to reset a user's storage policy back to the enterprise…
-
Unassign Task
Deletes a specific task assignment, removing the task from the assigned user. This action unassigns a user from a task without deleting the task itself. The task remains on the file and can be reassigned to other…
-
Update AI Agent
Updates an existing custom AI agent in Box AI Studio. You can modify the agent's name, access settings, icon, and capability configurations (ask, text_gen, extract). **Requirements:** - Box Enterprise Advanced account…
-
Update All Box Skill Cards on File
An alternative method to overwrite and update all Box Skill metadata cards on a file. IMPORTANT: This endpoint is designed for Box Skills applications. The skill_id parameter must be a valid Box-assigned skill…
-
Update Box Skill Cards on File
Updates one or more Box Skills metadata cards on a file using JSON-Patch format. This action allows you to selectively update specific skill cards by their index position without affecting other cards. Use the…
-
Update Collaboration
Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites.
-
Update Comment
Update the message of a comment.
-
Update File
Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.
-
Update File Request
Updates a file request in Box. File requests allow external users to upload files to a specific folder without needing a Box account. Use this action to modify file request settings such as title, description, status…
-
Update Folder
Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.
-
Update Group
Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.
-
Update Group Membership
Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
-
Update Legal Hold Policy
Update an existing legal hold policy in Box. This action allows you to modify the name, description, and release notes of an existing legal hold policy. Legal hold policies are used to preserve content for litigation…
-
Update Metadata Instance on File
Updates a metadata instance on a file using JSON-Patch operations. The metadata template must already be applied to the file before it can be updated. Only values that match the template schema are accepted. The update…
-
Update Metadata Instance on Folder
Updates metadata on a folder using JSON-Patch operations (RFC 6902). The metadata template must already be applied to the folder. Only values matching the template schema are accepted (except global.properties which…
-
Update Metadata Taxonomy
Tool to update an existing metadata taxonomy's display name. Use when you need to rename a taxonomy while keeping its structure and key intact.
-
Update Metadata Taxonomy Node
Tool to update an existing metadata taxonomy node's display name. Use when you need to rename a taxonomy node in the Box metadata taxonomy hierarchy.
-
Update Metadata Template
Updates a metadata template by applying JSON-Patch operations. The template must already exist. The update is applied atomically - if any error occurs during the application of operations, the metadata template will…
-
Update Retention Policy
Updates an existing Box retention policy. Use this action to modify retention policy settings such as name, description, retention duration, disposition action, and notification settings. Requires Box Governance add-on…
-
Update Shared Link on File
Updates a shared link on a file.
-
Update Shared Link on Folder
Updates a shared link on a folder.
-
Update Shared Link on Web Link
Updates a shared link on a web link.
-
Update Shield Information Barrier Segment with Specified Id
Updates a shield information barrier segment's name and/or description. Shield Information Barrier segments represent organizational divisions (e.g., 'Investment Banking', 'Research', 'Trading') that need to be…
-
Update Slack Integration Mapping
Updates an existing [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). Use this to change which Box folder is mapped to a Slack channel, or to…
-
Update Storage Policy Assignment
Updates a storage policy assignment for an enterprise or user. Storage policies control where data is stored geographically (data residency). Use this action to change which storage policy is assigned to a user or…
-
Update Task
Updates a task. This can be used to update a task's configuration, or to update its completion state.
-
Update Task Assignment
Updates a task assignment to change its resolution state or add a message. This endpoint allows updating the state of a task assigned to a user. Use this to mark tasks as completed, approved, rejected, or incomplete…
-
Update Teams Integration Mapping
Updates a Microsoft Teams integration mapping that links a Box folder to a Teams channel. This endpoint allows you to change which Box folder is associated with a Microsoft Teams channel through the Box for Teams…
-
Update Terms of Service
Updates an existing terms of service for the enterprise. This action allows you to modify the status (enabled/disabled) and text content of an existing terms of service. When enabled, users will be prompted to accept…
-
Update Terms of Service Status for Existing User
Updates the acceptance status of a terms of service for a user who has previously accepted or rejected it. This action allows you to change whether a user has accepted or rejected a specific terms of service. Use this…
-
Update User
Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.
-
Update Web Link
Updates a web link object. This action allows you to modify an existing web link's properties including: - Changing the URL destination - Updating the name and description - Moving it to a different folder -…
-
Update Webhook
Updates an existing webhook's configuration. Use this action to modify a webhook's target item (file or folder), notification URL, or event triggers. Only the fields provided in the request will be updated; omitted…
-
Upload File
Uploads a small file to Box. For file sizes over 50MB we recommend using the Chunk Upload APIs. The `attributes` part of the body must come **before** the `file` part. Requests that do not follow this format when…
-
Upload File Version
Update a file's content. For file sizes over 50MB we recommend using the Chunk Upload APIs. The `attributes` part of the body must come **before** the `file` part. Requests that do not follow this format when uploading…
-
Upload Part of File
Uploads a chunk of a file for an upload session. The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) and [`Get upload session`](e://get-files-upload-sessions-id)…
-
Box Sign Request Status Changed
Triggers when a Box Sign request's status or meaningful fields change. This trigger monitors a specific Box Sign request and fires when changes are detected in key fields like status, signer decisions, document…
-
Collaboration Details Changed
Triggers when a collaboration's details change (e.g., role, status, expiration). This trigger monitors a specific collaboration and detects when any meaningful field changes, such as role, status, expiration date…
-
Comment Changed
Triggers when a comment's content or details change in Box. This trigger monitors a specific Box comment and detects when any meaningful field changes, such as message text edits, tagged message changes, or…
-
File Metadata Changed
Triggers when a file's metadata or properties change in Box. This trigger monitors a specific Box file and fires when changes are detected in key fields like name, description, size, modification time, parent folder…
-
File Shared Link Changed
Triggers when a file's shared link settings change in Box. This trigger monitors a specific Box file's shared link and fires when changes are detected in the shared link configuration, such as access level…
-
Folder Properties Changed
Triggers when a folder's core properties change in Box. This trigger monitors a specific Box folder and fires when changes are detected in properties like name, description, modification time, parent folder, item…
-
Folder Shared Link Changed
Triggers when a folder's shared link settings change in Box. This trigger monitors a specific Box folder's shared link and fires when changes are detected in the shared link configuration, such as access level…
-
New File Added to Folder
Triggers when a new file is added to a folder in Box. This trigger monitors a specific Box folder and fires when new files are detected. Only files (not folders or web links) are monitored.
-
New File Comment Added
Triggers when a new comment is added to a file in Box. This trigger monitors a specific Box file and fires when new comments are detected.
-
New File Version Uploaded
Triggers when a new file version is uploaded to a file in Box. This trigger monitors a specific Box file and fires when new versions are detected.
-
New Folder Collaboration Created
Triggers when a new collaboration is created on a specific folder in Box. This trigger monitors a specific Box folder and fires when new collaborations are detected.
-
New Item Added to Folder
Triggers when a new item (file, folder, or web link) is added to a folder in Box. This trigger monitors a specific Box folder and fires when new items are detected.
-
New Pending Collaboration Invite
Triggers when a new pending collaboration invite is created. This trigger monitors the user's pending collaborations and fires when new pending collaboration invites are detected.
-
New Sign Request Created
Triggers when a new Box sign request is created. This trigger monitors Box sign requests and fires when new sign requests are detected.
-
New Task Assignment Added
Triggers when a new assignment is added to a task in Box. This trigger monitors a specific Box task and fires when new assignments are detected.
-
New Task Created on File
Triggers when a new task is created on a Box file. This trigger monitors a specific Box file and fires when new tasks are detected.
-
Task Assignment State Changed
Triggers when a task assignment's state changes. This trigger monitors task assignments for a specific task and detects when the resolution_state changes (e.g., from incomplete to completed, or from completed to…
-
Task State Changed
Triggers when a task's status or details change in Box. This trigger monitors a specific Box task and fires when changes are detected in key fields like status, due date, message, or completion state.
-
Trashed File State Changed
Triggers when a file's trash state changes in Box. This trigger monitors a specific Box file and fires when its trash state changes (e.g., moved to trash or restored from trash).
-
Trashed Folder State Changed
Triggers when a folder's trash state changes in Box. This trigger monitors a specific Box folder and fires when its trash state changes (e.g., moved to trash or restored from trash).
Setup
Connect Box in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
