> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Box > Box is a cloud content management platform for secure file storage, sharing, collaboration, and governance Box is a cloud content management platform for secure file storage, sharing, collaboration, and governance. `box` · **286 tools** · **20 triggers** ## Connect it ```bash theme={"theme":"github-dark"} run auth box run auth box --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run box # common commands run box --all # every command ``` ```ts theme={"theme":"github-dark"} import { box } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `create-sign-request` | Creates a Box Sign request to send documents for electronic signing. | | `create-collaboration` | Adds a collaboration for a single user or a single group to a file or folder. | | `create-comment` | Adds a comment by the user to a specific file, or as a reply to an other comment. | | `create-folder` | Creates a new empty folder within the specified parent folder. | | `delete-file` | Deletes a file from Box by moving it to trash or permanently (based on enterprise settings). | | `download-file` | Returns the contents of a file in binary format. | | `find-file-for-shared-link` | Returns the file represented by a shared link. A shared file can be represented by a shared link, which can originate within the current enterprise or within another. | | `get-file-information` | Retrieves the details about a file. | | `get-folder` | Retrieves details for a folder, including the first 100 entries in the folder. | | `list-file-comments` | Retrieves a list of comments for a file. | | `list-items-in-folder` | Retrieves a page of items in a folder. These items can be files, folders, and web links. | | `request-access-token` | Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion. | | `search-for-content` | Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. | | `update-file` | Updates a file. This can be used to rename or move a file, create a shared link, or lock a file. | | `update-folder` | Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more. | | Tool | What it does | | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-allowed-collaboration-domain` | Creates a new entry in the list of allowed domains for collaboration within your enterprise. | | `add-classification-to-file` | Adds a classification to a file by specifying the label of the classification to add. **Enterprise-only feature**: This action requires a Box... | | `add-classification-to-folder` | Adds a classification to a folder by specifying the label of the classification to add. **Enterprise-only feature**: This action requires a Box... | | `add-initial-classifications` | Initializes the classification template for an enterprise with an initial set of classification options. | | `add-or-update-user-avatar` | Adds or updates a user avatar. | | `add-shared-link-to-file` | Adds a shared link to a file. | | `add-shared-link-to-folder` | Adds a shared link to a folder, allowing it to be shared with others via a URL. | | `add-shared-link-to-web-link` | Adds a shared link to a web link. | | `add-user-to-group` | Creates a group membership. Only users with admin-level permissions will be able to use this API. | | `append-metadata-taxonomy-level` | Appends a new level to a metadata taxonomy structure. Use when adding hierarchical categories to organize metadata. | | `apply-watermark-to-file` | Applies or update a watermark on a file. | | `apply-watermark-to-folder` | Applies or update a watermark on a folder. | | `ask-question` | Ask questions about Box files using Box AI. Use this action to query one or more files with natural language questions. | | `assign-legal-hold-policy` | Assign a legal hold policy to a file, file version, folder, or user. | | `assign-retention-policy` | Assigns a retention policy to an item in Box to enforce content retention. | | `assign-storage-policy` | Creates a storage policy assignment for an enterprise or user. | | `assign-task` | Assigns a task to a user. A task can be assigned to more than one user by creating multiple assignments. | | `authorize-user` | Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf. | | `cancel-sign-request` | Cancels a pending Box Sign request that has not yet been fully signed or declined. | | `commit-upload-session` | Commits an upload session and creates a file from the uploaded chunks. | | `copy-file` | Creates a copy of a file. | | `copy-file-request` | Copies an existing file request to a new folder. File requests allow external users to upload files to a specific folder without needing a Box account. | | `copy-folder` | Creates a copy of a folder within a destination folder. The original folder will not be changed. | | `create-ai-agent` | Creates a custom AI agent in Box AI Studio. At least one capability required: ask (Q\&A), text\_gen (content generation), or extract (metadata extraction). | | `create-sign-request` | Creates a Box Sign request to send documents for electronic signing. | | `create-skill-cards-on-file` | Applies one or more Box Skills metadata cards to a file. NOTE: This action creates NEW Box Skill cards on a file. | | `create-collab-exemption` | Exempts a specific user from the enterprise's collaboration domain restrictions. | | `create-collaboration` | Adds a collaboration for a single user or a single group to a file or folder. | | `create-comment` | Adds a comment by the user to a specific file, or as a reply to an other comment. | | `create-email-alias` | Adds a new email alias to a user account. The email domain must be registered to your enterprise. | | `create-folder` | Creates a new empty folder within the specified parent folder. | | `create-folder-lock` | Creates a folder lock on a folder, preventing it from being moved and/or deleted. | | `create-group` | Creates a new group of users in an enterprise. Only users with admin permissions can create new groups. | | `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. | | `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. | | `create-metadata-instance-on-file` | Applies an instance of a metadata template to a file. The metadata\_fields parameter contains key-value pairs that match the fields defined in the template. | | `create-metadata-instance-on-folder` | Applies an instance of a metadata template to a folder. In most cases only values that are present in the metadata template will be accepted, except... | | `create-metadata-taxonomy` | Tool to create a new metadata taxonomy in Box. Use when you need to set up a hierarchical classification system for organizing and categorizing metadata templates. | | `create-metadata-taxonomy-levels` | Creates new hierarchical levels for a metadata taxonomy in Box. | | `create-metadata-taxonomy-node` | Tool to create a new metadata taxonomy node within a specified taxonomy. | | `create-metadata-template` | Creates a new metadata template that can be applied to files and folders. | | `create-retention-policy` | Creates a retention policy for managing content lifecycle in Box. | | `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. | | `create-shield-information-barrier-report` | Creates a shield information barrier report for a given barrier. | | `create-shield-information-barrier-segment` | Creates a new shield information barrier segment for compliance and information isolation. | | `create-shield-information-barrier-segment-member` | Adds a Box user to a shield information barrier segment for compliance and information security. | | `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... | | `create-slack-integration-mapping` | Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack... | | `create-task` | Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately. | | `create-teams-integration-mapping` | Creates a Microsoft Teams integration mapping that links a Teams channel or team to a Box folder. | | `create-terms-of-service` | Creates a terms of service for a given enterprise and type of user. | | `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. | | `create-upload-session` | Creates an upload session for chunked upload of large files (20MB+). | | `create-upload-session-for-existing-file` | Creates an upload session for uploading a new version of an existing file using chunked upload. | | `create-user` | Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions. | | `create-user-invite` | Invites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. | | `create-webhook` | Creates a webhook to monitor a file or folder for specific events. | | `create-web-link` | Creates a web link object within a folder. | | `create-zip-download` | Creates a request to download multiple files and folders as a single `zip` archive file. | | `delete-ai-agent` | Permanently deletes a custom AI agent from Box AI Studio. This action removes the specified AI agent and all its configuration, including any custom... | | `delete-allowed-collaboration-domain` | Removes a domain from the list of allowed collaboration domains (whitelist) within your enterprise. | | `delete-barrier-restriction` | Deletes a shield information barrier segment restriction by its unique ID. | | `delete-skill-cards-from-file` | Removes any Box Skills cards metadata from a file. | | `delete-collaboration` | Removes a collaboration from a file or folder, revoking the collaborator's access. | | `delete-comment` | Permanently deletes a comment from a file or folder in Box. This action removes a comment that was previously added to a Box item. | | `delete-device-pin` | Deletes an individual device pin from the enterprise. Device pins are created when users access Box from mobile or desktop devices that support device pinning. | | `delete-email-alias` | Removes an email alias from a user. This endpoint permanently deletes an email alias associated with a user account. | | `delete-file` | Deletes a file from Box by moving it to trash or permanently (based on enterprise settings). | | `delete-file-permanently` | Permanently deletes a file from the trash. This action is irreversible and cannot be undone. | | `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. | | `delete-file-version` | Move a file version to the trash. Versions are only tracked for Box users with premium accounts. | | `delete-folder` | Deletes a folder, either permanently or by moving it to the trash. | | `delete-folder-lock` | Deletes a folder lock on a given folder, removing restrictions on move and delete operations. | | `delete-folder-permanently` | Permanently deletes a folder that is in the trash. This action cannot be undone. | | `delete-group` | Permanently deletes a group. Only users with admin-level permissions will be able to use this API. | | `delete-legal-hold-policy` | Permanently delete an existing legal hold policy from Box. This is an asynchronous operation - the policy deletion is initiated but may not complete immediately. | | `delete-metadata-cascade-policy` | Permanently deletes a metadata cascade policy from a folder. | | `delete-metadata-instance-from-file` | Removes a metadata instance from a file. Deletes all metadata associated with a specific template from a file. | | `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. | | `delete-metadata-taxonomy` | Permanently deletes a metadata taxonomy from the enterprise. | | `delete-metadata-taxonomy-node` | Permanently deletes a metadata taxonomy node from Box. Metadata taxonomies in Box allow you to organize and classify content using hierarchical structures. | | `delete-metadata-template` | Permanently delete a metadata template and all its instances from files and folders. **WARNING**: This operation is destructive and cannot be undone. | | `delete-retention-policy` | Permanently deletes a retention policy from the Box enterprise. | | `delete-retention-policy-assignment` | Removes a retention policy assignment from content in Box. This action permanently removes the link between a retention policy and its assigned... | | `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. | | `delete-shared-link-from-folder` | Removes a shared link from a folder in Box. This action disables the shared link for the specified folder, making it no longer accessible via the previously shared URL. | | `delete-shared-link-from-web-link` | Removes a shared link from a web link in Box. This action disables the shared link for the specified web link, making it no longer accessible via the... | | `delete-shield-information-barrier-segment` | Permanently deletes a shield information barrier segment by its ID. | | `delete-shield-information-barrier-segment-member-by-id` | Removes a user from a shield information barrier segment by deleting their membership. | | `delete-slack-integration-mapping` | Deletes a Slack integration mapping that links a Box folder to a Slack channel. | | `delete-storage-policy-assignment` | Deletes a storage policy assignment, causing the assigned user to inherit the enterprise's default storage policy (Box Zone). | | `delete-task` | Permanently deletes a task from Box. Tasks are work assignments on files that can be assigned to collaborators for review or completion. | | `delete-task-assignment` | Deletes a specific task assignment, removing the task from the assigned user. | | `delete-teams-integration-mapping` | Deletes a Microsoft Teams integration mapping that links a Box folder to a Teams channel. | | `delete-upload-session` | Abort and permanently remove a chunked upload session, discarding all uploaded data. | | `delete-user` | Permanently deletes a user from the enterprise. By default, deletion fails if the user still owns content, was recently active, or recently joined from a free account. | | `delete-user-avatar` | Deletes a user's custom avatar image from Box. This operation is irreversible. | | `delete-user-domain-exemption` | Removes a user's exemption from the enterprise's collaboration domain restrictions. | | `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. | | `delete-watermark-from-file` | Removes the watermark from a file. This action deletes the watermark that was previously applied to the specified file. | | `delete-watermark-from-folder` | Removes the watermark from a folder. This action deletes the watermark applied to a specified folder. | | `delete-webhook` | Permanently deletes a webhook from the Box account. Webhooks are used to receive notifications at a specified URL when events occur on Box content. | | `delete-web-link` | Deletes a web link. | | `delete-web-link-permanently` | Permanently deletes a web link that is in the trash. This action cannot be undone. | | `download-file` | Returns the contents of a file in binary format. | | `download-zip-archive` | Downloads a zip archive containing files and/or folders from Box. **Prerequisites**: You must first call 'BOX\_CREATE\_ZIP\_DOWNLOAD' to create a zip download request. | | `extract-metadata-freeform` | Extract metadata from Box files using AI with freeform prompts. | | `extract-metadata-structured` | Extract structured metadata from files using Box AI. Uses Large Language Models (LLMs) to extract metadata as key-value pairs from files. | | `find-app-item-for-shared-link` | Returns the file, folder, web link, or app item represented by a shared link. | | `find-file-for-shared-link` | Returns the file represented by a shared link. A shared file can be represented by a shared link, which can originate within the current enterprise or within another. | | `find-folder-for-shared-link` | Return the folder represented by a shared link. A shared folder can be represented by a shared link, which can originate within the current enterprise or within another. | | `find-metadata-template-by-instance-id` | Finds a metadata template by searching for the ID of an instance of the template. | | `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. | | `generate-text` | Generate text using Box AI based on a prompt and file context. | | `get-ai-agent` | Retrieves detailed information about a specific AI Agent by its unique identifier. **Use Cases:** - Get the current configuration and capabilities of... | | `get-ai-agent-default-configuration` | Retrieve the default AI agent configuration for a specific mode. | | `get-allowed-collaboration-domain` | Retrieves details of a specific allowed collaboration domain entry within your enterprise. | | `get-sign-request` | Retrieves the details of a specific Box Sign request by its unique ID. | | `get-sign-template` | Retrieves details of a specific Box Sign template by its unique ID. | | `get-collaboration` | Retrieves details of a single collaboration by its ID. A collaboration represents shared access between a user/group and a file or folder in Box. | | `get-collection` | Retrieves details of a specific collection by its unique identifier. | | `get-comment` | Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment. | | `get-current-user` | Retrieves information about the user who is currently authenticated. | | `get-device-pin` | Retrieves information about an individual device pin in the enterprise. | | `get-events-long-poll-endpoint` | Returns a list of real-time servers that can be used for long-polling user events. | | `get-file-information` | Retrieves the details about a file. | | `get-file-request` | Retrieves detailed information about a file request in Box. File requests are forms that allow external users to upload files to a specific folder... | | `get-files-under-retention` | Returns a paginated list of files under retention for a specific retention policy assignment. | | `get-file-thumbnail` | Retrieves a thumbnail, or smaller image representation, of a file. | | `get-file-version` | Retrieve detailed information about a specific version of a file. | | `get-file-version-legal-hold` | Retrieves detailed information about a specific file version legal hold by its ID. | | `get-file-versions-under-retention` | Returns a list of file versions under retention for a specified retention policy assignment. | | `get-folder` | Retrieves details for a folder, including the first 100 entries in the folder. | | `get-group` | Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API. | | `get-group-membership` | Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API. | | `get-legal-hold-policy` | Retrieve detailed information about a specific legal hold policy by its ID. | | `get-legal-hold-policy-assignment` | Retrieves detailed information about a specific legal hold policy assignment by its ID. | | `get-metadata-cascade-policy` | Retrieve a specific metadata cascade policy assigned to a folder. | | `get-metadata-instance-on-file` | Retrieves a specific metadata template instance that has been applied to a file. | | `get-metadata-instance-on-folder` | Retrieves the instance of a metadata template that has been applied to a folder. | | `get-metadata-taxonomies-for-namespace` | Retrieves all metadata taxonomies within a specific namespace. | | `get-metadata-taxonomy-by-taxonomy-key` | Retrieves a metadata taxonomy by its namespace and taxonomy key. | | `get-metadata-taxonomy-node-by-id` | Retrieves a specific node from a metadata taxonomy by its identifier. | | `get-metadata-template-by-id` | Retrieves a metadata template by its ID. | | `get-metadata-template-by-name` | Retrieves a metadata template by its `scope` and `templateKey` values. | | `get-retention-on-file` | Returns information about a file version retention. **Note**: File retention API is now **deprecated**. | | `get-retention-policy` | Retrieves a retention policy by its unique ID. Retention policies define how long content is retained before being automatically deleted or having the retention removed. | | `get-retention-policy-assignment` | Retrieves a retention policy assignment by its unique ID. A retention policy assignment represents a link between a retention policy and its target... | | `get-shared-link-for-file` | Retrieves the shared link information for a file. This action fetches details about an existing shared link, including the URL, access level... | | `get-shared-link-for-folder` | Retrieves shared link information for a folder. This action fetches the shared link details for a specified folder, including the public URL, access... | | `get-shared-web-link` | Tool to retrieve web link information for a shared link. Use when you have a Box shared link URL and need to get details about the web link object it points to. | | `get-shield-information-barrier-by-id` | Retrieves a shield information barrier by its unique ID. Shield information barriers are used to separate individuals/groups within the same... | | `get-shield-information-barrier-report-by-id` | Retrieves a shield information barrier report by its ID. Shield information barrier reports provide information about users and groups that are... | | `get-shield-information-barrier-segment-by-id` | Retrieves a shield information barrier segment by its unique identifier. | | `get-shield-information-barrier-segment-member-by-id` | Retrieves a shield information barrier segment member by its unique ID. | | `get-shield-information-barrier-segment-restriction-by-id` | Retrieves a shield information barrier segment restriction by its unique ID. | | `get-storage-policy` | Fetches a specific storage policy by its ID. Storage policies define the geographic location where content is stored (data residency). | | `get-storage-policy-assignment` | Retrieves information about a specific storage policy assignment. | | `get-task` | Retrieves detailed information about a specific task in Box. | | `get-task-assignment` | Retrieves detailed information about a specific task assignment in Box. | | `get-terms-of-service` | Retrieves a specific terms of service by its unique identifier. | | `get-trashed-file` | Retrieves a file that has been moved to the trash. Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. | | `get-trashed-folder` | Retrieves a folder that has been moved to the trash. Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. | | `get-trashed-web-link` | Retrieves a web link that has been moved to the trash. Returns detailed information about a trashed web link including its original URL, name... | | `get-upload-session` | Retrieves detailed information about an existing chunked upload session. | | `get-user` | Retrieves information about a user in the enterprise. The application and the authenticated user need to have the permission to look up users in the entire enterprise. | | `get-user-avatar` | Retrieves the avatar image of a Box user. Returns 404 if the user has no avatar set. | | `get-user-exempt-from-collaboration-domain-restrictions` | Retrieves details of a specific user exemption from collaboration domain restrictions. | | `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... | | `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. | | `get-watermark-on-folder` | Retrieve the watermark for a folder. | | `get-webhook` | Retrieves detailed information about a specific webhook by its ID. | | `get-web-link` | Retrieve detailed information about a web link (bookmark) in Box. | | `get-zip-download-status` | Get the download status of a zip archive, including progress, skipped items, and current state. **Prerequisites:** Call 'BOX\_CREATE\_ZIP\_DOWNLOAD'... | | `list-ai-agents` | Lists AI agents based on the provided parameters. | | `list-all-classifications` | Retrieves the classification metadata template and lists all the classifications available to this enterprise. | | `list-all-collections` | Retrieves all collections for a given user. Currently, only the `favorites` collection is supported. | | `list-all-file-versions` | Retrieve a list of the past versions for a file. Versions are only tracked by Box users with premium accounts. | | `list-all-global-metadata-templates` | Used to retrieve all generic, global metadata templates available to all enterprises using Box. | | `list-allowed-collaboration-domains` | Returns the list domains that have been deemed safe to create collaborations for within the current enterprise. | | `list-sign-requests` | Gets signature requests created by a user. If the `sign_files` and/or `parent_folder` are deleted, the signature request will not return in the list. | | `list-sign-templates` | Gets Box Sign templates created by a user. | | `list-skill-cards-on-file` | List the Box Skills metadata cards that are attached to a file. | | `list-collection-items` | Retrieves the files and/or folders contained within a Box collection. | | `list-enterprise-device-pins` | Retrieves all the device pins within an enterprise. The user must have admin privileges, and the application needs the "manage enterprise" scope to make this call. | | `list-enterprise-groups` | Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups. | | `list-enterprise-metadata-templates` | Used to retrieve all metadata templates created to be used specifically within the user's enterprise | | `list-enterprise-users` | Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`. | | `list-events` | Returns up to a year of past events for a given user or for the entire enterprise. | | `list-file-app-item-associations` | **This is a beta feature, which means that its availability might be limited.** Returns all app items the file is associated with. | | `list-file-collaborations` | Retrieves a list of pending and active collaborations for a file. | | `list-file-comments` | Retrieves a list of comments for a file. | | `list-files-on-legal-hold-policy-assignment` | Get a list of files with current file versions for a legal hold assignment. | | `list-file-version-legal-holds` | Get a list of file versions on legal hold for a legal hold assignment. | | `list-file-version-retentions` | Retrieves all file version retentions for the given enterprise. **Note**: File retention API is now **deprecated**. | | `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. | | `list-folder-collaborations` | Retrieves a list of pending and active collaborations for a folder. | | `list-folder-locks` | Retrieves folder lock details for a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint. | | `list-group-collaborations` | Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups. | | `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. | | `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. | | `list-hubs` | Tool to list all Box Hubs for the authenticated user or enterprise. | | `list-items-in-folder` | Retrieves a page of items in a folder. These items can be files, folders, and web links. | | `list-legal-hold-policies` | Retrieves a list of legal hold policies that belong to an enterprise. | | `list-legal-hold-policy-assignments` | Retrieves a list of items a legal hold policy has been assigned to. | | `list-metadata-cascade-policies` | Retrieves a list of all the metadata cascade policies that are applied to a given folder. | | `list-metadata-instances-on-file` | Retrieves all metadata instances applied to a file. Returns all metadata template instances that have been applied to the specified file, including... | | `list-metadata-instances-on-folder` | Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`. | | `list-metadata-taxonomy-nodes` | Retrieves metadata taxonomy nodes based on the specified parameters. | | `list-pending-collaborations` | Retrieves all pending collaboration invites for this user. | | `list-recently-accessed-items` | Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed. | | `list-retention-policies` | Retrieves all of the retention policies for an enterprise. | | `list-retention-policy-assignments` | Retrieves all retention policy assignments for a specified retention policy. | | `list-shield-information-barrier-reports` | Lists shield information barrier reports for a specified barrier. | | `list-shield-information-barriers` | Retrieves a list of shield information barrier objects for the enterprise of JWT. | | `list-shield-information-barrier-segment-members` | Lists shield information barrier segment members based on provided segment IDs. | | `list-shield-information-barrier-segment-restrictions` | Lists all shield information barrier segment restrictions for a specific segment. | | `list-shield-information-barrier-segments` | Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID. | | `list-slack-integration-mappings` | Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. | | `list-storage-policies` | Fetches all the storage policies in the enterprise. | | `list-storage-policy-assignments` | Fetches all the storage policy assignment for an enterprise or user. | | `list-task-assignments` | Lists all of the assignments for a given task. Returns a collection of task assignment objects showing who has been assigned to complete or review a task. | | `list-tasks-on-file` | Retrieves a list of all the tasks for a file. This endpoint does not support pagination. | | `list-teams-integration-mappings` | Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise. | | `list-terms-of-services` | Returns the current terms of service text and settings for the enterprise. | | `list-terms-of-service-user-statuses` | Retrieves a list of users and their acceptance status for a specific terms of service. | | `list-trashed-items` | Retrieves the files and folders that have been moved to the trash. | | `list-upload-session-parts` | List the parts (chunks) that have been uploaded to a chunked upload session. | | `list-user-email-aliases` | Retrieves all email aliases for a user. The collection does not include the primary login for the user. | | `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). | | `list-users-exempt-from-collaboration-domain-restrictions` | Returns a list of users who have been exempt from the collaboration domain restrictions. | | `list-webhooks` | Returns all defined webhooks for the requesting application. | | `list-workflows` | Lists Box Relay workflows configured for a specific folder. Use the 'trigger\_type' parameter to filter workflows by trigger type (e.g... | | `preflight-check-before-upload` | Performs a preflight check to verify that a file will be accepted by Box before uploading the entire file. | | `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. | | `query-files-folders-by-metadata` | Query files and folders by metadata using SQL-like syntax. Returns items that have metadata instances matching the specified template and optional query conditions. | | `refresh-access-token` | Refresh an Access Token using its client ID, secret, and refresh token. | | `request-access-token` | Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion. | | `resend-sign-request` | Resends signature request emails to all outstanding signers. | | `restore-file` | Restores a file that has been moved to the trash. An optional new parent ID can be provided to restore the file to in case the original folder has been deleted. | | `restore-file-version` | Restores a specific version of a file after it was deleted (trashed). | | `restore-folder` | Restores a folder that has been moved to the trash. An optional new parent ID can be provided to restore the folder to in case the original folder has been deleted. | | `restore-web-link` | Restores a web link that has been moved to the trash. This action recovers a trashed web link and restores it to its original parent folder. | | `revoke-access-token` | Revoke an active Access Token, effectively logging a user out that has been previously authenticated. | | `search-for-content` | Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. | | `start-workflow` | Starts a Box Relay workflow with trigger type `WORKFLOW_MANUAL_START`. | | `terminate-user-group-sessions` | Terminates all active sessions for users belonging to the specified Box enterprise groups. | | `terminate-user-sessions` | Creates asynchronous jobs to terminate active Box sessions for specified users. | | `transfer-owned-folders` | Transfers all files and folders owned by one user to another user's account in Box. | | `trim-metadata-taxonomy-levels` | Deletes the last level from a metadata taxonomy by trimming it. | | `unassign-legal-hold-policy` | Remove a legal hold policy assignment from an item (user, folder, file, or file version). | | `update-ai-agent` | Updates an existing custom AI agent in Box AI Studio. You can modify the agent's name, access settings, icon, and capability configurations (ask... | | `update-all-skill-cards-on-file` | An alternative method to overwrite and update all Box Skill metadata cards on a file. | | `update-barrier-segment` | Updates a shield information barrier segment's name and/or description. | | `update-skill-cards-on-file` | Updates one or more Box Skills metadata cards on a file using JSON-Patch format. | | `update-collaboration` | Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. | | `update-comment` | Update the message of a comment. | | `update-file` | Updates a file. This can be used to rename or move a file, create a shared link, or lock a file. | | `update-file-request` | Updates a file request in Box. File requests allow external users to upload files to a specific folder without needing a Box account. | | `update-folder` | Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more. | | `update-group` | Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API. | | `update-group-membership` | Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API. | | `update-legal-hold-policy` | Update an existing legal hold policy in Box. This action allows you to modify the name, description, and release notes of an existing legal hold policy. | | `update-metadata-instance-on-file` | Updates a metadata instance on a file using JSON-Patch operations. | | `update-metadata-instance-on-folder` | Updates metadata on a folder using JSON-Patch operations (RFC 6902). | | `update-metadata-taxonomy` | Tool to update an existing metadata taxonomy's display name. | | `update-metadata-taxonomy-node` | Tool to update an existing metadata taxonomy node's display name. | | `update-metadata-template` | Updates a metadata template by applying JSON-Patch operations. | | `update-retention-policy` | Updates an existing Box retention policy. Use this action to modify retention policy settings such as name, description, retention duration... | | `update-shared-link-on-file` | Updates a shared link on a file. | | `update-shared-link-on-folder` | Updates a shared link on a folder. | | `update-shared-link-on-web-link` | Updates a shared link on a web link. | | `update-shield-information-barrier-status` | Change the status of a shield information barrier. Shield information barriers are ethical walls that prevent exchanges or communication between... | | `update-slack-integration-mapping` | Updates an existing [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). | | `update-storage-policy-assignment` | Updates a storage policy assignment for an enterprise or user. | | `update-task` | Updates a task. This can be used to update a task's configuration, or to update its completion state. | | `update-task-assignment` | Updates a task assignment to change its resolution state or add a message. | | `update-teams-integration-mapping` | Updates a Microsoft Teams integration mapping that links a Box folder to a Teams channel. | | `update-terms-of-service` | Updates an existing terms of service for the enterprise. This action allows you to modify the status (enabled/disabled) and text content of an existing terms of service. | | `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. | | `update-user` | Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions. | | `update-webhook` | Updates an existing webhook's configuration. Use this action to modify a webhook's target item (file or folder), notification URL, or event triggers. | | `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... | | `upload-file` | Uploads a small file to Box. For file sizes over 50MB we recommend using the Chunk Upload APIs. | | `upload-file-version` | Update a file's content. For file sizes over 50MB we recommend using the Chunk Upload APIs. | | `upload-part-of-file` | Uploads a chunk of a file for an upload session. The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)... | ## Triggers (20) Subscribe with `.on(...)` in a script. A trigger with required configuration takes it as the second argument. | Trigger | Needs | What fires it | | -------------------------------- | ------------------ | --------------------------------------------------------------------------------- | | Collaboration Details Changed | `collaboration_id` | Triggers when a collaboration's details change (e.g., role, status, expiration). | | Comment Changed | `comment_id` | Triggers when a comment's content or details change in Box. | | New File Comment Added | `file_id` | Triggers when a new comment is added to a file in Box. | | File Metadata Changed | `file_id` | Triggers when a file's metadata or properties change in Box. | | File Shared Link Changed | `file_id` | Triggers when a file's shared link settings change in Box. | | New File Version Uploaded | `file_id` | Triggers when a new file version is uploaded to a file in Box. | | New Item Added to Folder | `folder_id` | Triggers when a new item (file, folder, or web link) is added to a folder in Box. | | Folder Properties Changed | `folder_id` | Triggers when a folder's core properties change in Box. | | Folder Shared Link Changed | `folder_id` | Triggers when a folder's shared link settings change in Box. | | New File Added to Folder | `folder_id` | Triggers when a new file is added to a folder in Box. | | New Folder Collaboration Created | `folder_id` | Triggers when a new collaboration is created on a specific folder in Box. | | New Pending Collaboration Invite | nothing | Triggers when a new pending collaboration invite is created. | | New Sign Request Created | nothing | Triggers when a new Box sign request is created. | | New Task Assignment Added | `task_id` | Triggers when a new assignment is added to a task in Box. | | New Task Created on File | `file_id` | Triggers when a new task is created on a Box file. | | Box Sign Request Status Changed | `sign_request_id` | Triggers when a Box Sign request's status or meaningful fields change. | | Task Assignment State Changed | `task_id` | Triggers when a task assignment's state changes. | | Task State Changed | `task_id` | Triggers when a task's status or details change in Box. | | Trashed File State Changed | `file_id` | Triggers when a file's trash state changes in Box. | | Trashed Folder State Changed | `folder_id` | Triggers when a folder's trash state changes in Box. | [Open Box in the console →](https://app.boxd.sh/integrations/detail/box)