BOX_FILE_COMMENT_ADDED_TRIGGER
Fires when someone adds a new comment to a file. Use this to track file discussions and feedback.
Box
20 triggers and 286 actions for Box workflows.
Each trigger lists the event it fires on, the data it sends, and a template you can use it in.
Real-time push from the source.
BOX_FILE_COMMENT_ADDED_TRIGGER
Fires when someone adds a new comment to a file. Use this to track file discussions and feedback.
BOX_FILE_VERSION_UPLOADED_TRIGGER
Fires when a new version of a file is uploaded. Use this to track file updates and version history.
BOX_NEW_FILE_ADDED_TRIGGER
Fires when a new file is uploaded to a folder. Use this to respond to new content being added.
BOX_NEW_FOLDER_COLLABORATION_CREATED_TRIGGER
Fires when someone is added as a collaborator on a folder. Use this to track new sharing and access grants.
BOX_NEW_SIGN_REQUEST_CREATED_TRIGGER
Fires when a new signature request is created in Box. Use this to start workflows when documents are sent for signing.
BOX_NEW_TASK_CREATED_TRIGGER
Fires when someone creates a new task on a file. Use this to respond to new work items being assigned on your files.
BOX_SIGN_REQUEST_STATUS_CHANGED_TRIGGER
Fires when a Box Sign request's status changes or when signers respond. Use this to track signature collection progress.
BOX_TASK_STATE_CHANGED_TRIGGER
Fires when a task's status, due date, or completion state changes. Use this to monitor task progress and updates.
BOX_COLLABORATION_DETAILS_CHANGED_TRIGGER
Fires when a collaboration's key details change, such as the user's role, access status, or expiration date. Use this to track permission and access modifications.
BOX_COMMENT_CHANGED_TRIGGER
Fires when a comment is edited or updated. Use this to track changes to file feedback and discussions.
BOX_FILE_METADATA_CHANGED_TRIGGER
Fires when a file's properties change, such as its name, description, size, or location. Use this to monitor file metadata updates.
BOX_FILE_SHARED_LINK_CHANGED_TRIGGER
Fires when a file's shared link settings change, such as access level, password, or expiration. Use this to monitor public file sharing configuration updates.
BOX_FOLDER_ITEM_ADDED_TRIGGER
Fires when a new file, folder, or web link is added to a folder. Use this to track all new content being added to a location.
BOX_FOLDER_PROPERTIES_CHANGED_TRIGGER
Fires when a folder's basic properties change, such as its name, description, location, or shared link settings. Use this to monitor folder configuration updates.
BOX_FOLDER_SHARED_LINK_CHANGED_TRIGGER
Fires when a folder's shared link settings change, such as access level, password, or expiration. Use this to monitor public sharing configuration updates.
BOX_NEW_PENDING_COLLABORATION_TRIGGER
Fires when you receive a new collaboration invite. Use this to notify users of pending access requests.
BOX_NEW_TASK_ASSIGNMENT_TRIGGER
Fires when someone is assigned to a task. Use this to notify users of new work assignments.
BOX_TASK_ASSIGNMENT_STATE_CHANGED_TRIGGER
Fires when a task assignment is completed, approved, or rejected. Use this to track task resolution and approval status.
BOX_TRASHED_FILE_STATE_CHANGED_TRIGGER
Fires when a file is moved to or restored from trash. Use this to monitor file deletion and recovery actions.
BOX_TRASHED_FOLDER_STATE_CHANGED_TRIGGER
Fires when a folder is moved to or restored from trash. Use this to monitor folder deletion and recovery actions.
Operations are the actions a workflow can take in Box, grouped by category. Each lists its method, parameters, and a template you can drop it into.
Leverage artificial intelligence capabilities to automate content analysis and generation tasks. Build and manage AI agents that can answer questions about your files and generate text-based content within your Box workflows.
Ask question
BOX_ASK_QUESTIONAsk natural language questions about your Box files and get instant AI-powered answers based on the file contents. This helps you quickly extract information from documents without manually reading through them.
Create AI Agent
BOX_CREATE_AI_AGENTSet up a custom AI agent within Box AI Studio to automate tasks like answering questions, generating content, or extracting metadata from your documents. This lets you build intelligent automation tailored to your team's specific workflows without coding.
Manage secure access to the Box API through token-based authentication. Handle user authorization, token refresh, and revocation to maintain proper security and session management in your integrations.
Authorize user
BOX_AUTHORIZE_USERDirects a user to Box's authorization page so they can grant your application permission to access their Box account and files on their behalf. This is the essential first step for enabling secure API access to a user's Box workspace.
Organize and categorize your Box files and folders with structured classification metadata. Apply standardized classification schemes to ensure consistent organization and compliance across your enterprise content.
Add classification to file
BOX_ADD_CLASSIFICATION_TO_FILEAdds a security classification label to a file in Box, helping you organize and protect sensitive documents according to your organization's compliance standards. This ensures files are properly marked with the appropriate security level for access control and audit purposes.
Add classification to folder
BOX_ADD_CLASSIFICATION_TO_FOLDERApplies a security classification label to a folder to organize and control access based on your organization's data sensitivity standards. This helps maintain compliance and ensures files are handled according to their confidentiality level.
Add initial classifications
BOX_ADD_INITIAL_CLASSIFICATIONSSets up your enterprise's document classification system by creating an initial template with classification labels like Confidential, Internal, or Public. This establishes how your team will organize and protect documents based on sensitivity levels.
Control how users share access and work together on files and folders within Box. Manage collaboration invitations, permissions, and group access to streamline team workflows and content sharing.
Create collaboration
BOX_CREATE_COLLABORATIONGrant specific people or groups access to your files and folders on Box with customizable permission levels. This enables you to collaborate securely without sharing broader account access.
Enable threaded discussions on files by creating, reading, and managing comments collaboratively. Foster asynchronous communication and feedback loops directly within your Box file workflows.
Create comment
BOX_CREATE_COMMENTAdd comments to files or reply to existing comments to facilitate team collaboration and feedback on documents stored in Box.
Perform comprehensive file management operations including uploading, copying, versioning, and deletion. Control file lifecycle, recover previous versions, and generate thumbnails to support full document management workflows.
Copy file
BOX_COPY_FILEDuplicates a file in your Box storage, allowing you to preserve the original while creating a working version without manual re-uploading.
Create, organize, and manage folder structures with support for locking and transferring ownership. Control folder contents, permissions, and retention while maintaining proper hierarchy and access governance.
Create folder
BOX_CREATE_FOLDERCreate a new folder in Box to organize and structure your file storage. Use this to build a logical folder hierarchy for managing documents, projects, and team resources.
Copy folder
BOX_COPY_FOLDERCreates a duplicate of a folder and all its contents in a specified destination, leaving the original folder unchanged. This helps you maintain backup copies or organize project versions without affecting existing work.
Create folder lock
BOX_CREATE_FOLDER_LOCKPrevent accidental or unauthorized changes to important folders by locking them from being moved or deleted, ensuring critical business files stay secure and in their intended location.
Administer user groups within your Box enterprise to manage team composition and membership. Assign users to groups and update group settings to support role-based access control and team organization.
Add user to group
BOX_ADD_USER_TO_GROUPAdd a team member to a Box group to organize users and manage access to shared files and folders based on department or project teams.
Create group
BOX_CREATE_GROUPCreates a new group of users in your Box enterprise, allowing you to organize team members for easier file sharing and permission management. This helps you control access to sensitive documents and collaborate more efficiently across different departments or projects.
Connect Box to external collaboration platforms like Slack and Microsoft Teams for seamless content sharing. Map Box content to channel conversations and enable cross-platform collaboration workflows.
Create slack integration mapping
BOX_CREATE_SLACK_INTEGRATION_MAPPINGConnect a Slack channel directly to a Box folder or file so your team can access and manage content without leaving Slack. This creates a seamless workflow where file updates and discussions happen in one unified space.
Create Teams integration mapping
BOX_CREATE_TEAMS_INTEGRATION_MAPPINGLinks a Microsoft Teams channel to a Box folder so files shared in Teams are automatically stored in the designated Box folder, creating a unified document management system across both platforms.
Define and apply structured metadata taxonomies to files and folders for advanced organization and discovery. Create custom metadata templates and apply metadata-driven cascade policies to enforce consistent tagging across your content.
Append metadata taxonomy level
BOX_APPEND_METADATA_TAXONOMY_LEVELAdd a new hierarchical level to your metadata taxonomy structure to create or expand organizational categories for files and documents. This helps you build structured classification systems that grow with your organizational needs.
Create metadata cascade policy
BOX_CREATE_METADATA_CASCADE_POLICYAutomatically applies metadata templates to all files and subfolders within a folder, ensuring consistent data organization and tracking across your content. This saves time by eliminating manual metadata assignment for every new item added to the folder.
Create metadata instance on file
BOX_CREATE_METADATA_INSTANCE_ON_FILEAttach custom metadata to a file in Box by applying a metadata template instance, allowing you to add structured information like legal case numbers, contract dates, or compliance classifications directly to your documents.
Create metadata instance on folder
BOX_CREATE_METADATA_INSTANCE_ON_FOLDERAttach custom metadata templates to folders in Box to organize and categorize your files with structured information. This enables you to tag folders with standardized properties that help with document management, compliance, and information retrieval.
Create metadata taxonomy
BOX_CREATE_METADATA_TAXONOMYSet up a hierarchical classification system in Box to organize and standardize how metadata templates are categorized across your files and folders. This helps your team apply consistent naming and organization rules to documents.
Create metadata taxonomy levels
BOX_CREATE_METADATA_TAXONOMY_LEVELSEstablish hierarchical levels for organizing and categorizing files in Box by creating a structured taxonomy with multiple levels. This helps you build a consistent classification system that teams can apply to documents and folders across your workspace.
Create metadata taxonomy node
BOX_CREATE_METADATA_TAXONOMY_NODECreates a new classification category within your Box metadata taxonomy, allowing you to expand your organizational structure for better file organization and retrieval.
Create metadata template
BOX_CREATE_METADATA_TEMPLATESet up a custom metadata template to tag files and folders with standardized information like project names, client details, or compliance status. This helps you organize and categorize your documents consistently across your Box workspace.
Set up file request forms to collect submissions from internal and external contributors. Manage the lifecycle of file requests from creation through completion to streamline intake workflows.
Copy file request
BOX_COPY_FILE_REQUESTCreates a copy of an existing file request in a different folder, allowing you to reuse file collection workflows across multiple projects or clients. This enables external users to upload files without needing a Box account, streamlining document collection processes.
Enforce data retention and legal hold policies to ensure compliance with regulatory requirements. Assign retention rules to files, folders, and users while tracking retention status and managing policy assignments.
Assign legal hold policy
BOX_ASSIGN_LEGAL_HOLD_POLICYAssign a legal hold policy to files, folders, or user accounts to preserve content and prevent deletion for litigation or compliance requirements. This ensures that important business records are protected during legal proceedings or regulatory audits.
Assign retention policy
BOX_ASSIGN_RETENTION_POLICYApply a retention policy to folders, metadata categories, or your entire enterprise to automatically manage how long documents are kept before deletion or archival. This ensures your organization stays compliant with legal and regulatory requirements without manual file management.
Create legal hold policy
BOX_CREATE_LEGAL_HOLD_POLICYCreate a new legal hold policy to protect files and content from deletion during litigation or regulatory investigations. Once created, you can apply this policy to specific users, folders, or files to ensure compliance with legal requirements.
Create retention policy
BOX_CREATE_RETENTION_POLICYSet up automatic content preservation rules in Box to ensure files and folders are retained for a specified period before deletion, helping you maintain compliance with legal and regulatory requirements.
Implement enterprise security controls including information barriers, device management, and collaboration restrictions. Configure segmentation policies and monitor security events to protect sensitive content and enforce compliance boundaries.
Add domain to list of allowed collaboration domains
BOX_ADD_ALLOWED_COLLABORATION_DOMAINWhitelist specific domains for collaboration with your Box enterprise, controlling whether external users can access your files, your users can access theirs, or both directions are allowed.
Create shield information barrier
BOX_CREATE_SHIELD_INFORMATION_BARRIERSets up an information barrier that creates an ethical wall to prevent specific users or groups from accessing shared files and communicating with each other, helping enforce compliance and confidentiality requirements within your organization.
Create shield information barrier report
BOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORTGenerates a report that documents how information barriers are configured and enforced within your Box environment, helping you verify compliance with data access restrictions. This creates an audit trail showing which barriers are active and their current status.
Create shield information barrier segment
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENTCreate a distinct organizational segment within a compliance barrier to isolate groups of users who need restricted collaboration for regulatory purposes. This enables solopreneurs and small teams operating across multiple departments or client groups to enforce information barriers and maintain compliance with financial regulations.
Create shield information barrier segment member
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERAssigns a user to a specific information barrier segment in Box to enforce compliance rules and prevent unauthorized collaboration between departments. This ensures sensitive information stays within designated teams while maintaining security and regulatory requirements.
Create shield information barrier segment restriction
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONEstablishes a one-way collaboration barrier between two department groups within your organization, preventing them from sharing files or communicating with each other. This is essential for maintaining compliance with regulatory requirements or enforcing ethical walls between conflicting business units.
Create user exemption from collaboration domain restrictions
BOX_CREATE_COLLAB_EXEMPTIONAllows you to exempt a specific user from your enterprise's collaboration domain restrictions, enabling them to work with external partners from any domain regardless of your organization's approved domain list.
Control how files, folders, and links are shared through managed access permissions and shared link generation. Retrieve and update sharing settings to support flexible content distribution while maintaining security.
Add shared link to file
BOX_ADD_SHARED_LINK_TO_FILECreates a shareable link for a file, allowing you to distribute it to clients, collaborators, or the public without needing to grant them direct Box account access.
Add shared link to folder
BOX_ADD_SHARED_LINK_TO_FOLDERCreate a shareable URL link for a Box folder with customizable access levels, enabling you to securely share files with clients, team members, or the public without giving them direct folder access.
Add shared link to web link
BOX_ADD_SHARED_LINK_TO_WEB_LINKCreates a publicly shareable link for a web link stored in Box, allowing you to easily distribute access to external URLs without requiring individual file permissions.
Integrate document signing capabilities into your workflows using Box Sign for digital agreements and approvals. Create signing requests, manage templates, and track signature status for streamlined contract and document approval processes.
Cancel box sign request
BOX_CANCEL_BOX_SIGN_REQUESTStop a pending document signing request before all parties have signed, preventing further signature collection and notifying remaining signers. Use this when you need to halt a signature workflow due to changed circumstances or errors.
Create Box Sign Request
BOX_CREATE_BOX_SIGN_REQUESTSend documents to clients and partners for electronic signatures without requiring them to have Box accounts, streamlining your contract and agreement signing process.
Attach AI-generated metadata and insights to files through Box Skills cards for intelligent content processing. Update and manage skill cards to display automated analysis and extracted information directly on files.
Create box skill cards on file
BOX_CREATE_BOX_SKILL_CARDS_ON_FILEAttach AI-generated metadata cards to files in Box that capture extracted information like text, keywords, or classifications. This enriches your files with searchable, structured data for better organization and discovery.
Assign and manage storage policies across your enterprise to control user storage capacity and quota management. Monitor storage policy assignments and update policies to support flexible capacity planning.
Assign storage policy
BOX_ASSIGN_STORAGE_POLICYSets up where your company's files are stored geographically to meet legal compliance requirements or data residency regulations. This ensures your sensitive data stays in specific regions as mandated by your industry or government.
Create task assignments on files to enable collaborative work tracking and approval workflows. Manage task lifecycle including assignments, updates, and completions to support project coordination within Box.
Create task
BOX_CREATE_TASKCreate a task attached to a file in Box to track action items, reviews, or deliverables that need attention. Tasks help organize work and ensure important file-related items don't get overlooked.
Assign task
BOX_ASSIGN_TASKDistribute work to team members by creating task assignments that specify who should complete what work and by when. This enables you to delegate responsibilities and track progress on collaborative projects.
Manage the file upload process with support for large files, resumable uploads, and session management. Validate upload readiness, commit uploads in chunks, and handle multi-part file transfers reliably.
Commit upload session
BOX_COMMIT_UPLOAD_SESSIONFinalizes a chunked file upload to Box by committing the upload session and creating the completed file after all parts have been uploaded.
Create, update, and manage user accounts and identities within your Box enterprise. Control user properties, email aliases, avatars, and invitations to support user lifecycle management.
Add or update user avatar
BOX_ADD_OR_UPDATE_USER_AVATARSet or change a user's profile picture in Box to maintain a professional appearance and help team members recognize each other. This keeps your workspace organized and makes collaboration more personal.
Create email alias
BOX_CREATE_EMAIL_ALIASCreate a new email alias for a Box user account to enable alternative email addresses for accessing files and receiving notifications. Email aliases must use a domain registered to your enterprise.
Apply visual watermarks to files and folders to protect sensitive content and indicate confidentiality levels. Manage watermark visibility to support document protection and compliance requirements.
Apply watermark to file
BOX_APPLY_WATERMARK_TO_FILEAdd or update a watermark on your files in Box to protect your intellectual property and brand identity. This helps safeguard sensitive documents and confidential materials from unauthorized use or distribution.
Apply watermark to folder
BOX_APPLY_WATERMARK_TO_FOLDERAdd or update a watermark on a folder to protect your documents with visible branding or security marks that appear across all files within that folder.
Change shield information barrier status
BOX_UPDATE_SHIELD_INFORMATION_BARRIER_STATUSChange the status of a shield information barrier.
Create jobs to terminate user group session
BOX_TERMINATE_USER_GROUP_SESSIONSTerminates all active sessions for users belonging to the specified Box enterprise groups.
Create jobs to terminate users session
BOX_TERMINATE_USER_SESSIONSCreates asynchronous jobs to terminate active Box sessions for specified users.
Create terms of service
BOX_CREATE_TERMS_OF_SERVICECreates a terms of service for a given enterprise and type of user.
Create terms of service status for new user
BOX_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.
Create upload session
BOX_CREATE_UPLOAD_SESSIONCreates an upload session for chunked upload of large files (20MB+).
Create upload session for existing file
BOX_CREATE_UPLOAD_SESSION_FOR_EXISTING_FILECreates an upload session for uploading a new version of an existing file using chunked upload.
Create user
BOX_CREATE_USERCreates a new managed user in an enterprise.
Create user invite
BOX_CREATE_USER_INVITEInvites an existing external user to join an enterprise.
Create web link
BOX_CREATE_WEB_LINKCreates a web link object within a folder.
Create webhook
BOX_CREATE_WEBHOOKCreates a webhook to monitor a file or folder for specific events.
Create zip download
BOX_CREATE_ZIP_DOWNLOADCreates a request to download multiple files and folders as a single zip archive file.
Delete AI Agent
BOX_DELETE_AI_AGENTPermanently deletes a custom AI agent from Box AI Studio.
Delete file
BOX_DELETE_FILEDeletes a file from Box by moving it to trash or permanently (based on enterprise settings).
Delete file request
BOX_DELETE_FILE_REQUESTDeletes a file request permanently.
Delete folder
BOX_DELETE_FOLDERDeletes a folder, either permanently or by moving it to the trash.
Delete folder lock
BOX_DELETE_FOLDER_LOCKDeletes a folder lock on a given folder, removing restrictions on move and delete operations.
Delete retention policy
BOX_DELETE_RETENTION_POLICYPermanently deletes a retention policy from the Box enterprise.
Delete shield information barrier segment
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENTPermanently deletes a shield information barrier segment by its ID.
Delete shield information barrier segment member by id
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_IDRemoves a user from a shield information barrier segment by deleting their membership.
Delete shield information barrier segment restriction by id
BOX_DELETE_BARRIER_RESTRICTIONDeletes a shield information barrier segment restriction by its unique ID.
Delete Slack integration mapping
BOX_DELETE_SLACK_INTEGRATION_MAPPINGDeletes a Slack integration mapping that links a Box folder to a Slack channel.
Delete teams integration mapping
BOX_DELETE_TEAMS_INTEGRATION_MAPPINGDeletes a Microsoft Teams integration mapping that links a Box folder to a Teams channel.
Delete user
BOX_DELETE_USERPermanently deletes a user from the enterprise.
Delete user avatar
BOX_DELETE_USER_AVATARDeletes a user's custom avatar image from Box.
Download file
BOX_DOWNLOAD_FILEReturns the contents of a file in binary format.
Download zip archive
BOX_DOWNLOAD_ZIP_ARCHIVEDownloads a zip archive containing files and/or folders from Box.
Extract metadata freeform
BOX_EXTRACT_METADATA_FREEFORMExtract metadata from Box files using AI with freeform prompts.
Extract metadata structured
BOX_EXTRACT_METADATA_STRUCTUREDExtract structured metadata from files using Box AI.
Find file for shared link
BOX_FIND_FILE_FOR_SHARED_LINKReturns the file represented by a shared link.
Find folder for shared link
BOX_FIND_FOLDER_FOR_SHARED_LINKReturn the folder represented by a shared link.
Find item for shared link
BOX_FIND_APP_ITEM_FOR_SHARED_LINKReturns the file, folder, web link, or app item represented by a shared link.
Find metadata template by instance id
BOX_FIND_METADATA_TEMPLATE_BY_INSTANCE_IDFinds a metadata template by searching for the ID of an instance of the template.
Force apply metadata cascade policy to folder
BOX_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.
Generate text
BOX_GENERATE_TEXTGenerate text using Box AI based on a prompt and file context.
Get AI Agent by ID
BOX_GET_AI_AGENTRetrieves detailed information about a specific AI Agent by its unique identifier.
Get ai agent default configuration
BOX_GET_AI_AGENT_DEFAULT_CONFIGURATIONRetrieve the default AI agent configuration for a specific mode.
Get allowed collaboration domain
BOX_GET_ALLOWED_COLLABORATION_DOMAINRetrieves details of a specific allowed collaboration domain entry within your enterprise.
Get box sign request by id
BOX_GET_BOX_SIGN_REQUESTRetrieves the details of a specific Box Sign request by its unique ID.
Get Box Sign Template by ID
BOX_GET_BOX_SIGN_TEMPLATERetrieves details of a specific Box Sign template by its unique ID.
Get collaboration
BOX_GET_COLLABORATIONRetrieves details of a single collaboration by its ID.
Get collection by id
BOX_GET_COLLECTIONRetrieves details of a specific collection by its unique identifier.
Get comment
BOX_GET_COMMENTRetrieves the message and metadata for a specific comment, as well as information on the user who created the comment.
Get current user
BOX_GET_CURRENT_USERRetrieves information about the user who is currently authenticated.
Get device pin
BOX_GET_DEVICE_PINRetrieves information about an individual device pin in the enterprise.
Get file information
BOX_GET_FILE_INFORMATIONRetrieves the details about a file.
Get file request
BOX_GET_FILE_REQUESTRetrieves detailed information about a file request in Box.
Get file thumbnail
BOX_GET_FILE_THUMBNAILRetrieves a thumbnail, or smaller image representation, of a file.
Get file version
BOX_GET_FILE_VERSIONRetrieve detailed information about a specific version of a file.
Get file version legal hold
BOX_GET_FILE_VERSION_LEGAL_HOLDRetrieves detailed information about a specific file version legal hold by its ID.
Get file versions under retention
BOX_GET_FILE_VERSIONS_UNDER_RETENTIONReturns a list of file versions under retention for a specified retention policy assignment.
Get files under retention
BOX_GET_FILES_UNDER_RETENTIONReturns a paginated list of files under retention for a specific retention policy assignment.
Get folder information
BOX_GET_FOLDERRetrieves details for a folder, including the first 100 entries in the folder.
Get group
BOX_GET_GROUPRetrieves information about a group.
Get group membership
BOX_GET_GROUP_MEMBERSHIPRetrieves a specific group membership.
Get legal hold policy
BOX_GET_LEGAL_HOLD_POLICYRetrieve detailed information about a specific legal hold policy by its ID.
Get legal hold policy assignment
BOX_GET_LEGAL_HOLD_POLICY_ASSIGNMENTRetrieves detailed information about a specific legal hold policy assignment by its ID.
Get metadata cascade policy
BOX_GET_METADATA_CASCADE_POLICYRetrieve a specific metadata cascade policy assigned to a folder.
Get metadata instance on file
BOX_GET_METADATA_INSTANCE_ON_FILERetrieves a specific metadata template instance that has been applied to a file.
Get metadata instance on folder
BOX_GET_METADATA_INSTANCE_ON_FOLDERRetrieves the instance of a metadata template that has been applied to a folder.
Get metadata taxonomies for namespace
BOX_GET_METADATA_TAXONOMIES_FOR_NAMESPACERetrieves all metadata taxonomies within a specific namespace.
Get metadata taxonomy by taxonomy key
BOX_GET_METADATA_TAXONOMY_BY_TAXONOMY_KEYRetrieves a metadata taxonomy by its namespace and taxonomy key.
Get metadata taxonomy node by ID
BOX_GET_METADATA_TAXONOMY_NODE_BY_IDRetrieves a specific node from a metadata taxonomy by its identifier.
Get metadata template by id
BOX_GET_METADATA_TEMPLATE_BY_IDRetrieves a metadata template by its ID.
Get metadata template by name
BOX_GET_METADATA_TEMPLATE_BY_NAMERetrieves a metadata template by its scope and templateKey values.
Get Real-Time Server URL for Long-Polling Events
BOX_GET_EVENTS_LONG_POLL_ENDPOINTReturns a list of real-time servers that can be used for long-polling user events.
Get retention on file
BOX_GET_RETENTION_ON_FILEReturns information about a file version retention.
Get retention policy
BOX_GET_RETENTION_POLICYRetrieves a retention policy by its unique ID.
Get retention policy assignment
BOX_GET_RETENTION_POLICY_ASSIGNMENTRetrieves a retention policy assignment by its unique ID.
Get shared items web links
BOX_GET_SHARED_WEB_LINKTool to retrieve web link information for a shared link.
Get shared link for file
BOX_GET_SHARED_LINK_FOR_FILERetrieves the shared link information for a file.
Get shared link for folder
BOX_GET_SHARED_LINK_FOR_FOLDERRetrieves shared link information for a folder.
Get shield information barrier report by id
BOX_GET_SHIELD_INFORMATION_BARRIER_REPORT_BY_IDRetrieves a shield information barrier report by its ID.
Get shield information barrier segment member by id
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_IDRetrieves a shield information barrier segment member by its unique ID.
Get shield information barrier segment restriction by id
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_IDRetrieves a shield information barrier segment restriction by its unique ID.
Get shield information barrier segment with specified id
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_BY_IDRetrieves a shield information barrier segment by its unique identifier.
Get shield information barrier with specified id
BOX_GET_SHIELD_INFORMATION_BARRIER_BY_IDRetrieves a shield information barrier by its unique ID.
Get storage policy
BOX_GET_STORAGE_POLICYFetches a specific storage policy by its ID.
Get storage policy assignment
BOX_GET_STORAGE_POLICY_ASSIGNMENTRetrieves information about a specific storage policy assignment.
Get task
BOX_GET_TASKRetrieves detailed information about a specific task in Box.
Get task assignment
BOX_GET_TASK_ASSIGNMENTRetrieves detailed information about a specific task assignment in Box.
Get terms of service
BOX_GET_TERMS_OF_SERVICERetrieves a specific terms of service by its unique identifier.
Get trashed file
BOX_GET_TRASHED_FILERetrieves a file that has been moved to the trash.
Get trashed folder
BOX_GET_TRASHED_FOLDERRetrieves a folder that has been moved to the trash.
Get trashed web link
BOX_GET_TRASHED_WEB_LINKRetrieves a web link that has been moved to the trash.
Get upload session
BOX_GET_UPLOAD_SESSIONRetrieves detailed information about an existing chunked upload session.
Get user
BOX_GET_USERRetrieves information about a user in the enterprise.
Get user avatar
BOX_GET_USER_AVATARRetrieves the avatar image of a Box user.
Get user exempt from collaboration domain restrictions
BOX_GET_USER_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONSRetrieves details of a specific user exemption from collaboration domain restrictions.
Get user invite status
BOX_GET_USER_INVITE_STATUSReturns the status of a user invite.
Get watermark for folder
BOX_GET_WATERMARK_ON_FOLDERRetrieve the watermark for a folder.
Get watermark on file
BOX_GET_WATERMARK_ON_FILERetrieve the watermark for a file.
Get web link
BOX_GET_WEB_LINKRetrieve detailed information about a web link (bookmark) in Box.
Get webhook
BOX_GET_WEBHOOKRetrieves detailed information about a specific webhook by its ID.
Get zip download status
BOX_GET_ZIP_DOWNLOAD_STATUSGet the download status of a zip archive, including progress, skipped items, and current state.
List ai agents
BOX_LIST_AI_AGENTSLists AI agents based on the provided parameters.
List all classifications
BOX_LIST_ALL_CLASSIFICATIONSRetrieves the classification metadata template and lists all the classifications available to this enterprise.
List all collections
BOX_LIST_ALL_COLLECTIONSRetrieves all collections for a given user.
List all file versions
BOX_LIST_ALL_FILE_VERSIONSRetrieve a list of the past versions for a file.
List all global metadata templates
BOX_LIST_ALL_GLOBAL_METADATA_TEMPLATESUsed to retrieve all generic, global metadata templates available to all enterprises using Box.
List all legal hold policies
BOX_LIST_LEGAL_HOLD_POLICIESRetrieves a list of legal hold policies that belong to an enterprise.
List all metadata templates for enterprise
BOX_LIST_ENTERPRISE_METADATA_TEMPLATESUsed to retrieve all metadata templates created to be used specifically within the user's enterprise
List all webhooks
BOX_LIST_WEBHOOKSReturns all defined webhooks for the requesting application.
List allowed collaboration domains
BOX_LIST_ALLOWED_COLLABORATION_DOMAINSReturns the list domains that have been deemed safe to create collaborations for within the current enterprise.
List Box Hubs
BOX_LIST_HUBSTool to list all Box Hubs for the authenticated user or enterprise.
List box sign requests
BOX_LIST_BOX_SIGN_REQUESTSGets signature requests created by a user.
List box sign templates
BOX_LIST_BOX_SIGN_TEMPLATESGets Box Sign templates created by a user.
List box skill cards on file
BOX_LIST_BOX_SKILL_CARDS_ON_FILEList the Box Skills metadata cards that are attached to a file.
List collection items
BOX_LIST_COLLECTION_ITEMSRetrieves the files and/or folders contained within a Box collection.
List enterprise device pins
BOX_LIST_ENTERPRISE_DEVICE_PINSRetrieves all the device pins within an enterprise.
List enterprise users
BOX_LIST_ENTERPRISE_USERSReturns a list of all users for the Enterprise along with their userid, publicname, and login.
List file app item associations
BOX_LIST_FILE_APP_ITEM_ASSOCIATIONSThis is a beta feature, which means that its availability might be limited.
List file collaborations
BOX_LIST_FILE_COLLABORATIONSRetrieves a list of pending and active collaborations for a file.
List file comments
BOX_LIST_FILE_COMMENTSRetrieves a list of comments for a file.
List file version legal holds
BOX_LIST_FILE_VERSION_LEGAL_HOLDSGet a list of file versions on legal hold for a legal hold assignment.
List file version retentions
BOX_LIST_FILE_VERSION_RETENTIONSRetrieves all file version retentions for the given enterprise.
List folder app item associations
BOX_LIST_FOLDER_APP_ITEM_ASSOCIATIONSThis is a beta feature, which means that its availability might be limited.
List folder collaborations
BOX_LIST_FOLDER_COLLABORATIONSRetrieves a list of pending and active collaborations for a folder.
List folder locks
BOX_LIST_FOLDER_LOCKSRetrieves folder lock details for a given folder.
List group collaborations
BOX_LIST_GROUP_COLLABORATIONSRetrieves all the collaborations for a group.
List groups for enterprise
BOX_LIST_ENTERPRISE_GROUPSRetrieves all of the groups for a given enterprise.
List items in folder
BOX_LIST_ITEMS_IN_FOLDERRetrieves a page of items in a folder.
List legal hold policy assignments
BOX_LIST_LEGAL_HOLD_POLICY_ASSIGNMENTSRetrieves a list of items a legal hold policy has been assigned to.
List members of group
BOX_LIST_GROUP_MEMBERSRetrieves all the members for a group.
List metadata cascade policies
BOX_LIST_METADATA_CASCADE_POLICIESRetrieves a list of all the metadata cascade policies that are applied to a given folder.
List metadata instances on file
BOX_LIST_METADATA_INSTANCES_ON_FILERetrieves all metadata instances applied to a file.
List metadata instances on folder
BOX_LIST_METADATA_INSTANCES_ON_FOLDERRetrieves all metadata for a given folder.
List metadata taxonomy nodes
BOX_LIST_METADATA_TAXONOMY_NODESRetrieves metadata taxonomy nodes based on the specified parameters.
List pending collaborations
BOX_LIST_PENDING_COLLABORATIONSRetrieves all pending collaboration invites for this user.
List previous file versions for legal hold policy assignment
BOX_LIST_HOLD_FILE_VERSIONSRetrieves a list of previous (non-current) file versions that are on legal hold for a specific legal hold policy assignment.
List recently accessed items
BOX_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 policies
BOX_LIST_RETENTION_POLICIESRetrieves all of the retention policies for an enterprise.
List retention policy assignments
BOX_LIST_RETENTION_POLICY_ASSIGNMENTSRetrieves all retention policy assignments for a specified retention policy.
List shield information barrier reports
BOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTSLists shield information barrier reports for a specified barrier.
List shield information barrier segment members
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERSLists shield information barrier segment members based on provided segment IDs.
List shield information barrier segment restrictions
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONSLists all shield information barrier segment restrictions for a specific segment.
List shield information barrier segments
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENTSRetrieves a list of shield information barrier segment objects for the specified Information Barrier ID.
List shield information barriers
BOX_LIST_SHIELD_INFORMATION_BARRIERSRetrieves a list of shield information barrier objects for the enterprise of JWT.
List slack integration mappings
BOX_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.
List storage policies
BOX_LIST_STORAGE_POLICIESFetches all the storage policies in the enterprise.
List storage policy assignments
BOX_LIST_STORAGE_POLICY_ASSIGNMENTSFetches all the storage policy assignment for an enterprise or user.
List task assignments
BOX_LIST_TASK_ASSIGNMENTSLists all of the assignments for a given task.
List tasks on file
BOX_LIST_TASKS_ON_FILERetrieves a list of all the tasks for a file.
List teams integration mappings
BOX_LIST_TEAMS_INTEGRATION_MAPPINGSLists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise.
List terms of service user statuses
BOX_LIST_TERMS_OF_SERVICE_USER_STATUSESRetrieves a list of users and their acceptance status for a specific terms of service.
List terms of services
BOX_LIST_TERMS_OF_SERVICESReturns the current terms of service text and settings for the enterprise.
List trashed items
BOX_LIST_TRASHED_ITEMSRetrieves the files and folders that have been moved to the trash.
List upload session parts
BOX_LIST_UPLOAD_SESSION_PARTSList the parts (chunks) that have been uploaded to a chunked upload session.
List user and enterprise events
BOX_LIST_EVENTSReturns up to a year of past events for a given user or for the entire enterprise.
List user's email aliases
BOX_LIST_USER_EMAIL_ALIASESRetrieves all email aliases for a user.
List user's groups
BOX_LIST_USER_GROUPSRetrieves 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
BOX_LIST_USERS_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONSReturns a list of users who have been exempt from the collaboration domain restrictions.
List workflows
BOX_LIST_WORKFLOWSLists Box Relay workflows configured for a specific folder.
Permanently remove file
BOX_DELETE_FILE_PERMANENTLYPermanently deletes a file from the trash.
Permanently remove folder
BOX_DELETE_FOLDER_PERMANENTLYPermanently deletes a folder that is in the trash.
Permanently remove web link
BOX_DELETE_WEB_LINK_PERMANENTLYPermanently deletes a web link that is in the trash.
Preflight check before upload
BOX_PREFLIGHT_CHECK_BEFORE_UPLOADPerforms a preflight check to verify that a file will be accepted by Box before uploading the entire file.
Promote file version
BOX_PROMOTE_FILE_VERSIONPromote a specific version of a file.
Query files folders by metadata
BOX_QUERY_FILES_FOLDERS_BY_METADATAQuery files and folders by metadata using SQL-like syntax.
Refresh access token
BOX_REFRESH_ACCESS_TOKENRefresh an Access Token using its client ID, secret, and refresh token.
Remove box skill cards from file
BOX_DELETE_BOX_SKILL_CARDS_FROM_FILERemoves any Box Skills cards metadata from a file.
Remove collaboration
BOX_DELETE_COLLABORATIONRemoves a collaboration from a file or folder, revoking the collaborator's access.
Remove comment
BOX_DELETE_COMMENTPermanently deletes a comment from a file or folder in Box.
Remove device pin
BOX_DELETE_DEVICE_PINDeletes an individual device pin from the enterprise.
Remove domain from list of allowed collaboration domains
BOX_DELETE_ALLOWED_COLLABORATION_DOMAINRemoves a domain from the list of allowed collaboration domains (whitelist) within your enterprise.
Remove email alias
BOX_DELETE_EMAIL_ALIASRemoves an email alias from a user.
Remove file version
BOX_DELETE_FILE_VERSIONMove a file version to the trash.
Remove group
BOX_DELETE_GROUPPermanently deletes a group.
Remove legal hold policy
BOX_DELETE_LEGAL_HOLD_POLICYPermanently delete an existing legal hold policy from Box.
Remove metadata cascade policy
BOX_DELETE_METADATA_CASCADE_POLICYPermanently deletes a metadata cascade policy from a folder.
Remove metadata instance from file
BOX_DELETE_METADATA_INSTANCE_FROM_FILERemoves a metadata instance from a file.
Remove metadata instance from folder
BOX_DELETE_METADATA_INSTANCE_FROM_FOLDERRemove a metadata instance from a folder.
Remove metadata taxonomy
BOX_DELETE_METADATA_TAXONOMYPermanently deletes a metadata taxonomy from the enterprise.
Remove metadata taxonomy node
BOX_DELETE_METADATA_TAXONOMY_NODEPermanently deletes a metadata taxonomy node from Box.
Remove metadata template
BOX_DELETE_METADATA_TEMPLATEPermanently delete a metadata template and all its instances from files and folders.
Remove retention policy assignment
BOX_DELETE_RETENTION_POLICY_ASSIGNMENTRemoves a retention policy assignment from content in Box.
Remove shared link from file
BOX_DELETE_SHARED_LINK_FROM_FILERemoves a shared link from a file in Box.
Remove shared link from folder
BOX_DELETE_SHARED_LINK_FROM_FOLDERRemoves a shared link from a folder in Box.
Remove shared link from web link
BOX_DELETE_SHARED_LINK_FROM_WEB_LINKRemoves a shared link from a web link in Box.
Remove task
BOX_DELETE_TASKPermanently deletes a task from Box.
Remove upload session
BOX_DELETE_UPLOAD_SESSIONAbort and permanently remove a chunked upload session, discarding all uploaded data.
Remove User Domain Exemption
BOX_DELETE_USER_DOMAIN_EXEMPTIONRemoves a user's exemption from the enterprise's collaboration domain restrictions.
Remove user from group
BOX_DELETE_USER_FROM_GROUPDeletes a specific group membership.
Remove watermark from file
BOX_DELETE_WATERMARK_FROM_FILERemoves the watermark from a file.
Remove watermark from folder
BOX_DELETE_WATERMARK_FROM_FOLDERRemoves the watermark from a folder.
Remove web link
BOX_DELETE_WEB_LINKDeletes a web link.
Remove webhook
BOX_DELETE_WEBHOOKPermanently deletes a webhook from the Box account.
Request access token
BOX_REQUEST_ACCESS_TOKENRequest an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.
Resend Box Sign Request
BOX_RESEND_BOX_SIGN_REQUESTResends signature request emails to all outstanding signers.
Restore file
BOX_RESTORE_FILERestores a file that has been moved to the trash.
Restore file version
BOX_RESTORE_FILE_VERSIONRestores a specific version of a file after it was deleted (trashed).
Restore folder
BOX_RESTORE_FOLDERRestores a folder that has been moved to the trash.
Restore web link
BOX_RESTORE_WEB_LINKRestores a web link that has been moved to the trash.
Review files on legal hold policy assignment
BOX_LIST_FILES_ON_LEGAL_HOLD_POLICY_ASSIGNMENTGet a list of files with current file versions for a legal hold assignment.
Revoke access token
BOX_REVOKE_ACCESS_TOKENRevoke an active Access Token, effectively logging a user out that has been previously authenticated.
Search for content
BOX_SEARCH_FOR_CONTENTSearches for files, folders, web links, and shared files across the users content or across the entire enterprise.
Starts workflow based on request body
BOX_START_WORKFLOWStarts a Box Relay workflow with trigger type WORKFLOWMANUALSTART.
Transfer owned folders
BOX_TRANSFER_OWNED_FOLDERSTransfers all files and folders owned by one user to another user's account in Box.
Trim metadata taxonomy levels
BOX_TRIM_METADATA_TAXONOMY_LEVELSDeletes the last level from a metadata taxonomy by trimming it.
Unassign legal hold policy
BOX_UNASSIGN_LEGAL_HOLD_POLICYRemove a legal hold policy assignment from an item (user, folder, file, or file version).
Unassign storage policy
BOX_DELETE_STORAGE_POLICY_ASSIGNMENTDeletes a storage policy assignment, causing the assigned user to inherit the enterprise's default storage policy (Box Zone).
Unassign task
BOX_DELETE_TASK_ASSIGNMENTDeletes a specific task assignment, removing the task from the assigned user.
Update AI Agent
BOX_UPDATE_AI_AGENTUpdates an existing custom AI agent in Box AI Studio.
Update all box skill cards on file
BOX_UPDATE_ALL_BOX_SKILL_CARDS_ON_FILEAn alternative method to overwrite and update all Box Skill metadata cards on a file.
Update box skill cards on file
BOX_UPDATE_BOX_SKILL_CARDS_ON_FILEUpdates one or more Box Skills metadata cards on a file using JSON-Patch format.
Update collaboration
BOX_UPDATE_COLLABORATIONUpdates a collaboration.
Update comment
BOX_UPDATE_COMMENTUpdate the message of a comment.
Update file
BOX_UPDATE_FILEUpdates a file.
Update file request
BOX_UPDATE_FILE_REQUESTUpdates a file request in Box.
Update folder
BOX_UPDATE_FOLDERUpdates a folder.
Update group
BOX_UPDATE_GROUPUpdates a specific group.
Update group membership
BOX_UPDATE_GROUP_MEMBERSHIPUpdates a user's group membership.
Update legal hold policy
BOX_UPDATE_LEGAL_HOLD_POLICYUpdate an existing legal hold policy in Box.
Update metadata instance on file
BOX_UPDATE_METADATA_INSTANCE_ON_FILEUpdates a metadata instance on a file using JSON-Patch operations.
Update metadata instance on folder
BOX_UPDATE_METADATA_INSTANCE_ON_FOLDERUpdates metadata on a folder using JSON-Patch operations (RFC 6902).
Update metadata taxonomy
BOX_UPDATE_METADATA_TAXONOMYTool to update an existing metadata taxonomy's display name.
Update metadata taxonomy node
BOX_UPDATE_METADATA_TAXONOMY_NODETool to update an existing metadata taxonomy node's display name.
Update metadata template
BOX_UPDATE_METADATA_TEMPLATEUpdates a metadata template by applying JSON-Patch operations.
Update retention policy
BOX_UPDATE_RETENTION_POLICYUpdates an existing Box retention policy.
Update shared link on file
BOX_UPDATE_SHARED_LINK_ON_FILEUpdates a shared link on a file.
Update shared link on folder
BOX_UPDATE_SHARED_LINK_ON_FOLDERUpdates a shared link on a folder.
Update shared link on web link
BOX_UPDATE_SHARED_LINK_ON_WEB_LINKUpdates a shared link on a web link.
Update shield information barrier segment with specified id
BOX_UPDATE_BARRIER_SEGMENTUpdates a shield information barrier segment's name and/or description.
Update slack integration mapping
BOX_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).
Update storage policy assignment
BOX_UPDATE_STORAGE_POLICY_ASSIGNMENTUpdates a storage policy assignment for an enterprise or user.
Update task
BOX_UPDATE_TASKUpdates a task.
Update task assignment
BOX_UPDATE_TASK_ASSIGNMENTUpdates a task assignment to change its resolution state or add a message.
Update teams integration mapping
BOX_UPDATE_TEAMS_INTEGRATION_MAPPINGUpdates a Microsoft Teams integration mapping that links a Box folder to a Teams channel.
Update terms of service
BOX_UPDATE_TERMS_OF_SERVICEUpdates an existing terms of service for the enterprise.
Update terms of service status for existing user
BOX_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.
Update user
BOX_UPDATE_USERUpdates a managed or app user in an enterprise.
Update web link
BOX_UPDATE_WEB_LINKUpdates a web link object.
Update webhook
BOX_UPDATE_WEBHOOKUpdates an existing webhook's configuration.
Upload file
BOX_UPLOAD_FILEUploads a small file to Box.
Upload file version
BOX_UPLOAD_FILE_VERSIONUpdate a file's content.
Upload part of file
BOX_UPLOAD_PART_OF_FILEUploads a chunk of a file for an upload session.
Drop a trigger and an action into a template; approve from your phone; the workflow runs.