Docs
Tool Router
Toolkits
Reference
Examples
Search
⌘
K
Dashboard
All Toolkits
Box
BOX
Latest version
20251229_00
Cloud content management and file sharing service for businesses.
Try Box
Authentication guide
Auth:
OAUTH2
Tools (273)
Add classification to file
BOX_ADD_CLASSIFICATION_TO_FILE
Add classification to folder
BOX_ADD_CLASSIFICATION_TO_FOLDER
Add domain to list of allowed collaboration domains
BOX_ADD_DOMAIN_TO_LIST_OF_ALLOWED_COLLABORATION_DOMAINS
Add initial classifications
BOX_ADD_INITIAL_CLASSIFICATIONS
Add or update user avatar
BOX_ADD_OR_UPDATE_USER_AVATAR
Add shared link to file
BOX_ADD_SHARED_LINK_TO_FILE
Add shared link to folder
BOX_ADD_SHARED_LINK_TO_FOLDER
Add shared link to web link
BOX_ADD_SHARED_LINK_TO_WEB_LINK
Add user to group
BOX_ADD_USER_TO_GROUP
Apply watermark to file
BOX_APPLY_WATERMARK_TO_FILE
Apply watermark to folder
BOX_APPLY_WATERMARK_TO_FOLDER
Ask question
BOX_ASK_QUESTION
Assign legal hold policy
BOX_ASSIGN_LEGAL_HOLD_POLICY
Assign retention policy
BOX_ASSIGN_RETENTION_POLICY
Assign storage policy
BOX_ASSIGN_STORAGE_POLICY
Assign task
BOX_ASSIGN_TASK
Authorize user
BOX_AUTHORIZE_USER
Cancel box sign request
BOX_CANCEL_BOX_SIGN_REQUEST
Change shield information barrier status
BOX_CHANGE_SHIELD_INFORMATION_BARRIER_STATUS
Commit upload session
BOX_COMMIT_UPLOAD_SESSION
Copy file
BOX_COPY_FILE
Copy file request
BOX_COPY_FILE_REQUEST
Copy folder
BOX_COPY_FOLDER
Create ai agent
BOX_CREATE_AI_AGENT
Create box sign request
BOX_CREATE_BOX_SIGN_REQUEST
Create box skill cards on file
BOX_CREATE_BOX_SKILL_CARDS_ON_FILE
Create collaboration
BOX_CREATE_COLLABORATION
Create comment
BOX_CREATE_COMMENT
Create email alias
BOX_CREATE_EMAIL_ALIAS
Create folder
BOX_CREATE_FOLDER
Create folder lock
BOX_CREATE_FOLDER_LOCK
Create group
BOX_CREATE_GROUP
Create jobs to terminate user group session
BOX_CREATE_JOBS_TO_TERMINATE_USER_GROUP_SESSION
Create jobs to terminate users session
BOX_CREATE_JOBS_TO_TERMINATE_USERS_SESSION
Create legal hold policy
BOX_CREATE_LEGAL_HOLD_POLICY
Create metadata cascade policy
BOX_CREATE_METADATA_CASCADE_POLICY
Create metadata instance on file
BOX_CREATE_METADATA_INSTANCE_ON_FILE
Create metadata instance on folder
BOX_CREATE_METADATA_INSTANCE_ON_FOLDER
Create metadata template
BOX_CREATE_METADATA_TEMPLATE
Create retention policy
BOX_CREATE_RETENTION_POLICY
Create shield information barrier
BOX_CREATE_SHIELD_INFORMATION_BARRIER
Create shield information barrier report
BOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORT
Create shield information barrier segment
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT
Create shield information barrier segment member
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER
Create shield information barrier segment restriction
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION
Create slack integration mapping
BOX_CREATE_SLACK_INTEGRATION_MAPPING
Create task
BOX_CREATE_TASK
Create teams integration mapping
BOX_CREATE_TEAMS_INTEGRATION_MAPPING
Create terms of service
BOX_CREATE_TERMS_OF_SERVICE
Create terms of service status for new user
BOX_CREATE_TERMS_OF_SERVICE_STATUS_FOR_NEW_USER
Create upload session
BOX_CREATE_UPLOAD_SESSION
Create upload session for existing file
BOX_CREATE_UPLOAD_SESSION_FOR_EXISTING_FILE
Create user
BOX_CREATE_USER
Create user exemption from collaboration domain restrictions
BOX_CREATE_USER_EXEMPTION_FROM_COLLABORATION_DOMAIN_RESTRICTIONS
Create user invite
BOX_CREATE_USER_INVITE
Create webhook
BOX_CREATE_WEBHOOK
Create web link
BOX_CREATE_WEB_LINK
Create zip download
BOX_CREATE_ZIP_DOWNLOAD
Delete ai agent
BOX_DELETE_AI_AGENT
Delete file
BOX_DELETE_FILE
Delete file request
BOX_DELETE_FILE_REQUEST
Delete folder
BOX_DELETE_FOLDER
Delete folder lock
BOX_DELETE_FOLDER_LOCK
Delete retention policy
BOX_DELETE_RETENTION_POLICY
Delete shield information barrier segment
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT
Delete shield information barrier segment member by id
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_ID
Delete shield information barrier segment restriction by id
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_ID
Delete slack integration mapping
BOX_DELETE_SLACK_INTEGRATION_MAPPING
Delete teams integration mapping
BOX_DELETE_TEAMS_INTEGRATION_MAPPING
Delete user
BOX_DELETE_USER
Delete user avatar
BOX_DELETE_USER_AVATAR
Download file
BOX_DOWNLOAD_FILE
Download zip archive
BOX_DOWNLOAD_ZIP_ARCHIVE
Extract metadata freeform
BOX_EXTRACT_METADATA_FREEFORM
Extract metadata structured
BOX_EXTRACT_METADATA_STRUCTURED
Find app item for shared link
BOX_FIND_APP_ITEM_FOR_SHARED_LINK
Find file for shared link
BOX_FIND_FILE_FOR_SHARED_LINK
Find folder for shared link
BOX_FIND_FOLDER_FOR_SHARED_LINK
Find metadata template by instance id
BOX_FIND_METADATA_TEMPLATE_BY_INSTANCE_ID
Find web link for shared link
BOX_FIND_WEB_LINK_FOR_SHARED_LINK
Force apply metadata cascade policy to folder
BOX_FORCE_APPLY_METADATA_CASCADE_POLICY_TO_FOLDER
Generate text
BOX_GENERATE_TEXT
Get ai agent by agent id
BOX_GET_AI_AGENT_BY_AGENT_ID
Get ai agent default configuration
BOX_GET_AI_AGENT_DEFAULT_CONFIGURATION
Get allowed collaboration domain
BOX_GET_ALLOWED_COLLABORATION_DOMAIN
Get box sign request by id
BOX_GET_BOX_SIGN_REQUEST_BY_ID
Get box sign template by id
BOX_GET_BOX_SIGN_TEMPLATE_BY_ID
Get classification on file
BOX_GET_CLASSIFICATION_ON_FILE
Get classification on folder
BOX_GET_CLASSIFICATION_ON_FOLDER
Get collaboration
BOX_GET_COLLABORATION
Get collection by id
BOX_GET_COLLECTION_BY_ID
Get comment
BOX_GET_COMMENT
Get current user
BOX_GET_CURRENT_USER
Get device pin
BOX_GET_DEVICE_PIN
Get events long poll endpoint
BOX_GET_EVENTS_LONG_POLL_ENDPOINT
Get file information
BOX_GET_FILE_INFORMATION
Get file request
BOX_GET_FILE_REQUEST
Get files under retention
BOX_GET_FILES_UNDER_RETENTION
Get file thumbnail
BOX_GET_FILE_THUMBNAIL
Get file version
BOX_GET_FILE_VERSION
Get file version legal hold
BOX_GET_FILE_VERSION_LEGAL_HOLD
Get file versions under retention
BOX_GET_FILE_VERSIONS_UNDER_RETENTION
Get folder information
BOX_GET_FOLDER_INFORMATION
Get group
BOX_GET_GROUP
Get group membership
BOX_GET_GROUP_MEMBERSHIP
Get legal hold policy
BOX_GET_LEGAL_HOLD_POLICY
Get legal hold policy assignment
BOX_GET_LEGAL_HOLD_POLICY_ASSIGNMENT
Get metadata cascade policy
BOX_GET_METADATA_CASCADE_POLICY
Get metadata instance on file
BOX_GET_METADATA_INSTANCE_ON_FILE
Get metadata instance on folder
BOX_GET_METADATA_INSTANCE_ON_FOLDER
Get metadata template by id
BOX_GET_METADATA_TEMPLATE_BY_ID
Get metadata template by name
BOX_GET_METADATA_TEMPLATE_BY_NAME
Get retention on file
BOX_GET_RETENTION_ON_FILE
Get retention policy
BOX_GET_RETENTION_POLICY
Get retention policy assignment
BOX_GET_RETENTION_POLICY_ASSIGNMENT
Get shared link for file
BOX_GET_SHARED_LINK_FOR_FILE
Get shared link for folder
BOX_GET_SHARED_LINK_FOR_FOLDER
Get shared link for web link
BOX_GET_SHARED_LINK_FOR_WEB_LINK
Get shield information barrier report by id
BOX_GET_SHIELD_INFORMATION_BARRIER_REPORT_BY_ID
Get shield information barrier segment member by id
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_ID
Get shield information barrier segment restriction by id
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_ID
Get shield information barrier segment with specified id
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_WITH_SPECIFIED_ID
Get shield information barrier with specified id
BOX_GET_SHIELD_INFORMATION_BARRIER_WITH_SPECIFIED_ID
Get storage policy
BOX_GET_STORAGE_POLICY
Get storage policy assignment
BOX_GET_STORAGE_POLICY_ASSIGNMENT
Get task
BOX_GET_TASK
Get task assignment
BOX_GET_TASK_ASSIGNMENT
Get terms of service
BOX_GET_TERMS_OF_SERVICE
Get trashed file
BOX_GET_TRASHED_FILE
Get trashed folder
BOX_GET_TRASHED_FOLDER
Get trashed web link
BOX_GET_TRASHED_WEB_LINK
Get upload session
BOX_GET_UPLOAD_SESSION
Get user
BOX_GET_USER
Get user avatar
BOX_GET_USER_AVATAR
Get user exempt from collaboration domain restrictions
BOX_GET_USER_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONS
Get user invite status
BOX_GET_USER_INVITE_STATUS
Get watermark for folder
BOX_GET_WATERMARK_FOR_FOLDER
Get watermark on file
BOX_GET_WATERMARK_ON_FILE
Get webhook
BOX_GET_WEBHOOK
Get web link
BOX_GET_WEB_LINK
Get zip download status
BOX_GET_ZIP_DOWNLOAD_STATUS
List ai agents
BOX_LIST_AI_AGENTS
List all classifications
BOX_LIST_ALL_CLASSIFICATIONS
List all collections
BOX_LIST_ALL_COLLECTIONS
List all file versions
BOX_LIST_ALL_FILE_VERSIONS
List all global metadata templates
BOX_LIST_ALL_GLOBAL_METADATA_TEMPLATES
List all legal hold policies
BOX_LIST_ALL_LEGAL_HOLD_POLICIES
List all metadata templates for enterprise
BOX_LIST_ALL_METADATA_TEMPLATES_FOR_ENTERPRISE
List allowed collaboration domains
BOX_LIST_ALLOWED_COLLABORATION_DOMAINS
List all webhooks
BOX_LIST_ALL_WEBHOOKS
List box sign requests
BOX_LIST_BOX_SIGN_REQUESTS
List box sign templates
BOX_LIST_BOX_SIGN_TEMPLATES
List box skill cards on file
BOX_LIST_BOX_SKILL_CARDS_ON_FILE
List collection items
BOX_LIST_COLLECTION_ITEMS
List enterprise device pins
BOX_LIST_ENTERPRISE_DEVICE_PINS
List enterprise users
BOX_LIST_ENTERPRISE_USERS
List file app item associations
BOX_LIST_FILE_APP_ITEM_ASSOCIATIONS
List file collaborations
BOX_LIST_FILE_COLLABORATIONS
List file comments
BOX_LIST_FILE_COMMENTS
List file version legal holds
BOX_LIST_FILE_VERSION_LEGAL_HOLDS
List file version retentions
BOX_LIST_FILE_VERSION_RETENTIONS
List folder app item associations
BOX_LIST_FOLDER_APP_ITEM_ASSOCIATIONS
List folder collaborations
BOX_LIST_FOLDER_COLLABORATIONS
List folder locks
BOX_LIST_FOLDER_LOCKS
List group collaborations
BOX_LIST_GROUP_COLLABORATIONS
List groups for enterprise
BOX_LIST_GROUPS_FOR_ENTERPRISE
List items in folder
BOX_LIST_ITEMS_IN_FOLDER
List legal hold policy assignments
BOX_LIST_LEGAL_HOLD_POLICY_ASSIGNMENTS
List members of group
BOX_LIST_MEMBERS_OF_GROUP
List metadata cascade policies
BOX_LIST_METADATA_CASCADE_POLICIES
List metadata instances on file
BOX_LIST_METADATA_INSTANCES_ON_FILE
List metadata instances on folder
BOX_LIST_METADATA_INSTANCES_ON_FOLDER
List parts
BOX_LIST_PARTS
List pending collaborations
BOX_LIST_PENDING_COLLABORATIONS
List previous file versions for legal hold policy assignment
BOX_LIST_PREVIOUS_FILE_VERSIONS_FOR_LEGAL_HOLD_POLICY_ASSIGNMENT
List recently accessed items
BOX_LIST_RECENTLY_ACCESSED_ITEMS
List retention policies
BOX_LIST_RETENTION_POLICIES
List retention policy assignments
BOX_LIST_RETENTION_POLICY_ASSIGNMENTS
List shield information barrier reports
BOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTS
List shield information barriers
BOX_LIST_SHIELD_INFORMATION_BARRIERS
List shield information barrier segment members
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERS
List shield information barrier segment restrictions
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONS
List shield information barrier segments
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENTS
List slack integration mappings
BOX_LIST_SLACK_INTEGRATION_MAPPINGS
List storage policies
BOX_LIST_STORAGE_POLICIES
List storage policy assignments
BOX_LIST_STORAGE_POLICY_ASSIGNMENTS
List task assignments
BOX_LIST_TASK_ASSIGNMENTS
List tasks on file
BOX_LIST_TASKS_ON_FILE
List teams integration mappings
BOX_LIST_TEAMS_INTEGRATION_MAPPINGS
List terms of services
BOX_LIST_TERMS_OF_SERVICES
List terms of service user statuses
BOX_LIST_TERMS_OF_SERVICE_USER_STATUSES
List trashed items
BOX_LIST_TRASHED_ITEMS
List user and enterprise events
BOX_LIST_USER_AND_ENTERPRISE_EVENTS
List user s email aliases
BOX_LIST_USER_S_EMAIL_ALIASES
List users exempt from collaboration domain restrictions
BOX_LIST_USERS_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONS
List user s groups
BOX_LIST_USER_S_GROUPS
List workflows
BOX_LIST_WORKFLOWS
Permanently remove file
BOX_PERMANENTLY_REMOVE_FILE
Permanently remove folder
BOX_PERMANENTLY_REMOVE_FOLDER
Permanently remove web link
BOX_PERMANENTLY_REMOVE_WEB_LINK
Preflight check before upload
BOX_PREFLIGHT_CHECK_BEFORE_UPLOAD
Promote file version
BOX_PROMOTE_FILE_VERSION
Query files folders by metadata
BOX_QUERY_FILES_FOLDERS_BY_METADATA
Refresh access token
BOX_REFRESH_ACCESS_TOKEN
Remove box skill cards from file
BOX_REMOVE_BOX_SKILL_CARDS_FROM_FILE
Remove classification from file
BOX_REMOVE_CLASSIFICATION_FROM_FILE
Remove classification from folder
BOX_REMOVE_CLASSIFICATION_FROM_FOLDER
Remove collaboration
BOX_REMOVE_COLLABORATION
Remove comment
BOX_REMOVE_COMMENT
Remove device pin
BOX_REMOVE_DEVICE_PIN
Remove domain from list of allowed collaboration domains
BOX_REMOVE_DOMAIN_FROM_LIST_OF_ALLOWED_COLLABORATION_DOMAINS
Remove email alias
BOX_REMOVE_EMAIL_ALIAS
Remove file version
BOX_REMOVE_FILE_VERSION
Remove group
BOX_REMOVE_GROUP
Remove legal hold policy
BOX_REMOVE_LEGAL_HOLD_POLICY
Remove metadata cascade policy
BOX_REMOVE_METADATA_CASCADE_POLICY
Remove metadata instance from file
BOX_REMOVE_METADATA_INSTANCE_FROM_FILE
Remove metadata instance from folder
BOX_REMOVE_METADATA_INSTANCE_FROM_FOLDER
Remove metadata template
BOX_REMOVE_METADATA_TEMPLATE
Remove retention policy assignment
BOX_REMOVE_RETENTION_POLICY_ASSIGNMENT
Remove shared link from file
BOX_REMOVE_SHARED_LINK_FROM_FILE
Remove shared link from folder
BOX_REMOVE_SHARED_LINK_FROM_FOLDER
Remove shared link from web link
BOX_REMOVE_SHARED_LINK_FROM_WEB_LINK
Remove task
BOX_REMOVE_TASK
Remove upload session
BOX_REMOVE_UPLOAD_SESSION
Remove User Domain Exemption
BOX_REMOVE_USER_DOMAIN_EXEMPTION
Remove user from group
BOX_REMOVE_USER_FROM_GROUP
Remove watermark from file
BOX_REMOVE_WATERMARK_FROM_FILE
Remove watermark from folder
BOX_REMOVE_WATERMARK_FROM_FOLDER
Remove webhook
BOX_REMOVE_WEBHOOK
Remove web link
BOX_REMOVE_WEB_LINK
Request access token
BOX_REQUEST_ACCESS_TOKEN
Resend box sign request
BOX_RESEND_BOX_SIGN_REQUEST
Restore file
BOX_RESTORE_FILE
Restore file version
BOX_RESTORE_FILE_VERSION
Restore folder
BOX_RESTORE_FOLDER
Restore web link
BOX_RESTORE_WEB_LINK
Review files on legal hold policy assignment
BOX_REVIEW_FILES_ON_LEGAL_HOLD_POLICY_ASSIGNMENT
Revoke access token
BOX_REVOKE_ACCESS_TOKEN
Search for content
BOX_SEARCH_FOR_CONTENT
Starts workflow based on request body
BOX_STARTS_WORKFLOW_BASED_ON_REQUEST_BODY
Transfer owned folders
BOX_TRANSFER_OWNED_FOLDERS
Unassign legal hold policy
BOX_UNASSIGN_LEGAL_HOLD_POLICY
Unassign storage policy
BOX_UNASSIGN_STORAGE_POLICY
Unassign task
BOX_UNASSIGN_TASK
Update ai agent
BOX_UPDATE_AI_AGENT
Update all box skill cards on file
BOX_UPDATE_ALL_BOX_SKILL_CARDS_ON_FILE
Update collaboration
BOX_UPDATE_COLLABORATION
Update comment
BOX_UPDATE_COMMENT
Update file
BOX_UPDATE_FILE
Update file request
BOX_UPDATE_FILE_REQUEST
Update folder
BOX_UPDATE_FOLDER
Update group
BOX_UPDATE_GROUP
Update group membership
BOX_UPDATE_GROUP_MEMBERSHIP
Update legal hold policy
BOX_UPDATE_LEGAL_HOLD_POLICY
Update retention policy
BOX_UPDATE_RETENTION_POLICY
Update shared link on file
BOX_UPDATE_SHARED_LINK_ON_FILE
Update shared link on folder
BOX_UPDATE_SHARED_LINK_ON_FOLDER
Update shared link on web link
BOX_UPDATE_SHARED_LINK_ON_WEB_LINK
Update shield information barrier segment with specified id
BOX_UPDATE_SHIELD_INFORMATION_BARRIER_SEGMENT_WITH_SPECIFIED_ID
Update slack integration mapping
BOX_UPDATE_SLACK_INTEGRATION_MAPPING
Update storage policy assignment
BOX_UPDATE_STORAGE_POLICY_ASSIGNMENT
Update task
BOX_UPDATE_TASK
Update task assignment
BOX_UPDATE_TASK_ASSIGNMENT
Update teams integration mapping
BOX_UPDATE_TEAMS_INTEGRATION_MAPPING
Update terms of service
BOX_UPDATE_TERMS_OF_SERVICE
Update terms of service status for existing user
BOX_UPDATE_TERMS_OF_SERVICE_STATUS_FOR_EXISTING_USER
Update user
BOX_UPDATE_USER
Update webhook
BOX_UPDATE_WEBHOOK
Update web link
BOX_UPDATE_WEB_LINK
Upload file
BOX_UPLOAD_FILE
Upload file version
BOX_UPLOAD_FILE_VERSION
Upload part of file
BOX_UPLOAD_PART_OF_FILE