Box Integration
Box API Operations
Browse all 286 operations available for Box workflow automation.
legal
286 operationsBOX_ADD_CLASSIFICATION_TO_FILEAdd classification to file
Adds a classification to a file by specifying the label of the classification to add.
BOX_ADD_CLASSIFICATION_TO_FOLDERAdd classification to folder
Adds a classification to a folder by specifying the label of the classification to add.
BOX_ADD_ALLOWED_COLLABORATION_DOMAINAdd domain to list of allowed collaboration domains
Creates a new entry in the list of allowed domains for collaboration within your enterprise.
BOX_ADD_INITIAL_CLASSIFICATIONSAdd initial classifications
Initializes the classification template for an enterprise with an initial set of classification options.
BOX_ADD_OR_UPDATE_USER_AVATARAdd or update user avatar
Adds or updates a user avatar.
BOX_ADD_SHARED_LINK_TO_FILEAdd shared link to file
Adds a shared link to a file.
BOX_ADD_SHARED_LINK_TO_FOLDERAdd shared link to folder
Adds a shared link to a folder, allowing it to be shared with others via a URL.
BOX_ADD_SHARED_LINK_TO_WEB_LINKAdd shared link to web link
Adds a shared link to a web link.
BOX_ADD_USER_TO_GROUPAdd user to group
Creates a group membership.
BOX_APPEND_METADATA_TAXONOMY_LEVELAppend metadata taxonomy level
Appends a new level to a metadata taxonomy structure.
BOX_APPLY_WATERMARK_TO_FILEApply watermark to file
Applies or update a watermark on a file.
BOX_APPLY_WATERMARK_TO_FOLDERApply watermark to folder
Applies or update a watermark on a folder.
BOX_ASK_QUESTIONAsk question
Ask questions about Box files using Box AI.
BOX_ASSIGN_LEGAL_HOLD_POLICYAssign legal hold policy
Assign a legal hold policy to a file, file version, folder, or user.
BOX_ASSIGN_RETENTION_POLICYAssign retention policy
Assigns a retention policy to an item in Box to enforce content retention.
BOX_ASSIGN_STORAGE_POLICYAssign storage policy
Creates a storage policy assignment for an enterprise or user.
BOX_ASSIGN_TASKAssign task
Assigns a task to a user.
BOX_AUTHORIZE_USERAuthorize user
Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf.
BOX_CANCEL_BOX_SIGN_REQUESTCancel box sign request
Cancels a pending Box Sign request that has not yet been fully signed or declined.
BOX_UPDATE_SHIELD_INFORMATION_BARRIER_STATUSChange shield information barrier status
Change the status of a shield information barrier.
BOX_COMMIT_UPLOAD_SESSIONCommit upload session
Commits an upload session and creates a file from the uploaded chunks.
BOX_COPY_FILECopy file
Creates a copy of a file.
BOX_COPY_FILE_REQUESTCopy file request
Copies an existing file request to a new folder.
BOX_COPY_FOLDERCopy folder
Creates a copy of a folder within a destination folder.
BOX_CREATE_AI_AGENTCreate AI Agent
Creates a custom AI agent in Box AI Studio.
BOX_CREATE_BOX_SIGN_REQUESTCreate Box Sign Request
Creates a Box Sign request to send documents for electronic signing.
BOX_CREATE_TEAMS_INTEGRATION_MAPPINGCreate Teams integration mapping
Creates a Microsoft Teams integration mapping that links a Teams channel or team to a Box folder.
BOX_CREATE_BOX_SKILL_CARDS_ON_FILECreate box skill cards on file
Applies one or more Box Skills metadata cards to a file.
BOX_CREATE_COLLABORATIONCreate collaboration
Adds a collaboration for a single user or a single group to a file or folder.
BOX_CREATE_COMMENTCreate comment
Adds a comment by the user to a specific file, or as a reply to an other comment.
BOX_CREATE_EMAIL_ALIASCreate email alias
Adds a new email alias to a user account.
BOX_CREATE_FOLDERCreate folder
Creates a new empty folder within the specified parent folder.
BOX_CREATE_FOLDER_LOCKCreate folder lock
Creates a folder lock on a folder, preventing it from being moved and/or deleted.
BOX_CREATE_GROUPCreate group
Creates a new group of users in an enterprise.
BOX_TERMINATE_USER_GROUP_SESSIONSCreate jobs to terminate user group session
Terminates all active sessions for users belonging to the specified Box enterprise groups.
BOX_TERMINATE_USER_SESSIONSCreate jobs to terminate users session
Creates asynchronous jobs to terminate active Box sessions for specified users.
BOX_CREATE_LEGAL_HOLD_POLICYCreate legal hold policy
Create a new legal hold policy in Box.
BOX_CREATE_METADATA_CASCADE_POLICYCreate metadata cascade policy
Creates a new metadata cascade policy that automatically applies a metadata template to all files and subfolders within a specified folder.
BOX_CREATE_METADATA_INSTANCE_ON_FILECreate metadata instance on file
Applies an instance of a metadata template to a file.
BOX_CREATE_METADATA_INSTANCE_ON_FOLDERCreate metadata instance on folder
Applies an instance of a metadata template to a folder.
BOX_CREATE_METADATA_TAXONOMYCreate metadata taxonomy
Tool to create a new metadata taxonomy in Box.
BOX_CREATE_METADATA_TAXONOMY_LEVELSCreate metadata taxonomy levels
Creates new hierarchical levels for a metadata taxonomy in Box.
BOX_CREATE_METADATA_TAXONOMY_NODECreate metadata taxonomy node
Tool to create a new metadata taxonomy node within a specified taxonomy.
BOX_CREATE_METADATA_TEMPLATECreate metadata template
Creates a new metadata template that can be applied to files and folders.
BOX_CREATE_RETENTION_POLICYCreate retention policy
Creates a retention policy for managing content lifecycle in Box.
BOX_CREATE_SHIELD_INFORMATION_BARRIERCreate shield information barrier
Creates a shield information barrier to establish an "ethical wall" that separates individuals/groups within an enterprise and prevents confidential…
BOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORTCreate shield information barrier report
Creates a shield information barrier report for a given barrier.
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENTCreate shield information barrier segment
Creates a new shield information barrier segment for compliance and information isolation.
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERCreate shield information barrier segment member
Adds a Box user to a shield information barrier segment for compliance and information security.
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONCreate shield information barrier segment restriction
Creates a ONE-WAY shield information barrier segment restriction preventing collaboration between members of two segments (e.g., Investment Banking cannot…
BOX_CREATE_SLACK_INTEGRATION_MAPPINGCreate slack integration mapping
Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack channel to…
BOX_CREATE_TASKCreate task
Creates a single task on a file.
BOX_CREATE_TERMS_OF_SERVICECreate terms of service
Creates a terms of service for a given enterprise and type of user.
BOX_CREATE_TERMS_OF_SERVICE_STATUS_FOR_NEW_USERCreate 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.
BOX_CREATE_UPLOAD_SESSIONCreate upload session
Creates an upload session for chunked upload of large files (20MB+).
BOX_CREATE_UPLOAD_SESSION_FOR_EXISTING_FILECreate upload session for existing file
Creates an upload session for uploading a new version of an existing file using chunked upload.
BOX_CREATE_USERCreate user
Creates a new managed user in an enterprise.
BOX_CREATE_COLLAB_EXEMPTIONCreate user exemption from collaboration domain restrictions
Exempts a specific user from the enterprise's collaboration domain restrictions.
BOX_CREATE_USER_INVITECreate user invite
Invites an existing external user to join an enterprise.
BOX_CREATE_WEB_LINKCreate web link
Creates a web link object within a folder.
BOX_CREATE_WEBHOOKCreate webhook
Creates a webhook to monitor a file or folder for specific events.
BOX_CREATE_ZIP_DOWNLOADCreate zip download
Creates a request to download multiple files and folders as a single zip archive file.
BOX_DELETE_AI_AGENTDelete AI Agent
Permanently deletes a custom AI agent from Box AI Studio.
BOX_DELETE_SLACK_INTEGRATION_MAPPINGDelete Slack integration mapping
Deletes a Slack integration mapping that links a Box folder to a Slack channel.
BOX_DELETE_FILEDelete file
Deletes a file from Box by moving it to trash or permanently (based on enterprise settings).
BOX_DELETE_FILE_REQUESTDelete file request
Deletes a file request permanently.
BOX_DELETE_FOLDERDelete folder
Deletes a folder, either permanently or by moving it to the trash.
BOX_DELETE_FOLDER_LOCKDelete folder lock
Deletes a folder lock on a given folder, removing restrictions on move and delete operations.
BOX_DELETE_RETENTION_POLICYDelete retention policy
Permanently deletes a retention policy from the Box enterprise.
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENTDelete shield information barrier segment
Permanently deletes a shield information barrier segment by its ID.
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_IDDelete shield information barrier segment member by id
Removes a user from a shield information barrier segment by deleting their membership.
BOX_DELETE_BARRIER_RESTRICTIONDelete shield information barrier segment restriction by id
Deletes a shield information barrier segment restriction by its unique ID.
BOX_DELETE_TEAMS_INTEGRATION_MAPPINGDelete teams integration mapping
Deletes a Microsoft Teams integration mapping that links a Box folder to a Teams channel.
BOX_DELETE_USERDelete user
Permanently deletes a user from the enterprise.
BOX_DELETE_USER_AVATARDelete user avatar
Deletes a user's custom avatar image from Box.
BOX_DOWNLOAD_FILEDownload file
Returns the contents of a file in binary format.
BOX_DOWNLOAD_ZIP_ARCHIVEDownload zip archive
Downloads a zip archive containing files and/or folders from Box.
BOX_EXTRACT_METADATA_FREEFORMExtract metadata freeform
Extract metadata from Box files using AI with freeform prompts.
BOX_EXTRACT_METADATA_STRUCTUREDExtract metadata structured
Extract structured metadata from files using Box AI.
BOX_FIND_FILE_FOR_SHARED_LINKFind file for shared link
Returns the file represented by a shared link.
BOX_FIND_FOLDER_FOR_SHARED_LINKFind folder for shared link
Return the folder represented by a shared link.
BOX_FIND_APP_ITEM_FOR_SHARED_LINKFind item for shared link
Returns the file, folder, web link, or app item represented by a shared link.
BOX_FIND_METADATA_TEMPLATE_BY_INSTANCE_IDFind metadata template by instance id
Finds a metadata template by searching for the ID of an instance of the template.
BOX_FORCE_APPLY_METADATA_CASCADE_POLICY_TO_FOLDERForce 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.
BOX_GENERATE_TEXTGenerate text
Generate text using Box AI based on a prompt and file context.
BOX_GET_AI_AGENTGet AI Agent by ID
Retrieves detailed information about a specific AI Agent by its unique identifier.
BOX_GET_BOX_SIGN_TEMPLATEGet Box Sign Template by ID
Retrieves details of a specific Box Sign template by its unique ID.
BOX_GET_EVENTS_LONG_POLL_ENDPOINTGet Real-Time Server URL for Long-Polling Events
Returns a list of real-time servers that can be used for long-polling user events.
BOX_GET_AI_AGENT_DEFAULT_CONFIGURATIONGet ai agent default configuration
Retrieve the default AI agent configuration for a specific mode.
BOX_GET_ALLOWED_COLLABORATION_DOMAINGet allowed collaboration domain
Retrieves details of a specific allowed collaboration domain entry within your enterprise.
BOX_GET_BOX_SIGN_REQUESTGet box sign request by id
Retrieves the details of a specific Box Sign request by its unique ID.
BOX_GET_COLLABORATIONGet collaboration
Retrieves details of a single collaboration by its ID.
BOX_GET_COLLECTIONGet collection by id
Retrieves details of a specific collection by its unique identifier.
BOX_GET_COMMENTGet comment
Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.
BOX_GET_CURRENT_USERGet current user
Retrieves information about the user who is currently authenticated.
BOX_GET_DEVICE_PINGet device pin
Retrieves information about an individual device pin in the enterprise.
BOX_GET_FILE_INFORMATIONGet file information
Retrieves the details about a file.
BOX_GET_FILE_REQUESTGet file request
Retrieves detailed information about a file request in Box.
BOX_GET_FILE_THUMBNAILGet file thumbnail
Retrieves a thumbnail, or smaller image representation, of a file.
BOX_GET_FILE_VERSIONGet file version
Retrieve detailed information about a specific version of a file.
BOX_GET_FILE_VERSION_LEGAL_HOLDGet file version legal hold
Retrieves detailed information about a specific file version legal hold by its ID.
BOX_GET_FILE_VERSIONS_UNDER_RETENTIONGet file versions under retention
Returns a list of file versions under retention for a specified retention policy assignment.
BOX_GET_FILES_UNDER_RETENTIONGet files under retention
Returns a paginated list of files under retention for a specific retention policy assignment.
BOX_GET_FOLDERGet folder information
Retrieves details for a folder, including the first 100 entries in the folder.
BOX_GET_GROUPGet group
Retrieves information about a group.
BOX_GET_GROUP_MEMBERSHIPGet group membership
Retrieves a specific group membership.
BOX_GET_LEGAL_HOLD_POLICYGet legal hold policy
Retrieve detailed information about a specific legal hold policy by its ID.
BOX_GET_LEGAL_HOLD_POLICY_ASSIGNMENTGet legal hold policy assignment
Retrieves detailed information about a specific legal hold policy assignment by its ID.
BOX_GET_METADATA_CASCADE_POLICYGet metadata cascade policy
Retrieve a specific metadata cascade policy assigned to a folder.
BOX_GET_METADATA_INSTANCE_ON_FILEGet metadata instance on file
Retrieves a specific metadata template instance that has been applied to a file.
BOX_GET_METADATA_INSTANCE_ON_FOLDERGet metadata instance on folder
Retrieves the instance of a metadata template that has been applied to a folder.
BOX_GET_METADATA_TAXONOMIES_FOR_NAMESPACEGet metadata taxonomies for namespace
Retrieves all metadata taxonomies within a specific namespace.
BOX_GET_METADATA_TAXONOMY_BY_TAXONOMY_KEYGet metadata taxonomy by taxonomy key
Retrieves a metadata taxonomy by its namespace and taxonomy key.
BOX_GET_METADATA_TAXONOMY_NODE_BY_IDGet metadata taxonomy node by ID
Retrieves a specific node from a metadata taxonomy by its identifier.
BOX_GET_METADATA_TEMPLATE_BY_IDGet metadata template by id
Retrieves a metadata template by its ID.
BOX_GET_METADATA_TEMPLATE_BY_NAMEGet metadata template by name
Retrieves a metadata template by its scope and templateKey values.
BOX_GET_RETENTION_ON_FILEGet retention on file
Returns information about a file version retention.
BOX_GET_RETENTION_POLICYGet retention policy
Retrieves a retention policy by its unique ID.
BOX_GET_RETENTION_POLICY_ASSIGNMENTGet retention policy assignment
Retrieves a retention policy assignment by its unique ID.
BOX_GET_SHARED_WEB_LINKGet shared items web links
Tool to retrieve web link information for a shared link.
BOX_GET_SHARED_LINK_FOR_FILEGet shared link for file
Retrieves the shared link information for a file.
BOX_GET_SHARED_LINK_FOR_FOLDERGet shared link for folder
Retrieves shared link information for a folder.
BOX_GET_SHIELD_INFORMATION_BARRIER_REPORT_BY_IDGet shield information barrier report by id
Retrieves a shield information barrier report by its ID.
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_IDGet shield information barrier segment member by id
Retrieves a shield information barrier segment member by its unique ID.
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_IDGet shield information barrier segment restriction by id
Retrieves a shield information barrier segment restriction by its unique ID.
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_BY_IDGet shield information barrier segment with specified id
Retrieves a shield information barrier segment by its unique identifier.
BOX_GET_SHIELD_INFORMATION_BARRIER_BY_IDGet shield information barrier with specified id
Retrieves a shield information barrier by its unique ID.
BOX_GET_STORAGE_POLICYGet storage policy
Fetches a specific storage policy by its ID.
BOX_GET_STORAGE_POLICY_ASSIGNMENTGet storage policy assignment
Retrieves information about a specific storage policy assignment.
BOX_GET_TASKGet task
Retrieves detailed information about a specific task in Box.
BOX_GET_TASK_ASSIGNMENTGet task assignment
Retrieves detailed information about a specific task assignment in Box.
BOX_GET_TERMS_OF_SERVICEGet terms of service
Retrieves a specific terms of service by its unique identifier.
BOX_GET_TRASHED_FILEGet trashed file
Retrieves a file that has been moved to the trash.
BOX_GET_TRASHED_FOLDERGet trashed folder
Retrieves a folder that has been moved to the trash.
BOX_GET_TRASHED_WEB_LINKGet trashed web link
Retrieves a web link that has been moved to the trash.
BOX_GET_UPLOAD_SESSIONGet upload session
Retrieves detailed information about an existing chunked upload session.
BOX_GET_USERGet user
Retrieves information about a user in the enterprise.
BOX_GET_USER_AVATARGet user avatar
Retrieves the avatar image of a Box user.
BOX_GET_USER_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONSGet user exempt from collaboration domain restrictions
Retrieves details of a specific user exemption from collaboration domain restrictions.
BOX_GET_USER_INVITE_STATUSGet user invite status
Returns the status of a user invite.
BOX_GET_WATERMARK_ON_FOLDERGet watermark for folder
Retrieve the watermark for a folder.
BOX_GET_WATERMARK_ON_FILEGet watermark on file
Retrieve the watermark for a file.
BOX_GET_WEB_LINKGet web link
Retrieve detailed information about a web link (bookmark) in Box.
BOX_GET_WEBHOOKGet webhook
Retrieves detailed information about a specific webhook by its ID.
BOX_GET_ZIP_DOWNLOAD_STATUSGet zip download status
Get the download status of a zip archive, including progress, skipped items, and current state.
BOX_LIST_HUBSList Box Hubs
Tool to list all Box Hubs for the authenticated user or enterprise.
BOX_LIST_AI_AGENTSList ai agents
Lists AI agents based on the provided parameters.
BOX_LIST_ALL_CLASSIFICATIONSList all classifications
Retrieves the classification metadata template and lists all the classifications available to this enterprise.
BOX_LIST_ALL_COLLECTIONSList all collections
Retrieves all collections for a given user.
BOX_LIST_ALL_FILE_VERSIONSList all file versions
Retrieve a list of the past versions for a file.
BOX_LIST_ALL_GLOBAL_METADATA_TEMPLATESList all global metadata templates
Used to retrieve all generic, global metadata templates available to all enterprises using Box.
BOX_LIST_LEGAL_HOLD_POLICIESList all legal hold policies
Retrieves a list of legal hold policies that belong to an enterprise.
BOX_LIST_ENTERPRISE_METADATA_TEMPLATESList all metadata templates for enterprise
Used to retrieve all metadata templates created to be used specifically within the user's enterprise
BOX_LIST_WEBHOOKSList all webhooks
Returns all defined webhooks for the requesting application.
BOX_LIST_ALLOWED_COLLABORATION_DOMAINSList allowed collaboration domains
Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.
BOX_LIST_BOX_SIGN_REQUESTSList box sign requests
Gets signature requests created by a user.
BOX_LIST_BOX_SIGN_TEMPLATESList box sign templates
Gets Box Sign templates created by a user.
BOX_LIST_BOX_SKILL_CARDS_ON_FILEList box skill cards on file
List the Box Skills metadata cards that are attached to a file.
BOX_LIST_COLLECTION_ITEMSList collection items
Retrieves the files and/or folders contained within a Box collection.
BOX_LIST_ENTERPRISE_DEVICE_PINSList enterprise device pins
Retrieves all the device pins within an enterprise.
BOX_LIST_ENTERPRISE_USERSList enterprise users
Returns a list of all users for the Enterprise along with their userid, publicname, and login.
BOX_LIST_FILE_APP_ITEM_ASSOCIATIONSList file app item associations
This is a beta feature, which means that its availability might be limited.
BOX_LIST_FILE_COLLABORATIONSList file collaborations
Retrieves a list of pending and active collaborations for a file.
BOX_LIST_FILE_COMMENTSList file comments
Retrieves a list of comments for a file.
BOX_LIST_FILE_VERSION_LEGAL_HOLDSList file version legal holds
Get a list of file versions on legal hold for a legal hold assignment.
BOX_LIST_FILE_VERSION_RETENTIONSList file version retentions
Retrieves all file version retentions for the given enterprise.
BOX_LIST_FOLDER_APP_ITEM_ASSOCIATIONSList folder app item associations
This is a beta feature, which means that its availability might be limited.
BOX_LIST_FOLDER_COLLABORATIONSList folder collaborations
Retrieves a list of pending and active collaborations for a folder.
BOX_LIST_FOLDER_LOCKSList folder locks
Retrieves folder lock details for a given folder.
BOX_LIST_GROUP_COLLABORATIONSList group collaborations
Retrieves all the collaborations for a group.
BOX_LIST_ENTERPRISE_GROUPSList groups for enterprise
Retrieves all of the groups for a given enterprise.
BOX_LIST_ITEMS_IN_FOLDERList items in folder
Retrieves a page of items in a folder.
BOX_LIST_LEGAL_HOLD_POLICY_ASSIGNMENTSList legal hold policy assignments
Retrieves a list of items a legal hold policy has been assigned to.
BOX_LIST_GROUP_MEMBERSList members of group
Retrieves all the members for a group.
BOX_LIST_METADATA_CASCADE_POLICIESList metadata cascade policies
Retrieves a list of all the metadata cascade policies that are applied to a given folder.
BOX_LIST_METADATA_INSTANCES_ON_FILEList metadata instances on file
Retrieves all metadata instances applied to a file.
BOX_LIST_METADATA_INSTANCES_ON_FOLDERList metadata instances on folder
Retrieves all metadata for a given folder.
BOX_LIST_METADATA_TAXONOMY_NODESList metadata taxonomy nodes
Retrieves metadata taxonomy nodes based on the specified parameters.
BOX_LIST_PENDING_COLLABORATIONSList pending collaborations
Retrieves all pending collaboration invites for this user.
BOX_LIST_HOLD_FILE_VERSIONSList previous file versions for legal hold policy assignment
Retrieves a list of previous (non-current) file versions that are on legal hold for a specific legal hold policy assignment.
BOX_LIST_RECENTLY_ACCESSED_ITEMSList 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.
BOX_LIST_RETENTION_POLICIESList retention policies
Retrieves all of the retention policies for an enterprise.
BOX_LIST_RETENTION_POLICY_ASSIGNMENTSList retention policy assignments
Retrieves all retention policy assignments for a specified retention policy.
BOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTSList shield information barrier reports
Lists shield information barrier reports for a specified barrier.
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERSList shield information barrier segment members
Lists shield information barrier segment members based on provided segment IDs.
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONSList shield information barrier segment restrictions
Lists all shield information barrier segment restrictions for a specific segment.
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENTSList shield information barrier segments
Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.
BOX_LIST_SHIELD_INFORMATION_BARRIERSList shield information barriers
Retrieves a list of shield information barrier objects for the enterprise of JWT.
BOX_LIST_SLACK_INTEGRATION_MAPPINGSList 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.
BOX_LIST_STORAGE_POLICIESList storage policies
Fetches all the storage policies in the enterprise.
BOX_LIST_STORAGE_POLICY_ASSIGNMENTSList storage policy assignments
Fetches all the storage policy assignment for an enterprise or user.
BOX_LIST_TASK_ASSIGNMENTSList task assignments
Lists all of the assignments for a given task.
BOX_LIST_TASKS_ON_FILEList tasks on file
Retrieves a list of all the tasks for a file.
BOX_LIST_TEAMS_INTEGRATION_MAPPINGSList teams integration mappings
Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise.
BOX_LIST_TERMS_OF_SERVICE_USER_STATUSESList terms of service user statuses
Retrieves a list of users and their acceptance status for a specific terms of service.
BOX_LIST_TERMS_OF_SERVICESList terms of services
Returns the current terms of service text and settings for the enterprise.
BOX_LIST_TRASHED_ITEMSList trashed items
Retrieves the files and folders that have been moved to the trash.
BOX_LIST_UPLOAD_SESSION_PARTSList upload session parts
List the parts (chunks) that have been uploaded to a chunked upload session.
BOX_LIST_EVENTSList user and enterprise events
Returns up to a year of past events for a given user or for the entire enterprise.
BOX_LIST_USER_EMAIL_ALIASESList user's email aliases
Retrieves all email aliases for a user.
BOX_LIST_USER_GROUPSList user's groups
Retrieves all group memberships for a user, including the groups they belong to and their role in each group (member or admin).
BOX_LIST_USERS_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONSList users exempt from collaboration domain restrictions
Returns a list of users who have been exempt from the collaboration domain restrictions.
BOX_LIST_WORKFLOWSList workflows
Lists Box Relay workflows configured for a specific folder.
BOX_DELETE_FILE_PERMANENTLYPermanently remove file
Permanently deletes a file from the trash.
BOX_DELETE_FOLDER_PERMANENTLYPermanently remove folder
Permanently deletes a folder that is in the trash.
BOX_DELETE_WEB_LINK_PERMANENTLYPermanently remove web link
Permanently deletes a web link that is in the trash.
BOX_PREFLIGHT_CHECK_BEFORE_UPLOADPreflight check before upload
Performs a preflight check to verify that a file will be accepted by Box before uploading the entire file.
BOX_PROMOTE_FILE_VERSIONPromote file version
Promote a specific version of a file.
BOX_QUERY_FILES_FOLDERS_BY_METADATAQuery files folders by metadata
Query files and folders by metadata using SQL-like syntax.
BOX_REFRESH_ACCESS_TOKENRefresh access token
Refresh an Access Token using its client ID, secret, and refresh token.
BOX_DELETE_USER_DOMAIN_EXEMPTIONRemove User Domain Exemption
Removes a user's exemption from the enterprise's collaboration domain restrictions.
BOX_DELETE_BOX_SKILL_CARDS_FROM_FILERemove box skill cards from file
Removes any Box Skills cards metadata from a file.
BOX_DELETE_COLLABORATIONRemove collaboration
Removes a collaboration from a file or folder, revoking the collaborator's access.
BOX_DELETE_COMMENTRemove comment
Permanently deletes a comment from a file or folder in Box.
BOX_DELETE_DEVICE_PINRemove device pin
Deletes an individual device pin from the enterprise.
BOX_DELETE_ALLOWED_COLLABORATION_DOMAINRemove domain from list of allowed collaboration domains
Removes a domain from the list of allowed collaboration domains (whitelist) within your enterprise.
BOX_DELETE_EMAIL_ALIASRemove email alias
Removes an email alias from a user.
BOX_DELETE_FILE_VERSIONRemove file version
Move a file version to the trash.
BOX_DELETE_GROUPRemove group
Permanently deletes a group.
BOX_DELETE_LEGAL_HOLD_POLICYRemove legal hold policy
Permanently delete an existing legal hold policy from Box.
BOX_DELETE_METADATA_CASCADE_POLICYRemove metadata cascade policy
Permanently deletes a metadata cascade policy from a folder.
BOX_DELETE_METADATA_INSTANCE_FROM_FILERemove metadata instance from file
Removes a metadata instance from a file.
BOX_DELETE_METADATA_INSTANCE_FROM_FOLDERRemove metadata instance from folder
Remove a metadata instance from a folder.
BOX_DELETE_METADATA_TAXONOMYRemove metadata taxonomy
Permanently deletes a metadata taxonomy from the enterprise.
BOX_DELETE_METADATA_TAXONOMY_NODERemove metadata taxonomy node
Permanently deletes a metadata taxonomy node from Box.
BOX_DELETE_METADATA_TEMPLATERemove metadata template
Permanently delete a metadata template and all its instances from files and folders.
BOX_DELETE_RETENTION_POLICY_ASSIGNMENTRemove retention policy assignment
Removes a retention policy assignment from content in Box.
BOX_DELETE_SHARED_LINK_FROM_FILERemove shared link from file
Removes a shared link from a file in Box.
BOX_DELETE_SHARED_LINK_FROM_FOLDERRemove shared link from folder
Removes a shared link from a folder in Box.
BOX_DELETE_SHARED_LINK_FROM_WEB_LINKRemove shared link from web link
Removes a shared link from a web link in Box.
BOX_DELETE_TASKRemove task
Permanently deletes a task from Box.
BOX_DELETE_UPLOAD_SESSIONRemove upload session
Abort and permanently remove a chunked upload session, discarding all uploaded data.
BOX_DELETE_USER_FROM_GROUPRemove user from group
Deletes a specific group membership.
BOX_DELETE_WATERMARK_FROM_FILERemove watermark from file
Removes the watermark from a file.
BOX_DELETE_WATERMARK_FROM_FOLDERRemove watermark from folder
Removes the watermark from a folder.
BOX_DELETE_WEB_LINKRemove web link
Deletes a web link.
BOX_DELETE_WEBHOOKRemove webhook
Permanently deletes a webhook from the Box account.
BOX_REQUEST_ACCESS_TOKENRequest access token
Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.
BOX_RESEND_BOX_SIGN_REQUESTResend Box Sign Request
Resends signature request emails to all outstanding signers.
BOX_RESTORE_FILERestore file
Restores a file that has been moved to the trash.
BOX_RESTORE_FILE_VERSIONRestore file version
Restores a specific version of a file after it was deleted (trashed).
BOX_RESTORE_FOLDERRestore folder
Restores a folder that has been moved to the trash.
BOX_RESTORE_WEB_LINKRestore web link
Restores a web link that has been moved to the trash.
BOX_LIST_FILES_ON_LEGAL_HOLD_POLICY_ASSIGNMENTReview files on legal hold policy assignment
Get a list of files with current file versions for a legal hold assignment.
BOX_REVOKE_ACCESS_TOKENRevoke access token
Revoke an active Access Token, effectively logging a user out that has been previously authenticated.
BOX_SEARCH_FOR_CONTENTSearch for content
Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.
BOX_START_WORKFLOWStarts workflow based on request body
Starts a Box Relay workflow with trigger type WORKFLOWMANUALSTART.
BOX_TRANSFER_OWNED_FOLDERSTransfer owned folders
Transfers all files and folders owned by one user to another user's account in Box.
BOX_TRIM_METADATA_TAXONOMY_LEVELSTrim metadata taxonomy levels
Deletes the last level from a metadata taxonomy by trimming it.
BOX_UNASSIGN_LEGAL_HOLD_POLICYUnassign legal hold policy
Remove a legal hold policy assignment from an item (user, folder, file, or file version).
BOX_DELETE_STORAGE_POLICY_ASSIGNMENTUnassign storage policy
Deletes a storage policy assignment, causing the assigned user to inherit the enterprise's default storage policy (Box Zone).
BOX_DELETE_TASK_ASSIGNMENTUnassign task
Deletes a specific task assignment, removing the task from the assigned user.
BOX_UPDATE_AI_AGENTUpdate AI Agent
Updates an existing custom AI agent in Box AI Studio.
BOX_UPDATE_ALL_BOX_SKILL_CARDS_ON_FILEUpdate all box skill cards on file
An alternative method to overwrite and update all Box Skill metadata cards on a file.
BOX_UPDATE_BOX_SKILL_CARDS_ON_FILEUpdate box skill cards on file
Updates one or more Box Skills metadata cards on a file using JSON-Patch format.
BOX_UPDATE_COLLABORATIONUpdate collaboration
Updates a collaboration.
BOX_UPDATE_COMMENTUpdate comment
Update the message of a comment.
BOX_UPDATE_FILEUpdate file
Updates a file.
BOX_UPDATE_FILE_REQUESTUpdate file request
Updates a file request in Box.
BOX_UPDATE_FOLDERUpdate folder
Updates a folder.
BOX_UPDATE_GROUPUpdate group
Updates a specific group.
BOX_UPDATE_GROUP_MEMBERSHIPUpdate group membership
Updates a user's group membership.
BOX_UPDATE_LEGAL_HOLD_POLICYUpdate legal hold policy
Update an existing legal hold policy in Box.
BOX_UPDATE_METADATA_INSTANCE_ON_FILEUpdate metadata instance on file
Updates a metadata instance on a file using JSON-Patch operations.
BOX_UPDATE_METADATA_INSTANCE_ON_FOLDERUpdate metadata instance on folder
Updates metadata on a folder using JSON-Patch operations (RFC 6902).
BOX_UPDATE_METADATA_TAXONOMYUpdate metadata taxonomy
Tool to update an existing metadata taxonomy's display name.
BOX_UPDATE_METADATA_TAXONOMY_NODEUpdate metadata taxonomy node
Tool to update an existing metadata taxonomy node's display name.
BOX_UPDATE_METADATA_TEMPLATEUpdate metadata template
Updates a metadata template by applying JSON-Patch operations.
BOX_UPDATE_RETENTION_POLICYUpdate retention policy
Updates an existing Box retention policy.
BOX_UPDATE_SHARED_LINK_ON_FILEUpdate shared link on file
Updates a shared link on a file.
BOX_UPDATE_SHARED_LINK_ON_FOLDERUpdate shared link on folder
Updates a shared link on a folder.
BOX_UPDATE_SHARED_LINK_ON_WEB_LINKUpdate shared link on web link
Updates a shared link on a web link.
BOX_UPDATE_BARRIER_SEGMENTUpdate shield information barrier segment with specified id
Updates a shield information barrier segment's name and/or description.
BOX_UPDATE_SLACK_INTEGRATION_MAPPINGUpdate 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).
BOX_UPDATE_STORAGE_POLICY_ASSIGNMENTUpdate storage policy assignment
Updates a storage policy assignment for an enterprise or user.
BOX_UPDATE_TASKUpdate task
Updates a task.
BOX_UPDATE_TASK_ASSIGNMENTUpdate task assignment
Updates a task assignment to change its resolution state or add a message.
BOX_UPDATE_TEAMS_INTEGRATION_MAPPINGUpdate teams integration mapping
Updates a Microsoft Teams integration mapping that links a Box folder to a Teams channel.
BOX_UPDATE_TERMS_OF_SERVICEUpdate terms of service
Updates an existing terms of service for the enterprise.
BOX_UPDATE_TERMS_OF_SERVICE_STATUS_FOR_EXISTING_USERUpdate 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.
BOX_UPDATE_USERUpdate user
Updates a managed or app user in an enterprise.
BOX_UPDATE_WEB_LINKUpdate web link
Updates a web link object.
BOX_UPDATE_WEBHOOKUpdate webhook
Updates an existing webhook's configuration.
BOX_UPLOAD_FILEUpload file
Uploads a small file to Box.
BOX_UPLOAD_FILE_VERSIONUpload file version
Update a file's content.
BOX_UPLOAD_PART_OF_FILEUpload part of file
Uploads a chunk of a file for an upload session.