File Storage
📦 Box integration
Access levels: Read-only · Read + write · Admin · Verified
File Storage
Access levels: Read-only · Read + write · Admin · Verified
Connect Box once and every agent in your squad can work in it for you, with exactly as much access as you decide to give, and a receipt for every call it makes.
You can change an account's access level any time under Manage. It applies instantly, no re-authorization. If the connection ever expires, the card shows Reconnect; one click re-authorizes the same account with the same settings.
Multiple accounts: connect as many as you need (say, yours and a client's). One is primary. Agents use it unless a mission says otherwise.
The level you pick at connect time is enforced on our side for every agent call: an agent can never do more than the level allows, no matter what it's asked.
| Level | What it allows | |
|---|---|---|
| Read-only | Read all files and folders. | |
| Read + write | Read, upload, edit, comment, and delete files. | Recommended |
| Admin | Read/write plus user and enterprise management. |
On top of the connection's level, every agent can be individually allowed, scoped down, or denied for this app from the Integrations page. Deny an agent and it doesn't even see the connection.
The 286 tools agents use in Box through Mission Control, and the lowest access level that includes each. Agents discover these themselves. You never have to name a tool; asking in plain language is enough.
| Tool | What it does | Access level |
|---|---|---|
Add allowed collaboration domainBOX_ADD_ALLOWED_COLLABORATION_DOMAIN | Creates a new entry in the list of allowed domains for collaboration within your enterprise. | Read + write, Admin |
Add classification to fileBOX_ADD_CLASSIFICATION_TO_FILE | Adds a classification to a file by specifying the label of the classification to add. | Read + write, Admin |
Add classification to folderBOX_ADD_CLASSIFICATION_TO_FOLDER | Adds a classification to a folder by specifying the label of the classification to add. | Read + write, Admin |
Add initial classificationsBOX_ADD_INITIAL_CLASSIFICATIONS | Initializes the classification template for an enterprise with an initial set of classification options. | Read + write, Admin |
Add or update user avatarBOX_ADD_OR_UPDATE_USER_AVATAR | Adds or updates a user avatar. | Read + write, Admin |
Add shared link to fileBOX_ADD_SHARED_LINK_TO_FILE | Adds a shared link to a file. | Read + write, Admin |
Add shared link to folderBOX_ADD_SHARED_LINK_TO_FOLDER | Adds a shared link to a folder, allowing it to be shared with others via a URL. | Read + write, Admin |
Add shared link to web linkBOX_ADD_SHARED_LINK_TO_WEB_LINK | Adds a shared link to a web link. | Read + write, Admin |
Add user to groupBOX_ADD_USER_TO_GROUP | Creates a group membership. Only users with admin-level permissions will be able to use this API. | Read + write, Admin |
Append metadata taxonomy levelBOX_APPEND_METADATA_TAXONOMY_LEVEL | Appends a new level to a metadata taxonomy structure. | Read + write, Admin |
Apply watermark to fileBOX_APPLY_WATERMARK_TO_FILE | Applies or update a watermark on a file. | Read + write, Admin |
Apply watermark to folderBOX_APPLY_WATERMARK_TO_FOLDER | Applies or update a watermark on a folder. | Read + write, Admin |
Ask questionBOX_ASK_QUESTION | Ask questions about Box files using Box AI. | All levels |
Assign legal hold policyBOX_ASSIGN_LEGAL_HOLD_POLICY | Assign a legal hold policy to a file, file version, folder, or user. | Read + write, Admin |
Assign retention policyBOX_ASSIGN_RETENTION_POLICY | Assigns a retention policy to an item in Box to enforce content retention. | Read + write, Admin |
Assign storage policyBOX_ASSIGN_STORAGE_POLICY | Creates a storage policy assignment for an enterprise or user. | Read + write, Admin |
Assign taskBOX_ASSIGN_TASK | Assigns a task to a user. A task can be assigned to more than one user by creating multiple assignments. | Read + write, Admin |
Authorize userBOX_AUTHORIZE_USER | Authorize a user by sending them through the Box website and request their permission to act on their behalf. | All levels |
Cancel box sign requestBOX_CANCEL_BOX_SIGN_REQUEST | Cancels a pending Box Sign request that has not yet been fully signed or declined. | Admin |
Commit upload sessionBOX_COMMIT_UPLOAD_SESSION | Commits an upload session and creates a file from the uploaded chunks. | Read + write, Admin |
Copy fileBOX_COPY_FILE | Creates a copy of a file. | Read + write, Admin |
Copy file requestBOX_COPY_FILE_REQUEST | Copies an existing file request to a new folder. | Read + write, Admin |
Copy folderBOX_COPY_FOLDER | Creates a copy of a folder within a destination folder. | Read + write, Admin |
Create ai agentBOX_CREATE_AI_AGENT | Creates a custom AI agent in Box AI Studio. | Read + write, Admin |
Create box sign requestBOX_CREATE_BOX_SIGN_REQUEST | Creates a Box Sign request to send documents for electronic signing. | Read + write, Admin |
Create box skill cards on fileBOX_CREATE_BOX_SKILL_CARDS_ON_FILE | Applies one or more Box Skills metadata cards to a file. | Read + write, Admin |
Create collaborationBOX_CREATE_COLLABORATION | Adds a collaboration for a single user or a single group to a file or folder. | Read + write, Admin |
Create collab exemptionBOX_CREATE_COLLAB_EXEMPTION | Exempts a specific user from the enterprise's collaboration domain restrictions. | Read + write, Admin |
Create commentBOX_CREATE_COMMENT | Adds a comment by the user to a specific file, or as a reply to an other comment. | Read + write, Admin |
Create email aliasBOX_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. | Read + write, Admin |
Create folderBOX_CREATE_FOLDER | Creates a new empty folder within the specified parent folder. | Read + write, Admin |
Create folder lockBOX_CREATE_FOLDER_LOCK | Creates a folder lock on a folder, preventing it from being moved and/or deleted. | Read + write, Admin |
Create groupBOX_CREATE_GROUP | Creates a new group of users in an enterprise. | Read + write, Admin |
Create legal hold policyBOX_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. IMPO… | Read + write, Admin |
Create metadata cascade policyBOX_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. | Read + write, Admin |
Create metadata instance on fileBOX_CREATE_METADATA_INSTANCE_ON_FILE | Applies an instance of a metadata template to a file. | Read + write, Admin |
Create metadata instance on folderBOX_CREATE_METADATA_INSTANCE_ON_FOLDER | Applies an instance of a metadata template to a folder. | Read + write, Admin |
Create metadata taxonomyBOX_CREATE_METADATA_TAXONOMY | Create a new metadata taxonomy in Box. Use when you need to set up a hierarchical classification system for organizing and categorizing metadata templates. | Read + write, Admin |
Create metadata taxonomy levelsBOX_CREATE_METADATA_TAXONOMY_LEVELS | Creates new hierarchical levels for a metadata taxonomy in Box. | Read + write, Admin |
Create metadata taxonomy nodeBOX_CREATE_METADATA_TAXONOMY_NODE | Create a new metadata taxonomy node within a specified taxonomy. | Read + write, Admin |
Create metadata templateBOX_CREATE_METADATA_TEMPLATE | Creates a new metadata template that can be applied to files and folders. | Read + write, Admin |
Create retention policyBOX_CREATE_RETENTION_POLICY | Creates a retention policy for managing content lifecycle in Box. | Read + write, Admin |
Create shield information barrierBOX_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. | Read + write, Admin |
Create shield information barrier reportBOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORT | Creates a shield information barrier report for a given barrier. | Read + write, Admin |
Create shield information barrier segmentBOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT | Creates a new shield information barrier segment for compliance and information isolation. | Read + write, Admin |
Create shield information barrier segment memberBOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER | Adds a Box user to a shield information barrier segment for compliance and information security. | Read + write, Admin |
Create shield information barrier segment restrictionBOX_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). | Read + write, Admin |
Create slack integration mappingBOX_CREATE_SLACK_INTEGRATION_MAPPING | Creates a Slack integration mapping by mapping a Slack channel to a Box item. | Read + write, Admin |
Create taskBOX_CREATE_TASK | Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately. | Read + write, Admin |
Create teams integration mappingBOX_CREATE_TEAMS_INTEGRATION_MAPPING | Creates a Microsoft Teams integration mapping that links a Teams channel or team to a Box folder. | Read + write, Admin |
Create terms of serviceBOX_CREATE_TERMS_OF_SERVICE | Creates a terms of service for a given enterprise and type of user. | Read + write, Admin |
Create terms of service status for new userBOX_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. | Read + write, Admin |
Create upload sessionBOX_CREATE_UPLOAD_SESSION | Creates an upload session for chunked upload of large files (20MB+). | Read + write, Admin |
Create upload session for existing fileBOX_CREATE_UPLOAD_SESSION_FOR_EXISTING_FILE | Creates an upload session for uploading a new version of an existing file using chunked upload. | Read + write, Admin |
Create userBOX_CREATE_USER | Creates a new managed user in an enterprise. | Read + write, Admin |
Create user inviteBOX_CREATE_USER_INVITE | Invites an existing external user to join an enterprise. | Read + write, Admin |
Create webhookBOX_CREATE_WEBHOOK | Creates a webhook to monitor a file or folder for specific events. | Read + write, Admin |
Create web linkBOX_CREATE_WEB_LINK | Creates a web link object within a folder. | Read + write, Admin |
Create zip downloadBOX_CREATE_ZIP_DOWNLOAD | Creates a request to download multiple files and folders as a single zip archive file. | Read + write, Admin |
Delete ai agentBOX_DELETE_AI_AGENT | Permanently deletes a custom AI agent from Box AI Studio. | Admin |
Delete allowed collaboration domainBOX_DELETE_ALLOWED_COLLABORATION_DOMAIN | Removes a domain from the list of allowed collaboration domains (whitelist) within your enterprise. | Admin |
Delete barrier restrictionBOX_DELETE_BARRIER_RESTRICTION | Deletes a shield information barrier segment restriction by its unique ID. | Admin |
Delete box skill cards from fileBOX_DELETE_BOX_SKILL_CARDS_FROM_FILE | Removes any Box Skills cards metadata from a file. | Admin |
Delete collaborationBOX_DELETE_COLLABORATION | Removes a collaboration from a file or folder, revoking the collaborator's access. | Admin |
Delete commentBOX_DELETE_COMMENT | Permanently deletes a comment from a file or folder in Box. | Admin |
Delete device pinBOX_DELETE_DEVICE_PIN | Deletes an individual device pin from the enterprise. | Admin |
Delete email aliasBOX_DELETE_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 cr… | Admin |
Delete fileBOX_DELETE_FILE | Deletes a file from Box by moving it to trash or permanently (based on enterprise settings). | Admin |
Delete file permanentlyBOX_DELETE_FILE_PERMANENTLY | Permanently deletes a file from the trash. | Admin |
Delete file requestBOX_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 reque… | Admin |
Delete file versionBOX_DELETE_FILE_VERSION | Move a file version to the trash. Versions are only tracked for Box users with premium accounts. | Admin |
Delete folderBOX_DELETE_FOLDER | Deletes a folder, either permanently or by moving it to the trash. | Admin |
Delete folder lockBOX_DELETE_FOLDER_LOCK | Deletes a folder lock on a given folder, removing restrictions on move and delete operations. | Admin |
Delete folder permanentlyBOX_DELETE_FOLDER_PERMANENTLY | Permanently deletes a folder that is in the trash. | Admin |
Delete groupBOX_DELETE_GROUP | Permanently deletes a group. Only users with admin-level permissions will be able to use this API. | Admin |
Delete legal hold policyBOX_DELETE_LEGAL_HOLD_POLICY | Permanently delete an existing legal hold policy from Box. | Admin |
Delete metadata cascade policyBOX_DELETE_METADATA_CASCADE_POLICY | Permanently deletes a metadata cascade policy from a folder. | Admin |
Delete metadata instance from fileBOX_DELETE_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… | Admin |
Delete metadata instance from folderBOX_DELETE_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 exist.… | Admin |
Delete metadata taxonomyBOX_DELETE_METADATA_TAXONOMY | Permanently deletes a metadata taxonomy from the enterprise. | Admin |
Delete metadata taxonomy nodeBOX_DELETE_METADATA_TAXONOMY_NODE | Permanently deletes a metadata taxonomy node from Box. | Admin |
Delete metadata templateBOX_DELETE_METADATA_TEMPLATE | Permanently delete a metadata template and all its instances from files and folders. | Admin |
Delete retention policyBOX_DELETE_RETENTION_POLICY | Permanently deletes a retention policy from the Box enterprise. | Admin |
Delete retention policy assignmentBOX_DELETE_RETENTION_POLICY_ASSIGNMENT | Removes a retention policy assignment from content in Box. | Admin |
Delete shared link from fileBOX_DELETE_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… | Read + write, Admin |
Delete shared link from folderBOX_DELETE_SHARED_LINK_FROM_FOLDER | Removes a shared link from a folder in Box. | Read + write, Admin |
Delete shared link from web linkBOX_DELETE_SHARED_LINK_FROM_WEB_LINK | Removes a shared link from a web link in Box. | Admin |
Delete shield information barrier segmentBOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT | Permanently deletes a shield information barrier segment by its ID. | Admin |
Delete shield information barrier segment member by idBOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_ID | Removes a user from a shield information barrier segment by deleting their membership. | Admin |
Delete slack integration mappingBOX_DELETE_SLACK_INTEGRATION_MAPPING | Deletes a Slack integration mapping that links a Box folder to a Slack channel. | Admin |
Delete storage policy assignmentBOX_DELETE_STORAGE_POLICY_ASSIGNMENT | Deletes a storage policy assignment, causing the assigned user to inherit the enterprise's default storage policy (Box Zone). | Admin |
Delete taskBOX_DELETE_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 r… | Admin |
Delete task assignmentBOX_DELETE_TASK_ASSIGNMENT | Deletes a specific task assignment, removing the task from the assigned user. | Admin |
Delete teams integration mappingBOX_DELETE_TEAMS_INTEGRATION_MAPPING | Deletes a Microsoft Teams integration mapping that links a Box folder to a Teams channel. | Admin |
Delete upload sessionBOX_DELETE_UPLOAD_SESSION | Abort and permanently remove a chunked upload session, discarding all uploaded data. | Admin |
Delete userBOX_DELETE_USER | Permanently deletes a user from the enterprise. | Admin |
Delete user avatarBOX_DELETE_USER_AVATAR | Deletes a user's custom avatar image from Box. | Admin |
Delete user domain exemptionBOX_DELETE_USER_DOMAIN_EXEMPTION | Removes a user's exemption from the enterprise's collaboration domain restrictions. | Admin |
Delete user from groupBOX_DELETE_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. | Admin |
Delete watermark from fileBOX_DELETE_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. Return… | Admin |
Delete watermark from folderBOX_DELETE_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, Co-… | Admin |
Delete webhookBOX_DELETE_WEBHOOK | Permanently deletes a webhook from the Box account. | Admin |
Delete web linkBOX_DELETE_WEB_LINK | Deletes a web link. | Admin |
Delete web link permanentlyBOX_DELETE_WEB_LINK_PERMANENTLY | Permanently deletes a web link that is in the trash. | Admin |
Download fileBOX_DOWNLOAD_FILE | Returns the contents of a file in binary format. | All levels |
Download zip archiveBOX_DOWNLOAD_ZIP_ARCHIVE | Downloads a zip archive containing files and/or folders from Box. | All levels |
Extract metadata freeformBOX_EXTRACT_METADATA_FREEFORM | Extract metadata from Box files using AI with freeform prompts. | All levels |
Extract metadata structuredBOX_EXTRACT_METADATA_STRUCTURED | Extract structured metadata from files using Box AI. | All levels |
Find app item for shared linkBOX_FIND_APP_ITEM_FOR_SHARED_LINK | Returns the file, folder, web link, or app item represented by a shared link. | All levels |
Find file for shared linkBOX_FIND_FILE_FOR_SHARED_LINK | Returns the file represented by a shared link. | All levels |
Find folder for shared linkBOX_FIND_FOLDER_FOR_SHARED_LINK | Return the folder represented by a shared link. | All levels |
Find metadata template by instance idBOX_FIND_METADATA_TEMPLATE_BY_INSTANCE_ID | Finds a metadata template by searching for the ID of an instance of the template. | All levels |
Force apply metadata cascade policy to folderBOX_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. | Read + write, Admin |
Generate textBOX_GENERATE_TEXT | Generate text using Box AI based on a prompt and file context. | All levels |
Get ai agentBOX_GET_AI_AGENT | Retrieves detailed information about a specific AI Agent by its unique identifier. | All levels |
Get ai agent default configurationBOX_GET_AI_AGENT_DEFAULT_CONFIGURATION | Retrieve the default AI agent configuration for a specific mode. | All levels |
Get allowed collaboration domainBOX_GET_ALLOWED_COLLABORATION_DOMAIN | Retrieves details of a specific allowed collaboration domain entry within your enterprise. | All levels |
Get box sign requestBOX_GET_BOX_SIGN_REQUEST | Retrieves the details of a specific Box Sign request by its unique ID. | All levels |
Get box sign templateBOX_GET_BOX_SIGN_TEMPLATE | Retrieves details of a specific Box Sign template by its unique ID. | All levels |
Get collaborationBOX_GET_COLLABORATION | Retrieves details of a single collaboration by its ID. | All levels |
Get collectionBOX_GET_COLLECTION | Retrieves details of a specific collection by its unique identifier. | All levels |
Get commentBOX_GET_COMMENT | Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment. | All levels |
Get current userBOX_GET_CURRENT_USER | Retrieves information about the user who is currently authenticated. | All levels |
Get device pinBOX_GET_DEVICE_PIN | Retrieves information about an individual device pin in the enterprise. | All levels |
Get events long poll endpointBOX_GET_EVENTS_LONG_POLL_ENDPOINT | Returns a list of real-time servers that can be used for long-polling user events. | All levels |
Get files under retentionBOX_GET_FILES_UNDER_RETENTION | Returns a paginated list of files under retention for a specific retention policy assignment. | All levels |
Get file informationBOX_GET_FILE_INFORMATION | Retrieves the details about a file. | All levels |
Get file requestBOX_GET_FILE_REQUEST | Retrieves detailed information about a file request in Box. | All levels |
Get file thumbnailBOX_GET_FILE_THUMBNAIL | Retrieves a thumbnail, or smaller image representation, of a file. | All levels |
Get file versionBOX_GET_FILE_VERSION | Retrieve detailed information about a specific version of a file. | All levels |
Get file versions under retentionBOX_GET_FILE_VERSIONS_UNDER_RETENTION | Returns a list of file versions under retention for a specified retention policy assignment. | All levels |
Get file version legal holdBOX_GET_FILE_VERSION_LEGAL_HOLD | Retrieves detailed information about a specific file version legal hold by its ID. | All levels |
Get folderBOX_GET_FOLDER | Retrieves details for a folder, including the first 100 entries in the folder. | All levels |
Get groupBOX_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. | All levels |
Get group membershipBOX_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. | All levels |
Get legal hold policyBOX_GET_LEGAL_HOLD_POLICY | Retrieve detailed information about a specific legal hold policy by its ID. | All levels |
Get legal hold policy assignmentBOX_GET_LEGAL_HOLD_POLICY_ASSIGNMENT | Retrieves detailed information about a specific legal hold policy assignment by its ID. | All levels |
Get metadata cascade policyBOX_GET_METADATA_CASCADE_POLICY | Retrieve a specific metadata cascade policy assigned to a folder. | All levels |
Get metadata instance on fileBOX_GET_METADATA_INSTANCE_ON_FILE | Retrieves a specific metadata template instance that has been applied to a file. | All levels |
Get metadata instance on folderBOX_GET_METADATA_INSTANCE_ON_FOLDER | Retrieves the instance of a metadata template that has been applied to a folder. | All levels |
Get metadata taxonomies for namespaceBOX_GET_METADATA_TAXONOMIES_FOR_NAMESPACE | Retrieves all metadata taxonomies within a specific namespace. | All levels |
Get metadata taxonomy by taxonomy keyBOX_GET_METADATA_TAXONOMY_BY_TAXONOMY_KEY | Retrieves a metadata taxonomy by its namespace and taxonomy key. | All levels |
Get metadata taxonomy node by idBOX_GET_METADATA_TAXONOMY_NODE_BY_ID | Retrieves a specific node from a metadata taxonomy by its identifier. | All levels |
Get metadata template by idBOX_GET_METADATA_TEMPLATE_BY_ID | Retrieves a metadata template by its ID. | All levels |
Get metadata template by nameBOX_GET_METADATA_TEMPLATE_BY_NAME | Retrieves a metadata template by its scope and templateKey values. | All levels |
Get retention on fileBOX_GET_RETENTION_ON_FILE | Returns information about a file version retention. | All levels |
Get retention policyBOX_GET_RETENTION_POLICY | Retrieves a retention policy by its unique ID. | All levels |
Get retention policy assignmentBOX_GET_RETENTION_POLICY_ASSIGNMENT | Retrieves a retention policy assignment by its unique ID. | All levels |
Get shared link for fileBOX_GET_SHARED_LINK_FOR_FILE | Retrieves the shared link information for a file. | All levels |
Get shared link for folderBOX_GET_SHARED_LINK_FOR_FOLDER | Retrieves shared link information for a folder. | All levels |
Get shared web linkBOX_GET_SHARED_WEB_LINK | Retrieve web link information for a shared link. | All levels |
Get shield information barrier by idBOX_GET_SHIELD_INFORMATION_BARRIER_BY_ID | Retrieves a shield information barrier by its unique ID. | All levels |
Get shield information barrier report by idBOX_GET_SHIELD_INFORMATION_BARRIER_REPORT_BY_ID | Retrieves a shield information barrier report by its ID. | All levels |
Get shield information barrier segment by idBOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_BY_ID | Retrieves a shield information barrier segment by its unique identifier. | All levels |
Get shield information barrier segment member by idBOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_ID | Retrieves a shield information barrier segment member by its unique ID. | All levels |
Get shield information barrier segment restriction by idBOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_ID | Retrieves a shield information barrier segment restriction by its unique ID. | All levels |
Get storage policyBOX_GET_STORAGE_POLICY | Fetches a specific storage policy by its ID. | All levels |
Get storage policy assignmentBOX_GET_STORAGE_POLICY_ASSIGNMENT | Retrieves information about a specific storage policy assignment. | All levels |
Get taskBOX_GET_TASK | Retrieves detailed information about a specific task in Box. | All levels |
Get task assignmentBOX_GET_TASK_ASSIGNMENT | Retrieves detailed information about a specific task assignment in Box. | All levels |
Get terms of serviceBOX_GET_TERMS_OF_SERVICE | Retrieves a specific terms of service by its unique identifier. | All levels |
Get trashed fileBOX_GET_TRASHED_FILE | Retrieves a file that has been moved to the trash. | All levels |
Get trashed folderBOX_GET_TRASHED_FOLDER | Retrieves a folder that has been moved to the trash. | All levels |
Get trashed web linkBOX_GET_TRASHED_WEB_LINK | Retrieves a web link that has been moved to the trash. | All levels |
Get upload sessionBOX_GET_UPLOAD_SESSION | Retrieves detailed information about an existing chunked upload session. | All levels |
Get userBOX_GET_USER | Retrieves information about a user in the enterprise. | All levels |
Get user avatarBOX_GET_USER_AVATAR | Retrieves the avatar image of a Box user. Returns a FileDownloadable object containing the avatar image. Returns 404 if the user has no avatar set. | All levels |
Get user exempt from collaboration domain restrictionsBOX_GET_USER_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONS | Retrieves details of a specific user exemption from collaboration domain restrictions. | All levels |
Get user invite statusBOX_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 c… | All levels |
Get watermark on fileBOX_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 retur… | All levels |
Get watermark on folderBOX_GET_WATERMARK_ON_FOLDER | Retrieve the watermark for a folder. | All levels |
Get webhookBOX_GET_WEBHOOK | Retrieves detailed information about a specific webhook by its ID. | All levels |
Get web linkBOX_GET_WEB_LINK | Retrieve detailed information about a web link (bookmark) in Box. | All levels |
Get zip download statusBOX_GET_ZIP_DOWNLOAD_STATUS | Get the download status of a zip archive, including progress, skipped items, and current state. | All levels |
List ai agentsBOX_LIST_AI_AGENTS | Lists AI agents based on the provided parameters. | All levels |
List allowed collaboration domainsBOX_LIST_ALLOWED_COLLABORATION_DOMAINS | Returns the list domains that have been deemed safe to create collaborations for within the current enterprise. | All levels |
List all classificationsBOX_LIST_ALL_CLASSIFICATIONS | Retrieves the classification metadata template and lists all the classifications available to this enterprise. | All levels |
List all collectionsBOX_LIST_ALL_COLLECTIONS | Retrieves all collections for a given user. | All levels |
List all file versionsBOX_LIST_ALL_FILE_VERSIONS | Retrieve a list of the past versions for a file. | All levels |
List all global metadata templatesBOX_LIST_ALL_GLOBAL_METADATA_TEMPLATES | Used to retrieve all generic, global metadata templates available to all enterprises using Box. | All levels |
List box sign requestsBOX_LIST_BOX_SIGN_REQUESTS | Gets signature requests created by a user. | All levels |
List box sign templatesBOX_LIST_BOX_SIGN_TEMPLATES | Gets Box Sign templates created by a user. | All levels |
List box skill cards on fileBOX_LIST_BOX_SKILL_CARDS_ON_FILE | List the Box Skills metadata cards that are attached to a file. | All levels |
List collection itemsBOX_LIST_COLLECTION_ITEMS | Retrieves the files and/or folders contained within a Box collection. | All levels |
List enterprise device pinsBOX_LIST_ENTERPRISE_DEVICE_PINS | Retrieves all the device pins within an enterprise. | All levels |
List enterprise groupsBOX_LIST_ENTERPRISE_GROUPS | Retrieves all of the groups for a given enterprise. | All levels |
List enterprise metadata templatesBOX_LIST_ENTERPRISE_METADATA_TEMPLATES | Used to retrieve all metadata templates created to be used specifically within the user's enterprise | All levels |
List enterprise usersBOX_LIST_ENTERPRISE_USERS | Returns a list of all users for the Enterprise along with their user_id, public_name, and login. | All levels |
List eventsBOX_LIST_EVENTS | Returns up to a year of past events for a given user or for the entire enterprise. | All levels |
List files on legal hold policy assignmentBOX_LIST_FILES_ON_LEGAL_HOLD_POLICY_ASSIGNMENT | Get a list of files with current file versions for a legal hold assignment. | All levels |
List file app item associationsBOX_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. | All levels |
List file collaborationsBOX_LIST_FILE_COLLABORATIONS | Retrieves a list of pending and active collaborations for a file. | All levels |
List file commentsBOX_LIST_FILE_COMMENTS | Retrieves a list of comments for a file. | All levels |
List file version legal holdsBOX_LIST_FILE_VERSION_LEGAL_HOLDS | Get a list of file versions on legal hold for a legal hold assignment. | All levels |
List file version retentionsBOX_LIST_FILE_VERSION_RETENTIONS | Retrieves all file version retentions for the given enterprise. | All levels |
List folder app item associationsBOX_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. | All levels |
List folder collaborationsBOX_LIST_FOLDER_COLLABORATIONS | Retrieves a list of pending and active collaborations for a folder. | All levels |
List folder locksBOX_LIST_FOLDER_LOCKS | Retrieves folder lock details for a given folder. | All levels |
List group collaborationsBOX_LIST_GROUP_COLLABORATIONS | Retrieves all the collaborations for a group. | All levels |
List group membersBOX_LIST_GROUP_MEMBERS | 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. | All levels |
List hold file versionsBOX_LIST_HOLD_FILE_VERSIONS | Retrieves a list of previous (non-current) file versions that are on legal hold for a specific legal hold policy assignment. | All levels |
List hubsBOX_LIST_HUBS | List all Box Hubs for the authenticated user or enterprise. | All levels |
List items in folderBOX_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 endpoint instead. | All levels |
List legal hold policiesBOX_LIST_LEGAL_HOLD_POLICIES | Retrieves a list of legal hold policies that belong to an enterprise. | All levels |
List legal hold policy assignmentsBOX_LIST_LEGAL_HOLD_POLICY_ASSIGNMENTS | Retrieves a list of items a legal hold policy has been assigned to. | All levels |
List metadata cascade policiesBOX_LIST_METADATA_CASCADE_POLICIES | Retrieves a list of all the metadata cascade policies that are applied to a given folder. | All levels |
List metadata instances on fileBOX_LIST_METADATA_INSTANCES_ON_FILE | Retrieves all metadata instances applied to a file. | All levels |
List metadata instances on folderBOX_LIST_METADATA_INSTANCES_ON_FOLDER | Retrieves all metadata for a given folder. | All levels |
List metadata taxonomy nodesBOX_LIST_METADATA_TAXONOMY_NODES | Retrieves metadata taxonomy nodes based on the specified parameters. | All levels |
List pending collaborationsBOX_LIST_PENDING_COLLABORATIONS | Retrieves all pending collaboration invites for this user. | All levels |
List recently accessed itemsBOX_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. | All levels |
List retention policiesBOX_LIST_RETENTION_POLICIES | Retrieves all of the retention policies for an enterprise. | All levels |
List retention policy assignmentsBOX_LIST_RETENTION_POLICY_ASSIGNMENTS | Retrieves all retention policy assignments for a specified retention policy. | All levels |
List shield information barriersBOX_LIST_SHIELD_INFORMATION_BARRIERS | Retrieves a list of shield information barrier objects for the enterprise of JWT. | All levels |
List shield information barrier reportsBOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTS | Lists shield information barrier reports for a specified barrier. | All levels |
List shield information barrier segmentsBOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENTS | Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID. | All levels |
List shield information barrier segment membersBOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERS | Lists shield information barrier segment members based on provided segment IDs. | All levels |
List shield information barrier segment restrictionsBOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONS | Lists all shield information barrier segment restrictions for a specific segment. | All levels |
List slack integration mappingsBOX_LIST_SLACK_INTEGRATION_MAPPINGS | Lists Slack integration mappings in a users' enterprise. | All levels |
List storage policiesBOX_LIST_STORAGE_POLICIES | Fetches all the storage policies in the enterprise. | All levels |
List storage policy assignmentsBOX_LIST_STORAGE_POLICY_ASSIGNMENTS | Fetches all the storage policy assignment for an enterprise or user. | All levels |
List tasks on fileBOX_LIST_TASKS_ON_FILE | Retrieves a list of all the tasks for a file. | All levels |
List task assignmentsBOX_LIST_TASK_ASSIGNMENTS | Lists all of the assignments for a given task. | All levels |
List teams integration mappingsBOX_LIST_TEAMS_INTEGRATION_MAPPINGS | Lists Teams integration mappings in a users' enterprise. | All levels |
List terms of servicesBOX_LIST_TERMS_OF_SERVICES | Returns the current terms of service text and settings for the enterprise. | All levels |
List terms of service user statusesBOX_LIST_TERMS_OF_SERVICE_USER_STATUSES | Retrieves a list of users and their acceptance status for a specific terms of service. | All levels |
List trashed itemsBOX_LIST_TRASHED_ITEMS | Retrieves the files and folders that have been moved to the trash. | All levels |
List upload session partsBOX_LIST_UPLOAD_SESSION_PARTS | List the parts (chunks) that have been uploaded to a chunked upload session. | All levels |
List users exempt from collaboration domain restrictionsBOX_LIST_USERS_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONS | Returns a list of users who have been exempt from the collaboration domain restrictions. | All levels |
List user email aliasesBOX_LIST_USER_EMAIL_ALIASES | Retrieves all email aliases for a user. The collection does not include the primary login for the user. | All levels |
List user groupsBOX_LIST_USER_GROUPS | Retrieves all group memberships for a user, including the groups they belong to and their role in each group (member or admin). | All levels |
List webhooksBOX_LIST_WEBHOOKS | Returns all defined webhooks for the requesting application. | All levels |
List workflowsBOX_LIST_WORKFLOWS | Lists Box Relay workflows configured for a specific folder. | All levels |
Preflight check before uploadBOX_PREFLIGHT_CHECK_BEFORE_UPLOAD | Performs a preflight check to verify that a file will be accepted by Box before uploading the entire file. | All levels |
Promote file versionBOX_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 at… | Read + write, Admin |
Query files folders by metadataBOX_QUERY_FILES_FOLDERS_BY_METADATA | Query files and folders by metadata using SQL-like syntax. | All levels |
Refresh access tokenBOX_REFRESH_ACCESS_TOKEN | Refresh an Access Token using its client ID, secret, and refresh token. | Read + write, Admin |
Request access tokenBOX_REQUEST_ACCESS_TOKEN | Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion. | Read + write, Admin |
Resend box sign requestBOX_RESEND_BOX_SIGN_REQUEST | Resends signature request emails to all outstanding signers. | Read + write, Admin |
Restore fileBOX_RESTORE_FILE | Restores a file that has been moved to the trash. | Read + write, Admin |
Restore file versionBOX_RESTORE_FILE_VERSION | Restores a specific version of a file after it was deleted (trashed). | Read + write, Admin |
Restore folderBOX_RESTORE_FOLDER | Restores a folder that has been moved to the trash. | Read + write, Admin |
Restore web linkBOX_RESTORE_WEB_LINK | Restores a web link that has been moved to the trash. | Read + write, Admin |
Revoke access tokenBOX_REVOKE_ACCESS_TOKEN | Revoke an active Access Token, effectively logging a user out that has been previously authenticated. | Admin |
Search for contentBOX_SEARCH_FOR_CONTENT | Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. | All levels |
Start workflowBOX_START_WORKFLOW | Starts a Box Relay workflow with trigger type WORKFLOW_MANUAL_START. | Read + write, Admin |
Terminate user group sessionsBOX_TERMINATE_USER_GROUP_SESSIONS | Terminates all active sessions for users belonging to the specified Box enterprise groups. | Admin |
Terminate user sessionsBOX_TERMINATE_USER_SESSIONS | Creates asynchronous jobs to terminate active Box sessions for specified users. | Admin |
Transfer owned foldersBOX_TRANSFER_OWNED_FOLDERS | Transfers all files and folders owned by one user to another user's account in Box. | Admin |
Trim metadata taxonomy levelsBOX_TRIM_METADATA_TAXONOMY_LEVELS | Deletes the last level from a metadata taxonomy by trimming it. | Admin |
Unassign legal hold policyBOX_UNASSIGN_LEGAL_HOLD_POLICY | Remove a legal hold policy assignment from an item (user, folder, file, or file version). | Admin |
Update ai agentBOX_UPDATE_AI_AGENT | Updates an existing custom AI agent in Box AI Studio. | Read + write, Admin |
Update all box skill cards on fileBOX_UPDATE_ALL_BOX_SKILL_CARDS_ON_FILE | An alternative method to overwrite and update all Box Skill metadata cards on a file. | Read + write, Admin |
Update barrier segmentBOX_UPDATE_BARRIER_SEGMENT | Updates a shield information barrier segment's name and/or description. | Read + write, Admin |
Update box skill cards on fileBOX_UPDATE_BOX_SKILL_CARDS_ON_FILE | Updates one or more Box Skills metadata cards on a file using JSON-Patch format. | Read + write, Admin |
Update collaborationBOX_UPDATE_COLLABORATION | Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. | Read + write, Admin |
Update commentBOX_UPDATE_COMMENT | Update the message of a comment. | Read + write, Admin |
Update fileBOX_UPDATE_FILE | Updates a file. This can be used to rename or move a file, create a shared link, or lock a file. | Read + write, Admin |
Update file requestBOX_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, a… | Read + write, Admin |
Update folderBOX_UPDATE_FOLDER | Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more. | Read + write, Admin |
Update groupBOX_UPDATE_GROUP | Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API. | Read + write, Admin |
Update group membershipBOX_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. | Read + write, Admin |
Update legal hold policyBOX_UPDATE_LEGAL_HOLD_POLICY | Update an existing legal hold policy in Box. | Read + write, Admin |
Update metadata instance on fileBOX_UPDATE_METADATA_INSTANCE_ON_FILE | Updates a metadata instance on a file using JSON-Patch operations. | Read + write, Admin |
Update metadata instance on folderBOX_UPDATE_METADATA_INSTANCE_ON_FOLDER | Updates metadata on a folder using JSON-Patch operations (RFC 6902). | Read + write, Admin |
Update metadata taxonomyBOX_UPDATE_METADATA_TAXONOMY | Update an existing metadata taxonomy's display name. | Read + write, Admin |
Update metadata taxonomy nodeBOX_UPDATE_METADATA_TAXONOMY_NODE | Update an existing metadata taxonomy node's display name. | Read + write, Admin |
Update metadata templateBOX_UPDATE_METADATA_TEMPLATE | Updates a metadata template by applying JSON-Patch operations. | Read + write, Admin |
Update retention policyBOX_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… | Read + write, Admin |
Update shared link on fileBOX_UPDATE_SHARED_LINK_ON_FILE | Updates a shared link on a file. | Read + write, Admin |
Update shared link on folderBOX_UPDATE_SHARED_LINK_ON_FOLDER | Updates a shared link on a folder. | Read + write, Admin |
Update shared link on web linkBOX_UPDATE_SHARED_LINK_ON_WEB_LINK | Updates a shared link on a web link. | Read + write, Admin |
Update shield information barrier statusBOX_UPDATE_SHIELD_INFORMATION_BARRIER_STATUS | Change the status of a shield information barrier. | Admin |
Update slack integration mappingBOX_UPDATE_SLACK_INTEGRATION_MAPPING | Updates an existing Slack integration mapping. | Read + write, Admin |
Update storage policy assignmentBOX_UPDATE_STORAGE_POLICY_ASSIGNMENT | Updates a storage policy assignment for an enterprise or user. | Read + write, Admin |
Update taskBOX_UPDATE_TASK | Updates a task. This can be used to update a task's configuration, or to update its completion state. | Read + write, Admin |
Update task assignmentBOX_UPDATE_TASK_ASSIGNMENT | Updates a task assignment to change its resolution state or add a message. | Read + write, Admin |
Update teams integration mappingBOX_UPDATE_TEAMS_INTEGRATION_MAPPING | Updates a Microsoft Teams integration mapping that links a Box folder to a Teams channel. | Read + write, Admin |
Update terms of serviceBOX_UPDATE_TERMS_OF_SERVICE | Updates an existing terms of service for the enterprise. | Read + write, Admin |
Update terms of service status for existing userBOX_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. | Read + write, Admin |
Update userBOX_UPDATE_USER | Updates a managed or app user in an enterprise. | Read + write, Admin |
Update webhookBOX_UPDATE_WEBHOOK | Updates an existing webhook's configuration. | Read + write, Admin |
Update web linkBOX_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 - Configuring… | Read + write, Admin |
Upload fileBOX_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… | Read + write, Admin |
Upload file versionBOX_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… | Read + write, Admin |
Upload part of fileBOX_UPLOAD_PART_OF_FILE | Uploads a chunk of a file for an upload session. | Read + write, Admin |
Just ask in plain language: “check Box for …”, “create … in Box”, “every Monday, … ”, and the agent finds the right tool, runs it, and reports back with a receipt in your Runs ledger. Anything outward-facing (sending, posting, publishing) that a mission didn't clearly authorize comes back to you as a ticket first.
| Agent says | What's happening | Fix |
|---|---|---|
| "Box isn't connected" | No active connection (or this agent is denied) | Connect on the Integrations page; check the agent's per-app policy |
| "The connection has expired" | Box ended the authorization (they all do periodically) | Click Reconnect on the account, same settings, one click |
| "I'm not allowed to do that" | The action is above the account's access level, or the agent is scoped down | Raise the level under Manage, or adjust that agent's policy |
| It did something unexpected | The ask was ambiguous (e.g. matched an existing item) | Be explicit, "create a NEW …", and give agents a working folder where relevant |