Box for AI agents
Agents read Box at once. Changes and sends are held for a person's approval by default.
About Box
Box is a cloud content management platform for secure file storage, sharing, collaboration, and governance.
What an agent can do in Box
Every Box action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Box without asking first. 127 actions.
- Find file for shared linkReturns 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 applicati
- Get file informationRetrieves the details about a file.
- Get folder informationRetrieves 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
- List file commentsRetrieves a list of comments for a file.
- List items in folderRetrieves 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) end
- Search for contentSearches for files, folders, web links, and shared files across the users content or across the entire enterprise.
- Ask questionAsk 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 informa
- Authorize userAuthorize 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 r
- Extract metadata freeformExtract 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 conte
- Extract metadata structuredExtract 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 extr
- Find item for shared linkReturns 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
- Find folder for shared linkReturn 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 applic
Show all 127
- Find metadata template by instance idFinds 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 fold
- Generate textGenerate 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
- Get AI Agent by IDRetrieves 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 u
- Get ai agent default configurationRetrieve 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 pa
- Get allowed collaboration domainRetrieves 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 d
- Get box sign request by idRetrieves 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',
- Get Box Sign Template by IDRetrieves 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 se
- Get collaborationRetrieves 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,
- Get collection by idRetrieves 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 c
- Get commentRetrieves the message and metadata for a specific comment, as well as information on the user who created the comment.
- Get current userRetrieves 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
- Get device pinRetrieves 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
- Get Real-Time Server URL for Long-Polling EventsReturns 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. A
- Get file requestRetrieves 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 th
- Get files under retentionReturns 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
- Get file versionRetrieve 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
- Get file version legal holdRetrieves 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 act
- Get file versions under retentionReturns 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
- Get groupRetrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.
- Get group membershipRetrieves 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 policyRetrieve 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 acti
- Get legal hold policy assignmentRetrieves 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,
- Get metadata cascade policyRetrieve a specific metadata cascade policy assigned to a folder.
- Get metadata instance on fileRetrieves 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_O
- Get metadata instance on folderRetrieves 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 namespaceRetrieves 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 keyRetrieves 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 IDRetrieves 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 idRetrieves a metadata template by its ID.
- Get metadata template by nameRetrieves 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 app
- Get retention policyRetrieves 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 fe
- Get retention policy assignmentRetrieves 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).
- Get shared link for fileRetrieves 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 ha
- Get shared link for folderRetrieves 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 fo
- Get shared items web linksTool 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 shield information barrier with specified idRetrieves 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 passin
- Get shield information barrier report by idRetrieves 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 enterpris
- Get shield information barrier segment with specified idRetrieves 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 u
- Get shield information barrier segment member by idRetrieves 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 Res
- Get shield information barrier segment restriction by idRetrieves 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. Th
- Get storage policyFetches 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
- Get storage policy assignmentRetrieves 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 ent
- Get taskRetrieves 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' (
- Get task assignmentRetrieves 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: - Th
- Get terms of serviceRetrieves 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 c
- Get trashed fileRetrieves 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
- Get trashed folderRetrieves 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
- Get trashed web linkRetrieves 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 wi
- Get upload sessionRetrieves 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 - Numbe
- Get userRetrieves 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 lim
- Get user exempt from collaboration domain restrictionsRetrieves 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 collaborat
- Get user invite statusReturns 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
- Get watermark on fileRetrieve 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 F
- Get watermark for folderRetrieve the watermark for a folder.
- Get webhookRetrieves 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 noti
- Get web linkRetrieve 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 times
- Get zip download statusGet 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 down
- List ai agentsLists AI agents based on the provided parameters.
- List all classificationsRetrieves 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 exa
- List all collectionsRetrieves all collections for a given user. Currently, only the `favorites` collection is supported.
- List all file versionsRetrieve 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 templatesUsed to retrieve all generic, global metadata templates available to all enterprises using Box.
- List allowed collaboration domainsReturns the list domains that have been deemed safe to create collaborations for within the current enterprise.
- List box sign requestsGets 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 templatesGets Box Sign templates created by a user.
- List box skill cards on fileList the Box Skills metadata cards that are attached to a file.
- List collection itemsRetrieves 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 t
- List enterprise device pinsRetrieves 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 groups for enterpriseRetrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.
- List all metadata templates for enterpriseUsed to retrieve all metadata templates created to be used specifically within the user's enterprise
- List enterprise usersReturns 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 en
- List user and enterprise eventsReturns 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 `str
- 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. Assumi
- List file collaborationsRetrieves 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.
- Review files on legal hold policy assignmentGet 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 /legal_hold_policy_assignment
- List file version legal holdsGet 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 onl
- 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. As
- List folder collaborationsRetrieves 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 locksRetrieves 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 collaborationsRetrieves 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
- List members of groupRetrieves 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 previous file versions for legal hold policy assignmentRetrieves 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. Fo
- List Box HubsTool to list all Box Hubs for the authenticated user or enterprise. Use when you need to retrieve, search, or filter Box Hubs.
- List all legal hold policiesRetrieves a list of legal hold policies that belong to an enterprise.
- List legal hold policy assignmentsRetrieves a list of items a legal hold policy has been assigned to.
- List metadata cascade policiesRetrieves 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 fileRetrieves 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 n
- List metadata instances on folderRetrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.
- List metadata taxonomy nodesRetrieves 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 unles
- List pending collaborationsRetrieves all pending collaboration invites for this user.
- List recently accessed itemsReturns 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 policiesRetrieves all of the retention policies for an enterprise.
- List retention policy assignmentsRetrieves 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 specif
- List shield information barrier reportsLists 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 en
- List shield information barriersRetrieves a list of shield information barrier objects for the enterprise of JWT.
- List shield information barrier segment membersLists shield information barrier segment members based on provided segment IDs.
- List shield information barrier segment restrictionsLists 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
- List shield information barrier segmentsRetrieves 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
- List slack integration mappingsLists [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 endpo
- List storage policiesFetches all the storage policies in the enterprise.
- List storage policy assignmentsFetches all the storage policy assignment for an enterprise or user.
- List task assignmentsLists 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
- List tasks on fileRetrieves a list of all the tasks for a file. This endpoint does not support pagination.
- List teams integration mappingsLists [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 servicesReturns the current terms of service text and settings for the enterprise.
- List terms of service user statusesRetrieves 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) -
- List trashed itemsRetrieves 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
- List upload session partsList 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 p
- List user's email aliasesRetrieves all email aliases for a user. The collection does not include the primary login for the user.
- List user's groupsRetrieves 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
- List users exempt from collaboration domain restrictionsReturns 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 Forbid
- List all webhooksReturns 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
- List workflowsLists 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 start
- Preflight check before uploadPerforms 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 uploa
- Query files folders by metadataQuery 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 fi
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 149 actions.
- Create Box Sign RequestCreates 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
- Create collaborationAdds 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 gr
- Create commentAdds a comment by the user to a specific file, or as a reply to an other comment.
- Create folderCreates a new empty folder within the specified parent folder.
- Delete fileDeletes 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 t
- Request access tokenRequest 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 t
- Update fileUpdates a file. This can be used to rename or move a file, create a shared link, or lock a file.
- Update folderUpdates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.
- Add domain to list of allowed collaboration domainsCreates 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
- Add classification to fileAdds 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 configure
- Add classification to folderAdds 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 configu
- Add initial classificationsInitializes 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
Show all 149
- Add shared link to fileAdds a shared link to a file.
- Add shared link to folderAdds 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
- Add shared link to web linkAdds a shared link to a web link.
- Add user to groupCreates a group membership. Only users with admin-level permissions will be able to use this API.
- Append metadata taxonomy levelAppends 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 fileApplies or update a watermark on a file.
- Apply watermark to folderApplies or update a watermark on a folder.
- Assign legal hold policyAssign 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 assi
- Assign retention policyAssigns 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 specif
- Assign storage policyCreates 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 featu
- Assign taskAssigns a task to a user. A task can be assigned to more than one user by creating multiple assignments.
- Cancel box sign requestCancels 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 th
- Commit upload sessionCommits 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 par
- Copy fileCreates a copy of a file.
- Copy file requestCopies 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 r
- Copy folderCreates a copy of a folder within a destination folder. The original folder will not be changed.
- Create AI AgentCreates 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,
- Create box skill cards on fileApplies 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 Conflic
- Create user exemption from collaboration domain restrictionsExempts 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
- Create email aliasAdds 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 lockCreates 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 groupCreates a new group of users in an enterprise. Only users with admin permissions can create new groups.
- Create legal hold policyCreate 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, fold
- Create metadata cascade policyCreates 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
- Create metadata instance on fileApplies 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
- Create metadata instance on folderApplies 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
- Create metadata taxonomyTool 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 levelsCreates 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
- Create metadata taxonomy nodeTool 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 templateCreates a new metadata template that can be applied to files and folders.
- Create retention policyCreates 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 o
- Create shield information barrierCreates 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-
- Create shield information barrier reportCreates 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 wi
- Create shield information barrier segmentCreates 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 iso
- Create shield information barrier segment memberAdds 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 Bankin
- Create shield information barrier segment restrictionCreates a ONE-WAY shield information barrier segment restriction preventing collaboration between members of two segments (e.g., Investment Banking cannot collaborate with Research). Prerequisites: -
- Create slack integration mappingCreates 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 r
- Create taskCreates a single task on a file. This task is not assigned to any user and will need to be assigned separately.
- Create Teams integration mappingCreates 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. Requ
- Create terms of serviceCreates 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 a
- Create terms of service status for new userCreates 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
- Create upload sessionCreates 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 uplo
- Create upload session for existing fileCreates 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
- Create userCreates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.
- Create user inviteInvites 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 a
- Create webhookCreates 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
- Create web linkCreates a web link object within a folder.
- Create zip downloadCreates 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
- Delete AI AgentPermanently 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 operatio
- Remove domain from list of allowed collaboration domainsRemoves 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
- Delete shield information barrier segment restriction by idDeletes 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
- Remove box skill cards from fileRemoves any Box Skills cards metadata from a file.
- Remove collaborationRemoves 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 collaborat
- Remove commentPermanently 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
- Remove device pinDeletes 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 u
- Remove email aliasRemoves 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
- Permanently remove filePermanently 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,
- Delete file requestDeletes 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 LIM
- Remove file versionMove a file version to the trash. Versions are only tracked for Box users with premium accounts.
- Delete folderDeletes a folder, either permanently or by moving it to the trash.
- Delete folder lockDeletes 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
- Permanently remove folderPermanently deletes a folder that is in the trash. This action cannot be undone.
- Remove groupPermanently deletes a group. Only users with admin-level permissions will be able to use this API.
- Remove legal hold policyPermanently 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) indic
- Remove metadata cascade policyPermanently 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
- Remove metadata instance from fileRemoves 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 in
- Remove metadata instance from folderRemove 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 inst
- Remove metadata taxonomyPermanently 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 fo
- Remove metadata taxonomy nodePermanently 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 t
- Remove metadata templatePermanently 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 permane
- Delete retention policyPermanently 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
- Remove retention policy assignmentRemoves 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
- Remove shared link from fileRemoves 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 - on
- Remove shared link from folderRemoves 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 delete
- Remove shared link from web linkRemoves 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
- Delete shield information barrier segmentPermanently 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 organiza
- Delete shield information barrier segment member by idRemoves 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 collaborat
- Delete Slack integration mappingDeletes 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 int
- Unassign storage policyDeletes 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
- Remove taskPermanently 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 remo
- Unassign taskDeletes 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 reassig
- Delete teams integration mappingDeletes 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 t
- Remove upload sessionAbort 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
- Delete userPermanently 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 byp
- Delete user avatarDeletes 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 d
- Remove User Domain ExemptionRemoves 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 c
- Remove user from groupDeletes 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 fileRemoves 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
- Remove watermark from folderRemoves 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 us
- Remove webhookPermanently 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 notifi
- Remove web linkDeletes a web link.
- Permanently remove web linkPermanently deletes a web link that is in the trash. This action cannot be undone.
- Force apply metadata cascade policy to folderForces 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 Ac
- Promote file versionPromote 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 ver
- Refresh access tokenRefresh 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). Eac
- Resend Box Sign RequestResends 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 asy
- Restore fileRestores 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 versionRestores 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 us
- Restore folderRestores 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
- Restore web linkRestores 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
- Revoke access tokenRevoke an active Access Token, effectively logging a user out that has been previously authenticated.
- Starts workflow based on request bodyStarts 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 Wo
- Create jobs to terminate user group sessionTerminates 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 t
- Create jobs to terminate users sessionCreates 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.
- Transfer owned foldersTransfers 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 ope
- Trim metadata taxonomy levelsDeletes 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 policyRemove 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 return
- Update AI AgentUpdates 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
- Update all box skill cards on fileAn 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-assig
- Update shield information barrier segment with specified idUpdates a shield information barrier segment's name and/or description. Shield Information Barrier segments represent organizational divisions (e.g., 'Investment Banking', 'Research', 'Trading') that
- Update box skill cards on fileUpdates 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
- Update collaborationUpdates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites.
- Update commentUpdate the message of a comment.
- Update file requestUpdates 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, des
- Update groupUpdates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.
- Update group membershipUpdates 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 policyUpdate 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 conten
- Update metadata instance on fileUpdates 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 ac
- Update metadata instance on folderUpdates 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.p
- Update metadata taxonomyTool 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 nodeTool 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 templateUpdates 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 metadat
- Update retention policyUpdates 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
- Update shared link on fileUpdates a shared link on a file.
- Update shared link on folderUpdates a shared link on a folder.
- Update shared link on web linkUpdates a shared link on a web link.
- Change shield information barrier statusChange 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
- Update slack integration mappingUpdates 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 ch
- Update storage policy assignmentUpdates 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
- Update taskUpdates a task. This can be used to update a task's configuration, or to update its completion state.
- Update task assignmentUpdates 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
- Update teams integration mappingUpdates 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 B
- Update terms of serviceUpdates 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 pr
- Update terms of service status for existing userUpdates 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
- Update userUpdates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.
- Update webhookUpdates 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 up
- Update web linkUpdates 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 f
Changes wait in Needs you
Changes and sends in Box are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Box questions
Can an agent change data in Box on its own?
Not by default. Changes and sends in Box are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Box?
This connector lists 127 read actions. Reads run at once, without waiting for approval.
How does Box connect?
It connects with OAuth 2.0. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.