- Category: file management & storage
- Auth: OAUTH2
- Composio-managed OAuth available? Yes
- Tools: 286
- Triggers: 20
- Slug:
BOX - Version: 20261101_00
Tools
Add domain to list of allowed collaboration domains
Add domain to list of allowed collaboration domains
BOX_ADD_ALLOWED_COLLABORATION_DOMAINCreates a new entry in the list of allowed domains for collaboration within your enterprise. This allows you to whitelist specific domains for external collaboration. Use ‘inbound’ to allow users from the specified domain to collaborate on your enterprise’s files and folders. Use ‘outbound’ to allow your enterprise users to collaborate on content owned by the specified domain. Use ‘both’ for bidirectional collaboration. Note: This action requires enterprise admin privileges and the ‘manage_enterprise_properties’ scope.Input Parameters
Output
Add classification to file
Add classification to file
BOX_ADD_CLASSIFICATION_TO_FILEAdds a classification to a file by specifying the label of the classification to add. Enterprise-only feature: This action requires a Box enterprise account with classification templates configured. Users without an enterprise account will receive an error when attempting to use this feature. This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Add classification to folder
Add classification to folder
BOX_ADD_CLASSIFICATION_TO_FOLDERAdds a classification to a folder by specifying the label of the classification to add. Enterprise-only feature: This action requires a Box enterprise account with classification templates configured. Users without an enterprise account will receive an error when attempting to use this feature. Prerequisites: - A classification template must exist in the enterprise. Use list_all_classifications to retrieve available classification keys. - If no classifications exist, an admin must first create the classification template using add_initial_classifications. Common errors: - 404: Classification template not found (no classifications exist in enterprise) - 409: Classification already exists on this folder (use update action instead) - 403: Insufficient permissions to add classifications This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Add initial classifications
Add initial classifications
BOX_ADD_INITIAL_CLASSIFICATIONSInitializes the classification template for an enterprise with an initial set of classification options. IMPORTANT: This action requires admin permissions and should only be called once per enterprise when no classifications exist. If classifications already exist, use the ‘add_classification’ action to add more options. Common classification examples: ‘Confidential’, ‘Internal’, ‘Public’, ‘Restricted’. Returns 400 if the classification template already exists. Returns 403 if the user lacks admin permissions.Input Parameters
Output
Add or update user avatar
Add or update user avatar
Add user to group
Add user to group
BOX_ADD_USER_TO_GROUPCreates a group membership. Only users with admin-level permissions will be able to use this API.Input Parameters
Output
Append metadata taxonomy level
Append metadata taxonomy level
BOX_APPEND_METADATA_TAXONOMY_LEVELAppends a new level to a metadata taxonomy structure. Use when adding hierarchical categories to organize metadata. If no levels exist, this creates the first level.Input Parameters
Output
Apply watermark to file
Apply watermark to file
BOX_APPLY_WATERMARK_TO_FILEApplies or update a watermark on a file.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Apply watermark to folder
Apply watermark to folder
BOX_APPLY_WATERMARK_TO_FOLDERApplies or update a watermark on a folder.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Ask question
Ask question
BOX_ASK_QUESTIONAsk natural-language questions about Box files or a Box Hub using Box AI. Supports single-item and multiple-item question-answering modes, with optional conversation history and citations; requires the manage_ai scope.Input Parameters
Output
Assign legal hold policy
Assign legal hold policy
BOX_ASSIGN_LEGAL_HOLD_POLICYAssign a legal hold policy to a file, file version, folder, or user. Legal hold policies preserve content for litigation or compliance purposes by preventing the deletion of specified items. When assigned to a folder, the hold applies recursively to all contents. When assigned to a user, the hold applies to all content owned by that user. Note: This feature requires Box Enterprise or higher with legal hold capabilities enabled. The authenticated user must have admin privileges with ‘manage_legal_holds’ scope.Input Parameters
Output
Assign retention policy
Assign retention policy
BOX_ASSIGN_RETENTION_POLICYAssigns a retention policy to an item in Box to enforce content retention. Use this action to apply a retention policy to: - An entire enterprise (assign_to_type=‘enterprise’, no ID needed) - A specific folder (assign_to_type=‘folder’, provide folder ID) - Items matching metadata criteria (assign_to_type=‘metadata_template’, provide template ID) Prerequisites: - Box Governance license is required - Admin permissions with ‘manage_data_retention’ and ‘enterprise_content’ scopes - A retention policy must exist (use create_retention_policy first) Example usage for folder assignment: - policy_id: “173463” (from create_retention_policy or list_retention_policies) - assign_to_type: “folder” - assign_to_id: “6564564” (the folder ID)Input Parameters
Output
Assign storage policy
Assign storage policy
BOX_ASSIGN_STORAGE_POLICYCreates a storage policy assignment for an enterprise or user. Storage policies control where data is stored geographically (data residency). This action requires Box Zones or similar enterprise feature to be enabled. Use ‘list_storage_policies’ to get available policies before assignment.Input Parameters
Output
Assign task
Assign task
BOX_ASSIGN_TASKAssigns a task to a user. A task can be assigned to more than one user by creating multiple assignments.Input Parameters
assign_to_login must be provided, but not both.assign_to_id must be provided, but not both.Output
Cancel box sign request
Cancel box sign request
BOX_CANCEL_BOX_SIGN_REQUESTCancels a pending Box Sign request that has not yet been fully signed or declined. After cancellation, any outstanding signers will no longer be able to sign the document. Only the user who created the request (the requester) is able to cancel it. Note: A request cannot be cancelled if it was already declined, fully signed, or if the document is still in the converting state. Returns the cancelled sign request object with updated status set to ‘cancelled’.Input Parameters
Output
Commit upload session
Commit upload session
BOX_COMMIT_UPLOAD_SESSIONCommits an upload session and creates a file from the uploaded chunks. This is the final step in a chunked upload workflow: 1. Create an upload session using ‘create_upload_session’ 2. Upload file parts using ‘upload_part_of_file’ 3. Commit the session using this action to finalize the file Requirements: - All parts must be uploaded before committing - The digest header must contain the SHA1 hash of the entire file (Base64 encoded) - Parts array must include part_id, offset, and size for each uploaded chunk Note: The API may return 202 if processing is not complete. In this case, check the retry_after field and retry after the specified number of seconds.Input Parameters
Output
Copy file
Copy file
BOX_COPY_FILECreates a copy of a file.Input Parameters
/, “), and protected names like . and .. are automatically sanitized by removing the non-allowed characters.https://*.app.box.com/files/123 the file_id is 123.Output
Copy file request
Copy file request
BOX_COPY_FILE_REQUESTCopies an existing file request to a new folder. File requests allow external users to upload files to a specific folder without needing a Box account. This action creates a copy of an existing file request and associates it with a different destination folder. IMPORTANT LIMITATION: File request IDs cannot be discovered via API - they can only be obtained from the Box web application. To find a file_request_id: 1. Navigate to Box web UI (https://app.box.com) 2. Go to the folder containing the file request 3. Open the file request settings 4. Copy the ID from the URL (e.g., https://*.app.box.com/filerequest/123 → ID is “123”) Common use cases: - Creating file request templates that can be copied to multiple project folders - Automating file request creation for new cases/customers/projects - Duplicating file requests with different settings (title, description, etc.) When copying, you can optionally override settings from the source file request including title, description, status, and form requirements.Input Parameters
Output
Copy folder
Copy folder
BOX_COPY_FOLDERCreates a copy of a folder within a destination folder. The original folder will not be changed.Input Parameters
/, “), as well as names with trailing spaces are prohibited. Additionally, the names . and .. are not allowed either.https://*.app.box.com/folder/123 the folder_id is 123. The root folder with the ID 0 can not be copied.Output
Create AI Agent
Create AI Agent
BOX_CREATE_AI_AGENTCreates a custom AI agent in Box AI Studio. At least one capability required: ask (Q&A), text_gen (content generation), or extract (metadata extraction). Requirements: Box Enterprise Advanced account, Box AI Studio enabled, “Manage AI” scope in Developer Console. Access options: ‘enabled’ (all users), ‘disabled’ (none), ‘enabled_for_selected_users’ (specified in allowed_entities). Example: Set name + ask__type=‘ai_agent_ask’ + ask__access__state=‘enabled’ + ask__description to create Q&A agent.Input Parameters
Output
Create Box Sign Request
Create Box Sign Request
BOX_CREATE_BOX_SIGN_REQUESTCreates a Box Sign request to send documents for electronic signing. Prepares documents and sends signature requests to signers via email. Signers do not need Box accounts. Supports up to 10 files, 35 signers, sequential signing order, templates, and custom redirect URLs. Requires Box Sign feature enabled and sign_requests.readwrite scope.Input Parameters
Output
Create box skill cards on file
Create box skill cards on file
BOX_CREATE_BOX_SKILL_CARDS_ON_FILEApplies one or more Box Skills metadata cards to a file. NOTE: This action creates NEW Box Skill cards on a file. If Box Skill cards already exist on the file, this action will fail with a 409 Conflict error. In that case: - Use ‘remove_box_skill_cards_from_file’ to delete existing cards first, then create new ones, OR - Use ‘update_all_box_skill_cards_on_file’ to overwrite all existing cardsInput Parameters
https://*.app.box.com/files/123 the file_id is 123. Note: This file must NOT have existing Box Skill cards metadata, otherwise a 409 Conflict error will occur.Output
Create user exemption from collaboration domain restrictions
Create user exemption from collaboration domain restrictions
BOX_CREATE_COLLAB_EXEMPTIONExempts a specific user from the enterprise’s collaboration domain restrictions. This allows the specified user to collaborate with external parties from any domain, bypassing the enterprise’s allowed collaboration domain list. PREREQUISITES: - The enterprise MUST have at least one allowed collaboration domain configured. Use ‘Add domain to list of allowed collaboration domains’ first if needed. - The user must not already have an exemption (returns 409 Conflict if exists). - Requires enterprise admin privileges with ‘manage_users’ scope. COMMON ERRORS: - 409 Conflict: User already exempt OR no whitelisted domains exist for enterprise. - 403 Forbidden: Insufficient permissions to manage user exemptions. - 404 Not Found: The specified user ID does not exist.Input Parameters
Output
Create collaboration
Create collaboration
BOX_CREATE_COLLABORATIONAdds a collaboration for a single user or a single group to a file or folder. Collaborations can be created using email address, user IDs, or a group IDs. If a collaboration is being created with a group, access to this endpoint is dependent on the group’s ability to be invited. If collaboration is in pending status, the following fields are redacted: - login and name are hidden if a collaboration was created using user_id, - name is hidden if a collaboration was created using login.Input Parameters
can_view_path enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a can_view_path of true. can_view_path can only be used for folder collaborations.true, collaborators have access to shared items, but such items won”t be visible in the All Files list. Additionally, collaborators won”t see the the path to the root folder for the shared item.Output
Create comment
Create comment
BOX_CREATE_COMMENTAdds a comment by the user to a specific file, or as a reply to an other comment.Input Parameters
tagged_message is provided. To mention a user, use tagged_message instead.@[user_id:name] to mention a user, which sends them an email notification. The user_id is the target user’s ID, and name is a display phrase that links to the user’s profile in Box UI. Either message or tagged_message must be provided, but not both.Output
Create email alias
Create email alias
BOX_CREATE_EMAIL_ALIASAdds a new email alias to a user account. The email domain must be registered to your enterprise. Returns the newly created email alias object with id, type, email, and is_confirmed fields.Input Parameters
Output
Create folder
Create folder
BOX_CREATE_FOLDERCreates a new empty folder within the specified parent folder.Input Parameters
/, “), as well as names with trailing spaces are prohibited. Additionally, the names . and .. are not allowed either.Output
Create folder lock
Create folder lock
Create group
Create group
BOX_CREATE_GROUPCreates a new group of users in an enterprise. Only users with admin permissions can create new groups.Input Parameters
Active Directory, or Okta. Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.admins_only the enterprise admin, co-admins, and the group”s admin can invite the group. When set to admins_and_members all the admins listed above and group members can invite the group. When set to all_managed_users all managed users in the enterprise can invite the group.admins_only - the enterprise admin, co-admins, group”s group admin * admins_and_members - all admins and group members * all_managed_users - all managed users in the enterpriseOutput
Create legal hold policy
Create legal hold policy
BOX_CREATE_LEGAL_HOLD_POLICYCreate a new legal hold policy in Box. Legal hold policies are used to prevent permanent deletion of content during ongoing litigation. Once created, the policy can be assigned to specific users, folders, or files. IMPORTANT: Either is_ongoing must be set to true, OR both filter_started_at and filter_ended_at must be provided. The policy name must be unique within the enterprise. Requires Box Governance add-on (Enterprise plan with legal hold feature enabled).Input Parameters
is_ongoing is set to false.is_ongoing is set to false.Output
Create metadata cascade policy
Create metadata cascade policy
BOX_CREATE_METADATA_CASCADE_POLICYCreates a new metadata cascade policy that automatically applies a metadata template to all files and subfolders within a specified folder. Prerequisites: - A metadata instance must already be applied to the target folder before creating the cascade policy. - The target folder cannot be the root folder (ID ‘0’). - Enterprise admin must have enabled ‘Cascading Folder Level Metadata’ in Admin Console > Enterprise Settings > Content & Sharing. Common use case: After applying metadata to a folder, create a cascade policy to ensure all new items added to that folder automatically inherit the metadata. Returns: A MetadataCascadePolicy object with id, type, owner_enterprise, parent, scope, and templateKey fields. Error codes: - 400: Invalid format for scope, templateKey, or folder_id - 403: Policy cannot apply to restricted folders (e.g., root folder) - 404: Folder or template not found/inaccessible - 409: Duplicate policy already exists for this folder/template combinationInput Parameters
Output
Create metadata instance on file
Create metadata instance on file
BOX_CREATE_METADATA_INSTANCE_ON_FILEApplies an instance of a metadata template to a file. The metadata_fields parameter contains key-value pairs that match the fields defined in the template. In most cases only field keys present in the metadata template will be accepted, except for the global.properties template which accepts any key-value pair. Common error codes: - 409 (tuple_already_exists): A metadata instance of this template already exists on the file. - 404 (not_found): The file was not found or the user does not have access. - 404 (instance_tuple_not_found): The metadata template was not found. - 400 (schema_validation_failed): Invalid field key or value type for the template.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Create metadata instance on folder
Create metadata instance on folder
BOX_CREATE_METADATA_INSTANCE_ON_FOLDERApplies an instance of a metadata template to a folder. In most cases only values that are present in the metadata template will be accepted, except for the global.properties template which accepts any key-value pair. To display the metadata template in the Box web app the enterprise needs to be configured to enable Cascading Folder Level Metadata for the user in the admin console.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Create metadata taxonomy
Create metadata taxonomy
BOX_CREATE_METADATA_TAXONOMYTool to create a new metadata taxonomy in Box. Use when you need to set up a hierarchical classification system for organizing and categorizing metadata templates.Input Parameters
Output
Create metadata taxonomy levels
Create metadata taxonomy levels
BOX_CREATE_METADATA_TAXONOMY_LEVELSAppends hierarchical levels to a metadata taxonomy in ascending order of the supplied level numbers. Levels are appended individually, so an error can leave earlier levels in place.Input Parameters
Output
Create metadata taxonomy node
Create metadata taxonomy node
BOX_CREATE_METADATA_TAXONOMY_NODETool to create a new metadata taxonomy node within a specified taxonomy. Use when you need to add a new classification or category to an existing metadata taxonomy hierarchy.Input Parameters
Output
Create metadata template
Create metadata template
BOX_CREATE_METADATA_TEMPLATECreates a new metadata template that can be applied to files and folders.Input Parameters
templateKey based on the value of the displayName.Output
Create retention policy
Create retention policy
BOX_CREATE_RETENTION_POLICYCreates a retention policy for managing content lifecycle in Box. Retention policies prevent permanent deletion of content for a specified duration. Once created, policies can be assigned to folders or the entire enterprise. Note: This endpoint requires the Box Governance add-on feature and the ‘manage retention policies’ scope enabled in your application.Input Parameters
Output
Create shield information barrier
Create shield information barrier
BOX_CREATE_SHIELD_INFORMATION_BARRIERCreates a shield information barrier to establish an “ethical wall” that separates individuals/groups within an enterprise and prevents confidential information sharing. Prerequisites: Box Shield add-on must be licensed and enabled. Admin-level permissions required. Only one barrier allowed per enterprise. NOT available in Shield trials. Workflow: 1) Get enterprise ID from /users/me, 2) Create barrier (starts in ‘draft’), 3) Create segments and add users, 4) Define segment restrictions, 5) Enable barrier. Common errors: 400 (missing enterprise), 404 (Shield not enabled/invalid ID), 409 (barrier already exists).Input Parameters
Output
Create shield information barrier report
Create shield information barrier report
BOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORTCreates a shield information barrier report for a given barrier. Shield information barrier reports track the configuration status of information barriers in Box Shield. When created, reports start with status ‘pending’ and transition to ‘done’, ‘error’, or ‘cancelled’. Note: Requires Box Shield enterprise add-on license. Returns 404 if Shield is not enabled for the enterprise. Returns 409 if a report is already being created.Input Parameters
Output
Create shield information barrier segment
Create shield information barrier segment
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENTCreates a new shield information barrier segment for compliance and information isolation. Segments represent organizational divisions (e.g., Investment Banking, Research, Trading) that need to be isolated from each other for regulatory compliance. Each segment can have users assigned to it, and restrictions can be created to prevent collaboration between specific segments. Prerequisites: Box Shield license, existing barrier (create_shield_information_barrier), barrier in ‘draft’/‘pending’ status. Returns 404 if Shield not enabled or barrier doesn’t exist. Returns 409 if segment name already exists. Related: create_shield_information_barrier_segment_member, create_shield_information_barrier_segment_restriction, list_shield_information_barrier_segmentsInput Parameters
Output
Create shield information barrier segment member
Create shield information barrier segment member
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERAdds a Box user to a shield information barrier segment for compliance and information security. This assigns users to segments that restrict collaboration between departments (e.g., Investment Banking vs Research in financial institutions). Users can only belong to ONE segment at a time. Prerequisites: Box Shield license, existing barrier and segment, valid user ID. Returns 404 if Shield not enabled or resources don’t exist. Related: create_shield_information_barrier_segment, list_shield_information_barrier_segment_membersInput Parameters
Output
Create shield information barrier segment restriction
Create shield information barrier segment restriction
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONCreates a ONE-WAY shield information barrier segment restriction preventing collaboration between members of two segments (e.g., Investment Banking cannot collaborate with Research). Prerequisites: - Box Shield add-on enabled (returns 404 if not available) - Admin privileges required - Both segments must exist in the same barrier Key details: - Creates ONE-WAY restriction. For bidirectional, call twice with swapped segment IDs - shield_information_barrier parameter is optional (inferred from segments) - Use create_shield_information_barrier_segment to create segments first - Common for regulatory compliance and ethical walls Workflow: 1) Create barrier 2) Create segments 3) Create restrictions 4) Add members to segmentsInput Parameters
Output
Create slack integration mapping
Create slack integration mapping
BOX_CREATE_SLACK_INTEGRATION_MAPPINGCreates a Slack integration mapping by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this endpoint.Input Parameters
Output
Create task
Create task
BOX_CREATE_TASKCreates a single task on a file. This task is not assigned to any user and will need to be assigned separately.Input Parameters
Output
Create Teams integration mapping
Create Teams integration mapping
BOX_CREATE_TEAMS_INTEGRATION_MAPPINGCreates a Microsoft Teams integration mapping that links a Teams channel or team to a Box folder. Once mapped, files shared in the Teams channel are automatically stored in the linked Box folder. Requires Admin/Co-Admin role and the manage_enterprise_properties scope. Prerequisites: - Box for Teams must be installed in the Microsoft Teams workspace - The Box folder must be owned by the enterprise and not already mapped See: https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-TeamsInput Parameters
Output
Create terms of service
Create terms of service
BOX_CREATE_TERMS_OF_SERVICECreates enterprise terms of service for managed users or external collaborators, with a status and text. The action declares both manage_enterprise_properties and manage_users scopes.Input Parameters
status is set to disabled.Output
Create terms of service status for new 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. This action records whether a user has accepted or rejected a specific terms of service. Use this for users who are encountering the terms of service for the first time. For users who have previously accepted or rejected terms, use update_terms_of_service_status_for_existing_user instead. Prerequisites: - The Terms of Service feature must be enabled for the enterprise in the Box Admin Console - A terms of service must exist (created via create_terms_of_service) - The user must not already have a status record for this terms of service Note: If a status already exists for the user and terms of service combination, the API will return an error.Input Parameters
Output
Create upload session
Create upload session
BOX_CREATE_UPLOAD_SESSIONCreates an upload session for chunked upload of large files (20MB+). This is the first step in Box’s chunked upload process. After creating the session, you must: (1) upload file chunks using the upload_part endpoint, (2) commit the session using the commit endpoint to finalize the file. The session expires after 7 days. Use this for files 20MB or larger. For smaller files, use the regular upload endpoint instead.Input Parameters
Output
Create upload session for existing file
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. Use this for files larger than 20MB. The session provides endpoints for uploading file parts, committing the upload, and checking status. Returns session info including part_size, total_parts, and session_endpoints for managing the chunked upload process.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Create user
Create user
BOX_CREATE_USERCreates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.Input Parameters
is_platform_access_only is set to true.Output
Create user invite
Create user invite
BOX_CREATE_USER_INVITEInvites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application. This method requires the “Manage An Enterprise” scope enabled for the application, which can be enabled within the developer console.Input Parameters
Output
Create webhook
Create webhook
BOX_CREATE_WEBHOOKCreates a webhook to monitor a file or folder for specific events. Webhooks allow you to receive notifications at a specified URL when events occur on Box content. When an event triggers, Box sends an HTTP POST request to your specified address with details about the event. Requirements: - The notification URL must use HTTPS on port 443 - The URL must respond with HTTP 200-299 within 30 seconds - Requires ‘Manage Webhooks’ scope enabled for the application Note: Folder webhooks cascade to sub-folders automatically.Input Parameters
Output
Create web link
Create web link
Create zip download
Create zip download
BOX_CREATE_ZIP_DOWNLOADCreates a request to download multiple files and folders as a single zip archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a download_url and a status_url that can be used to download the archive. The limit for an archive is either the Account’s upload limit or 10,000 files, whichever is met first. Note: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.Input Parameters
zip archive. This name will be appended by the .zip file extension, for example January Financials.zip.Output
Delete AI Agent
Delete AI Agent
BOX_DELETE_AI_AGENTPermanently deletes a custom AI agent from Box AI Studio. This action removes the specified AI agent and all its configuration, including any custom instructions and capability settings. This operation cannot be undone. Note: This action requires the ‘Manage AI’ scope to be enabled for the Box application. The authenticated user must have appropriate permissions to delete AI agents. Common error responses: - 403 Forbidden: Insufficient permissions or ‘Manage AI’ scope not enabled - 404 Not Found: The specified agent_id does not existInput Parameters
Output
Remove domain from list of allowed collaboration domains
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. This action deletes a specific collaboration whitelist entry, preventing users from that domain from collaborating on your enterprise’s content (or vice versa, depending on the original direction). Requirements: - Enterprise admin privileges - The ‘manage_enterprise_properties’ scope - External collaboration allowlisting must be enabled for your enterprise (part of the Governance package) Usage: Provide the collaboration_whitelist_entry_id of the domain entry you want to remove. You can obtain this ID from the ‘Add domain’ or ‘List allowed collaboration domains’ actions. Response: Returns 204 No Content on successful deletion. This operation is idempotent - deleting an already deleted entry will still return success.Input Parameters
Output
Delete shield information barrier segment restriction by id
Delete shield information barrier segment restriction by id
BOX_DELETE_BARRIER_RESTRICTIONDeletes a shield information barrier segment restriction by its unique ID. Shield information barrier segment restrictions define which segments cannot communicate with each other. When a restriction is deleted, users in the previously restricted segments will be able to collaborate again. Important Notes: - This operation is destructive and cannot be undone - Returns HTTP 204 (No Content) with empty response body on success - Requires Box Shield add-on with information barriers enabled - Idempotent: Deleting a non-existent restriction returns 404 (not an error state) - Requires admin privileges Prerequisites: - Box Shield add-on enabled (returns 404 if not available) - Valid segment restriction ID from create or list operationsInput Parameters
Output
Remove box skill cards from file
Remove box skill cards from file
BOX_DELETE_BOX_SKILL_CARDS_FROM_FILERemoves any Box Skills cards metadata from a file.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Remove collaboration
Remove collaboration
BOX_DELETE_COLLABORATIONRemoves a collaboration from a file or folder, revoking the collaborator’s access. A collaboration in Box represents shared access granted to a user or group on a file or folder. Removing a collaboration will: - Revoke the collaborator’s access to the item immediately - Remove the item from the collaborator’s “Shared with Me” view - Cancel any pending invitations if the collaboration was not yet accepted This action is permanent and cannot be undone. To restore access, you would need to create a new collaboration. Returns HTTP 204 (No Content) on successful deletion.Input Parameters
Output
Remove comment
Remove comment
BOX_DELETE_COMMENTPermanently deletes a comment from a file or folder in Box. This action removes a comment that was previously added to a Box item. Once deleted, the comment cannot be recovered. The operation returns HTTP 204 (No Content) on success. If the comment does not exist or has already been deleted, a 404 error is returned. Note: Only the user who created the comment or an admin can delete it.Input Parameters
Output
Remove device pin
Remove device pin
BOX_DELETE_DEVICE_PINDeletes an individual device pin from the enterprise. Device pins are created when users access Box from mobile or desktop devices that support device pinning. Removing a device pin will require the user to re-authenticate on that device. This endpoint requires admin privileges and the ‘manage_enterprise_properties’ scope. On successful deletion, returns HTTP 204 No Content.Input Parameters
Output
Remove email alias
Remove email alias
BOX_DELETE_EMAIL_ALIASRemoves an email alias from a user. This endpoint permanently deletes an email alias associated with a user account. Note: You cannot remove a user’s primary email address. To change the primary email, you must first create a new alias, set it as primary, then remove the old one. Returns HTTP 204 (No Content) on success with an empty response body. Returns HTTP 404 if the user or email alias is not found.Input Parameters
Output
Delete file
Delete file
BOX_DELETE_FILEDeletes a file from Box by moving it to trash or permanently (based on enterprise settings). Use the if_match parameter with the file’s ETag for safe concurrent operations. To permanently delete a trashed file, use the ‘Permanently remove file’ action instead.Input Parameters
https://*.app.box.com/files/123 the file_id is 123).etag value to ensure the file hasn’t been modified since you last retrieved it. If the file has changed, the request fails with HTTP 412 Precondition Failed. You can get the etag from the file’s metadata or from a previous API response.Output
Permanently remove file
Permanently remove file
BOX_DELETE_FILE_PERMANENTLYPermanently deletes a file from the trash. This action is irreversible and cannot be undone. The file must already be in the trash before it can be permanently removed. To move a file to trash first, use the ‘Delete file’ action.Input Parameters
https://*.app.box.com/files/123 the file_id is 123).Output
Delete file request
Delete file request
BOX_DELETE_FILE_REQUESTDeletes a file request permanently. File requests allow external users to upload files to a specific folder without needing a Box account. This action permanently deletes a file request. IMPORTANT LIMITATION: File request IDs cannot be discovered via API - they can only be obtained from the Box web application. To find a file_request_id: 1. Navigate to Box web UI (https://app.box.com) 2. Go to the folder containing the file request 3. Open the file request settings 4. Copy the ID from the URL (e.g., https://*.app.box.com/filerequest/123 → ID is “123”) Response: Returns HTTP 204 No Content on success (empty response body). Common Use Cases: - Removing file requests that are no longer needed - Cleaning up expired or inactive file requests - Managing file request lifecycle programmatically Note: This operation is permanent and cannot be undone. The file request will be deleted immediately, but any files that were already uploaded through the file request will remain in the destination folder.Input Parameters
Output
Remove file version
Remove file version
BOX_DELETE_FILE_VERSIONMove a file version to the trash. Versions are only tracked for Box users with premium accounts.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Delete folder
Delete folder
BOX_DELETE_FOLDERDeletes a folder, either permanently or by moving it to the trash. It can recursively delete a non-empty folder and all its contents.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Delete folder lock
Delete folder lock
BOX_DELETE_FOLDER_LOCKDeletes a folder lock on a given folder, removing restrictions on move and delete operations. You must be authenticated as the owner or co-owner of the folder to use this endpoint. This action removes a lock that was previously applied to prevent a folder from being moved or deleted. Once the lock is removed, the folder can be moved, transferred to another owner, or deleted normally.Input Parameters
Output
Permanently remove folder
Permanently remove folder
BOX_DELETE_FOLDER_PERMANENTLYPermanently deletes a folder that is in the trash. This action cannot be undone.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Remove group
Remove group
BOX_DELETE_GROUPPermanently deletes a group. Only users with admin-level permissions will be able to use this API.Input Parameters
Output
Remove legal hold policy
Remove legal hold policy
BOX_DELETE_LEGAL_HOLD_POLICYPermanently delete an existing legal hold policy from Box. This is an asynchronous operation - the policy deletion is initiated but may not complete immediately. A successful response (HTTP 202) indicates the deletion has started. The policy cannot be recovered after deletion. Note: Legal Hold is an enterprise feature that must be enabled for your Box account. Requires ‘manage_legal_holds’ scope.Input Parameters
Output
Remove metadata cascade policy
Remove metadata cascade policy
BOX_DELETE_METADATA_CASCADE_POLICYPermanently deletes a metadata cascade policy from a folder. When deleted, existing metadata on files/subfolders remains, but new items will no longer automatically inherit the template. Prerequisites: Requires ‘manage_managed_metadata’ scope and admin permissions. Returns: HTTP 204 No Content on success (empty response body). Operation is idempotent. Error codes: - 400: Invalid policy ID format - 404: Policy not found or folder inaccessible - 403: Insufficient permissions Related: BOX_CREATE_METADATA_CASCADE_POLICY, BOX_LIST_METADATA_CASCADE_POLICIESInput Parameters
Output
Remove metadata instance from file
Remove metadata instance from file
BOX_DELETE_METADATA_INSTANCE_FROM_FILERemoves a metadata instance from a file. Deletes all metadata associated with a specific template from a file. This operation cannot be undone. The metadata template itself is not deleted, only the instance of metadata applied to this specific file. Returns a 204 No Content response on success. Returns 404 if the metadata instance doesn’t exist on the file or if the file is not found.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Remove metadata instance from folder
Remove metadata instance from folder
BOX_DELETE_METADATA_INSTANCE_FROM_FOLDERRemove a metadata instance from a folder. Deletes a specific metadata template instance that has been applied to a folder. This operation is idempotent and will return a 404 error if the metadata instance doesn’t exist. Returns HTTP 204 No Content on successful deletion. Note: This only removes the metadata instance, not the folder itself. To remove a folder, use the delete folder action instead.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Remove metadata taxonomy
Remove metadata taxonomy
BOX_DELETE_METADATA_TAXONOMYPermanently deletes a metadata taxonomy from the enterprise. This deletion is permanent and cannot be reverted. Once deleted, the taxonomy and all associated metadata will be removed from files and folders. Use with caution.Input Parameters
Output
Remove metadata taxonomy node
Remove metadata taxonomy node
BOX_DELETE_METADATA_TAXONOMY_NODEPermanently deletes a metadata taxonomy node from Box. Metadata taxonomies in Box allow you to organize and classify content using hierarchical structures. This action removes a specific node from a taxonomy. Important constraints: - Only nodes without any children can be deleted - This deletion is permanent and cannot be reverted - Requires admin or co-admin permissions - The user must have access to the metadata taxonomies feature Returns HTTP 204 No Content on successful deletion. Returns HTTP 400 Bad Request if the node has children or request is invalid. Returns HTTP 403 Forbidden if the user lacks necessary permissions. Returns HTTP 404 Not Found if the taxonomy or node does not exist.Input Parameters
Output
Remove metadata template
Remove metadata template
BOX_DELETE_METADATA_TEMPLATEPermanently delete a metadata template and all its instances from files and folders. WARNING: This operation is destructive and cannot be undone. Once deleted: - The template definition is permanently removed - All metadata instances using this template on files/folders are also deleted - Any cascade policies using this template will stop working Scope: Use ‘enterprise’ for custom templates created within your organization. Global templates (scope=‘global’) cannot be deleted. Required Permission: Requires ‘manage enterprise properties’ scope. Only enterprise admins can delete metadata templates.Input Parameters
Output
Delete retention policy
Delete retention policy
BOX_DELETE_RETENTION_POLICYPermanently deletes a modifiable retention policy from the Box enterprise; non-modifiable policies cannot be deleted. The action requires admin privileges and both manage_data_retention and enterprise_content scopes.Input Parameters
Output
Remove retention policy assignment
Remove retention policy assignment
BOX_DELETE_RETENTION_POLICY_ASSIGNMENTRemoves a retention policy assignment from a folder, enterprise, or metadata template and returns a success indicator and message. Only assignments for modifiable policies can be removed; Box Governance and admin permissions are required.Input Parameters
Output
Delete shield information barrier segment
Delete shield information barrier segment
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENTPermanently deletes a shield information barrier segment by its ID. Shield information barriers help prevent conflicts of interest by restricting collaboration between user segments within an organization. This action removes a specific segment from the barrier configuration. Requirements: - Box Shield add-on must be enabled for the enterprise - Admin privileges are required to delete segments - The segment must not have any active restrictions referencing it Returns HTTP 204 No Content on successful deletion. Returns HTTP 404 Not Found if the segment ID does not exist.Input Parameters
Output
Delete shield information barrier segment member by 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. Shield information barriers are used to prevent conflicts of interest by restricting communication and collaboration between specific groups of users within an enterprise. This action removes a user’s membership from a specific barrier segment. Note: This feature requires Box Shield and is only available for enterprise accounts with the appropriate licensing. Returns 204 No Content on successful deletion.Input Parameters
Output
Delete Slack integration mapping
Delete Slack integration mapping
BOX_DELETE_SLACK_INTEGRATION_MAPPINGDeletes a Slack integration mapping that links a Box folder to a Slack channel. This endpoint removes an existing mapping between a Slack channel and a Box folder created through the Box for Slack integration. After deletion, any new files shared in the Slack channel will be stored in the default location rather than the previously mapped Box folder. Requirements: - Admin or Co-Admin role in the Box enterprise - Box for Slack must be installed in the relevant Slack workspace - Box as the Content Layer for Slack must be enabled Note: This action is irreversible. Once deleted, a new mapping must be created to restore the integration between the Slack channel and Box folder. For more information, see: https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-SlackInput Parameters
Output
Unassign storage policy
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). Use this action when you want to reset a user’s storage policy back to the enterprise default. This is useful when: - A user moves to a different region and should use the default zone - Cleaning up custom storage assignments - Reverting a user’s data residency settings Prerequisites: Requires Box Zones feature to be enabled for the enterprise. Rate Limit: Only twice per user in a 24-hour period. Response: Returns 204 No Content on success (empty data object).Input Parameters
Output
Remove task
Remove task
BOX_DELETE_TASKPermanently deletes a task from Box. Tasks are work assignments on files that can be assigned to collaborators for review or completion. Once deleted, the task and its assignments are permanently removed and cannot be recovered. Returns HTTP 204 (No Content) on successful deletion. Returns HTTP 404 if the task does not exist or has already been deleted. Use cases: - Remove completed tasks to clean up a file’s task list - Cancel tasks that are no longer needed - Delete tasks created in errorInput Parameters
Output
Unassign task
Unassign task
BOX_DELETE_TASK_ASSIGNMENTDeletes a specific task assignment, removing the task from the assigned user. This action unassigns a user from a task without deleting the task itself. The task remains on the file and can be reassigned to other users. To delete the task entirely, use the ‘remove_task’ action instead. The authenticated user must have permission to modify task assignments on the file. Typically, this means being the user who created the assignment, the assigned user themselves, or having appropriate file access permissions.Input Parameters
Output
Delete teams integration mapping
Delete teams integration mapping
BOX_DELETE_TEAMS_INTEGRATION_MAPPINGDeletes a Microsoft Teams integration mapping that links a Box folder to a Teams channel. This endpoint removes an existing mapping between a Microsoft Teams channel or team and a Box folder created through the Box for Teams integration. After deletion, any new files shared in the Teams channel will be stored in the default location rather than the previously mapped Box folder. Requirements: - Admin or Co-Admin role in the Box enterprise - Box for Teams must be installed in the relevant Microsoft Teams workspace Note: This action is irreversible. Once deleted, a new mapping must be created to restore the integration between the Teams channel and Box folder. For more information, see: https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-TeamsInput Parameters
Output
Remove upload session
Remove upload session
BOX_DELETE_UPLOAD_SESSIONAbort and permanently remove a chunked upload session, discarding all uploaded data. This action is irreversible - once removed, all uploaded file parts are permanently deleted and the upload session cannot be recovered. Use this to cancel an in-progress chunked upload or clean up abandoned upload sessions. Returns HTTP 204 (No Content) on success. The upload_session_id can be obtained from the response of the ‘Create upload session’ or ‘Get upload session’ endpoints.Input Parameters
Output
Delete user
Delete user
BOX_DELETE_USERPermanently deletes a user from the enterprise. By default, deletion fails if the user still owns content, was recently active, or recently joined from a free account. Use the force parameter to bypass these restrictions and delete the user along with all their content. Returns an empty response (HTTP 204) on success.Input Parameters
Output
Delete user avatar
Delete user avatar
BOX_DELETE_USER_AVATARDeletes a Box user’s custom avatar so the user displays the default Box avatar. A 404 is reported as success with no custom avatar found; this result does not distinguish a missing avatar from other causes of a 404.Input Parameters
Output
Remove User Domain Exemption
Remove User Domain Exemption
BOX_DELETE_USER_DOMAIN_EXEMPTIONRemoves a user’s exemption from the enterprise’s collaboration domain restrictions. After removal, the user will be subject to the allowed collaboration domain list configured for the enterprise and can no longer collaborate with users from domains outside of that list. PREREQUISITES: - The exemption must exist (obtain ID from ‘List users exempt from collaboration domain restrictions’ or when creating an exemption). - Requires enterprise admin privileges. - The enterprise must have collaboration domain restrictions enabled. COMMON ERRORS: - 204 No Content: Successful deletion (empty response body). - 403 Forbidden: Insufficient permissions or collaboration domain restrictions feature not enabled for the enterprise. - 404 Not Found: The specified exemption ID does not exist. NOTE: This is a destructive action. Once removed, the exemption cannot be recovered and the user will immediately be subject to domain restrictions.Input Parameters
Output
Remove user from group
Remove user from group
BOX_DELETE_USER_FROM_GROUPDeletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.Input Parameters
Output
Remove watermark from file
Remove watermark from file
BOX_DELETE_WATERMARK_FROM_FILERemoves the watermark from a file. This action deletes the watermark that was previously applied to the specified file. After removal, the file will no longer display watermark overlays when viewed or downloaded. Returns: - 204 No Content: Watermark successfully removed (empty response body) - 404 Not Found: File does not exist or has no watermark applied Note: This operation is idempotent. If the file doesn’t have a watermark, the API will return a 404 error.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Remove watermark from folder
Remove watermark from folder
BOX_DELETE_WATERMARK_FROM_FOLDERRemoves the watermark from a folder. This action deletes the watermark applied to a specified folder. The folder must have a watermark applied to it, otherwise the API will return a 404 error. Only users with Owner, Co-owner, or Editor permissions on the folder can remove watermarks. This feature is available for Box Enterprise plans and above.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Remove webhook
Remove webhook
BOX_DELETE_WEBHOOKDeletes a webhook by ID, stopping notifications for its configured triggers; the application requires the Manage Webhooks scope. On a 204 response, the tool returns a success indicator and confirmation message.Input Parameters
Output
Remove web link
Remove web link
Permanently remove web link
Permanently remove web link
BOX_DELETE_WEB_LINK_PERMANENTLYPermanently deletes a web link that is in the trash. This action cannot be undone.Input Parameters
Output
Download file
Download file
BOX_DOWNLOAD_FILEReturns the contents of a file in binary format.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Download zip archive
Download zip archive
BOX_DOWNLOAD_ZIP_ARCHIVEDownloads a zip archive containing files and/or folders from Box. Prerequisites: You must first call ‘BOX_CREATE_ZIP_DOWNLOAD’ to create a zip download request. The response from that action contains a ‘download_url’ field, from which you should extract the ‘zip_download_id’. Important Notes: - The download URL is only valid for a limited time (typically a few seconds after creation, or 12 hours once the download starts). - Once a download has started, it cannot be stopped and resumed. - If the download fails or times out, create a new zip download request. Returns the zip archive in binary format as a downloadable file.Input Parameters
Output
Extract metadata freeform
Extract metadata freeform
BOX_EXTRACT_METADATA_FREEFORMExtract metadata from Box files using AI with freeform prompts. Use this action to extract custom metadata from files without needing a predefined metadata template. Box AI will analyze the file contents and extract information based on your prompt instructions. Features: - Freeform prompts: Specify exactly what metadata to extract using natural language - Flexible output: Response format adapts to your prompt (can be JSON, key-value pairs, etc.) - No template required: Unlike structured extraction, no metadata template setup needed Limitations: - Text documents: Up to 1MB per file - Maximum 25 files per request - Prompts: Maximum 10,000 characters Requires ‘ai.readwrite’ or ‘manage_ai’ scope in the access token.Input Parameters
Output
Extract metadata structured
Extract metadata structured
BOX_EXTRACT_METADATA_STRUCTUREDExtract structured metadata from files using Box AI. Uses Large Language Models (LLMs) to extract metadata as key-value pairs from files. Requires Box AI access (ai.readwrite scope). Supports two extraction approaches: 1. Using fields: Define custom fields with ‘key’, optional ‘description’, ‘type’, ‘prompt’, and ‘options’. 2. Using metadata_template: Reference an existing Box metadata template by its template_key, type, and scope. You must use EITHER ‘fields’ OR ‘metadata_template’, but NOT both. Supports OCR for images (TIFF, PNG, JPEG) and scanned documents automatically.Input Parameters
Output
Find metadata template by instance id
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. This action is useful when you have a metadata instance ID (the ‘$id’ field from a metadata instance on a file or folder) and need to retrieve the full template definition including all field configurations. Common use case: After listing metadata instances on a file/folder, use this action to get the complete template schema to understand what fields are available.Input Parameters
Output
Force apply metadata cascade policy to folder
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. This operation is asynchronous and returns immediately with HTTP 202 Accepted. Use cases: - After creating a new cascade policy to back-fill metadata on existing content - To retroactively apply metadata changes to all items in a folder hierarchy - When you need to enforce consistent metadata across all folder contents Important notes: - The cascade operation runs asynchronously in the background after the API returns - There is currently no API to check the status of this operation - Use the conflict_resolution parameter carefully to avoid unintended data overwrites - Only works with enterprise-scoped metadata templates (not global templates) - Newly added files/folders will automatically inherit metadata via the existing cascade policy Returns: HTTP 202 Accepted with an empty response body when the cascade operation is queued successfully.Input Parameters
Output
Generate text
Generate text
BOX_GENERATE_TEXTGenerate text using Box AI based on a prompt and file context. This action sends a request to Box AI’s text generation endpoint, which uses Large Language Models (LLMs) to generate text based on your prompt and the content of a specified file. Use cases include: - Summarizing document content - Generating responses based on file content - Creating content drafts using file context - Answering questions about document content Note: Requires Box AI access (Business, Business Plus, Enterprise, or higher plans). Files up to 1MB of text content are supported.Input Parameters
Output
Get AI Agent by ID
Get AI Agent by ID
BOX_GET_AI_AGENTRetrieves detailed information about a specific AI Agent by its unique identifier. Use Cases: - Get the current configuration and capabilities of an AI agent - Check the access state and allowed users/groups for an agent - Retrieve capability settings (ask, text_gen, extract) for an agent Requirements: - Box Enterprise Advanced account with Box AI Studio enabled - “Manage AI” scope must be enabled in the Box Developer Console Example: To get an agent with all capability details, use: agent_id=“1234567890”, fields=[“ask”, “text_gen”, “extract”]Input Parameters
Output
Get ai agent default configuration
Get ai agent default configuration
BOX_GET_AI_AGENT_DEFAULT_CONFIGURATIONRetrieve the default AI agent configuration for a specific mode. Returns the default AI agent settings used by Box AI features. The configuration includes model settings, token limits, LLM endpoint parameters, and tool configurations for text processing, image handling, and spreadsheet operations. Use this to understand or customize the AI agent behavior for ask, text generation, or metadata extraction operations.Input Parameters
Output
Get allowed collaboration domain
Get allowed collaboration domain
BOX_GET_ALLOWED_COLLABORATION_DOMAINRetrieves details of a specific allowed collaboration domain entry within your enterprise. This endpoint returns information about a domain that has been whitelisted for collaboration, including the domain name, the direction of allowed collaborations (inbound, outbound, or both), and the enterprise that owns the entry. Use ‘list_allowed_collaboration_domains’ to get a list of all whitelist entry IDs, or use the ID returned when adding a new domain via ‘add_domain_to_list_of_allowed_collaboration_domains’. Note: This endpoint requires enterprise admin privileges and the ‘manage_enterprise_properties’ scope.Input Parameters
Output
Get box sign request by id
Get box sign request by id
BOX_GET_BOX_SIGN_REQUESTRetrieves the details of a specific Box Sign request by its unique ID. Returns comprehensive information about the signature request including: - Request status (e.g., ‘converting’, ‘created’, ‘sent’, ‘viewed’, ‘signed’, ‘declined’, ‘cancelled’, ‘expired’, ‘error_converting’, ‘error_sending’) - Signers information with their email, role, decision status, and embed URLs - Source files included in the request - Signed document copies available for download (when completed) - Signing log reference - Request timestamps and sender information Note: Requires Box Sign to be enabled for the enterprise account.Input Parameters
Output
Get Box Sign Template by ID
Get Box Sign Template by ID
BOX_GET_BOX_SIGN_TEMPLATERetrieves details of a specific Box Sign template by its unique ID. Returns template configuration including name, email subject/message, signers, source files, destination folder, and various lock settings that control what can be modified when creating signature requests. Note: Templates can only be created and edited via the Box web application. This API is read-only for template data. Required scope: sign_requests.readwriteInput Parameters
Output
Get collaboration
Get collaboration
BOX_GET_COLLABORATIONRetrieves details of a single collaboration by its ID. A collaboration represents shared access between a user/group and a file or folder in Box. This action returns information about who has access, what role they have, and which item the collaboration grants access to.Input Parameters
Output
Get collection by id
Get collection by id
BOX_GET_COLLECTIONRetrieves details of a specific collection by its unique identifier. Collections in Box are used to organize items (files and folders). Currently, Box only supports the ‘favorites’ collection, which contains items that the user has marked as favorites. Use ‘list_all_collections’ to discover available collection IDs. Returns the collection’s id, type, name, and collection_type.Input Parameters
Output
Get comment
Get comment
BOX_GET_COMMENTRetrieves the message and metadata for a specific comment, as well as information on the user who created the comment.Input Parameters
Output
Get current user
Get current user
BOX_GET_CURRENT_USERRetrieves information about the currently authenticated user. For OAuth 2.0 this is normally the user who authorized the app; for JWT authentication it is normally the application’s service account.Input Parameters
Output
Get device pin
Get device pin
BOX_GET_DEVICE_PINRetrieves information about an individual device pin in the enterprise. Device pins are created when users access Box from mobile or desktop devices that support device pinning. This endpoint returns details about a specific device pin including the device type and the user who owns it. The user must have admin privileges and the application needs the ‘manage_enterprise_properties’ scope to make this call.Input Parameters
Output
Get Real-Time Server URL for Long-Polling Events
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. Long-polling allows applications to listen for events in real-time without repeatedly polling the /events endpoint. After calling this endpoint, make a GET request to the returned url to start listening for events. When events occur, the server responds with ‘new_change’ to signal that you should fetch events from GET /events. If no events occur within retry_timeout seconds, you’ll receive ‘reconnect’ and should call this endpoint again to get a fresh URL. Note: Long-polling is only available for user events, not enterprise events.Output
Get file information
Get file information
BOX_GET_FILE_INFORMATIONRetrieves the details about a file.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Get file request
Get file request
BOX_GET_FILE_REQUESTRetrieves detailed information about a file request in Box. File requests are forms that allow external users to upload files to a specific folder without needing a Box account. This action returns the file request’s configuration including its title, description, status, associated folder, and the shareable URL. Note: File request IDs can only be obtained from the Box web application URL (e.g., https://*.app.box.com/filerequest/123). There is no API endpoint to list all file requests.Input Parameters
https://*.app.box.com/filerequest/123 the file_request_id is 123.Output
Get files under retention
Get files under retention
BOX_GET_FILES_UNDER_RETENTIONReturns a paginated list of files under retention for a specific retention policy assignment. This endpoint is part of Box Governance and requires: - ‘manage_retention_policies’ scope enabled for the application - Global Content Manager (GCM) permissions, which must be enabled by Box support The response includes file metadata (id, name, sha1, etag) and file version information. Results are paginated using marker-based pagination.Input Parameters
Output
Get file thumbnail
Get file thumbnail
BOX_GET_FILE_THUMBNAILRetrieves a thumbnail, or smaller image representation, of a file. Sizes of 32x32,64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 160x160, and 320x320 can be returned in the .jpg format. Thumbnails can be generated for the image and video file formats listed [found on our community site][1]. [1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Get file version
Get file version
BOX_GET_FILE_VERSIONRetrieve detailed information about a specific version of a file. This action returns metadata about a file version including its SHA1 hash, size, creation date, and who modified it. Versions are only tracked for Box users with premium accounts. Use BOX_LIST_ALL_FILE_VERSIONS to get a list of all available versions for a file.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Get file version legal hold
Get file version legal hold
BOX_GET_FILE_VERSION_LEGAL_HOLDRetrieves detailed information about a specific file version legal hold by its ID. A file version legal hold represents the preservation of a specific file version due to legal hold policies. This action returns the hold details including which file and file version are held, and which legal hold policy assignments created the hold. Use this action when you need to inspect the legal hold status and details for a specific file version legal hold record.Input Parameters
Output
Get file versions under retention
Get file versions under retention
BOX_GET_FILE_VERSIONS_UNDER_RETENTIONReturns a list of file versions under retention for a specified retention policy assignment. A retention policy assignment links a retention policy to content (enterprise, folder, or metadata template). This endpoint retrieves all file versions that are currently being retained under the specified assignment. Use cases: - Audit which file versions are being retained under a specific policy assignment - Monitor retention compliance for specific folders or metadata templates - Track file versions before their disposition date Prerequisites: - Requires a valid retention_policy_assignment_id (obtain from ‘List retention policy assignments’ endpoint) - Requires the ‘manage_data_retention’ scope enabled for the application Note: Retention policies are an enterprise feature and require Box Governance or similar Box product.Input Parameters
Output
Get folder information
Get folder information
BOX_GET_FOLDERRetrieves details for a folder, including the first 100 entries in the folder. Passing sort, direction, offset, and limit parameters in query allows you to manage the list of returned folder items. To fetch more items within the folder, use the Get items in a folder endpoint.Input Parameters
type first, with folders listed before files, and files listed before web links. * Root folder: This parameter is not supported for marker-based pagination on the root folder (the folder with an id of 0). * Shared folder with parent path to the associated folder visible to the collaborator: Items are always sorted by their type first, with folders listed before files, and files listed before web links.metadata field as well as the scope and key of the template to retrieve, for example ?fields=metadata.enterprise_12345.contractTemplate.ASC) or descending (DESC) order.https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Get group
Get group
BOX_GET_GROUPRetrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.Input Parameters
Output
Get group membership
Get group membership
BOX_GET_GROUP_MEMBERSHIPRetrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.Input Parameters
Output
Get legal hold policy
Get legal hold policy
BOX_GET_LEGAL_HOLD_POLICYRetrieve a legal hold policy by ID, including its name, description, status, assignment counts, creator, and timestamps. The action declares both manage_legal_holds and enterprise_content scopes.Input Parameters
Output
Get legal hold policy assignment
Get legal hold policy assignment
BOX_GET_LEGAL_HOLD_POLICY_ASSIGNMENTRetrieve a legal hold policy assignment by ID, including the policy, assigned item, assigning user, and assignment timestamps. The action declares both manage_legal_holds and enterprise_content scopes.Input Parameters
Output
Get metadata cascade policy
Get metadata cascade policy
Get metadata instance on file
Get metadata instance on file
BOX_GET_METADATA_INSTANCE_ON_FILERetrieves a specific metadata template instance that has been applied to a file. This action returns the metadata key-value pairs for a particular template on a file. Use BOX_LIST_METADATA_INSTANCES_ON_FILE first to discover which templates are applied to a file if you don’t know the scope and template_key. Common error codes: - 404 (instance_not_found): The metadata template has not been applied to this file. - 404 (not_found): The file was not found or the user does not have access. - 403 (forbidden): The user does not have permission to view this metadata. Example usage: - Get global properties: scope=‘global’, template_key=‘properties’ - Get enterprise classification: scope=‘enterprise’, template_key=‘classification’ - Get custom template: scope=‘enterprise’, template_key=‘yourCustomTemplate’Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Get metadata instance on folder
Get metadata instance on folder
BOX_GET_METADATA_INSTANCE_ON_FOLDERRetrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID 0.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Get metadata taxonomies for namespace
Get metadata taxonomies for namespace
BOX_GET_METADATA_TAXONOMIES_FOR_NAMESPACELists metadata taxonomies in a specified namespace. Results are returned one page at a time, with marker and limit parameters available for pagination.Input Parameters
usemarker to be set to true.Output
Get metadata taxonomy by taxonomy key
Get metadata taxonomy by taxonomy key
BOX_GET_METADATA_TAXONOMY_BY_TAXONOMY_KEYRetrieves a metadata taxonomy by its namespace and taxonomy key. Use when you need to fetch detailed information about a specific taxonomy structure.Input Parameters
Output
Get metadata taxonomy node by ID
Get metadata taxonomy node by ID
BOX_GET_METADATA_TAXONOMY_NODE_BY_IDRetrieves a specific node from a metadata taxonomy by its identifier. Use when you need to get details about a particular taxonomy node including its display name, level, and ancestor information.Input Parameters
Output
Get metadata template by id
Get metadata template by id
Get metadata template by name
Get metadata template by name
BOX_GET_METADATA_TEMPLATE_BY_NAMERetrieves a metadata template by its scope and templateKey values. To find the scope and templateKey for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.Input Parameters
Output
Get retention on file
Get retention on file
BOX_GET_RETENTION_ON_FILEReturns information about a file version retention. Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.Input Parameters
Output
Get retention policy
Get retention policy
BOX_GET_RETENTION_POLICYRetrieves a retention policy by its unique ID. Retention policies define how long content is retained before being automatically deleted or having the retention removed. This is an enterprise-level feature that requires the ‘manage_data_retention’ OAuth scope to be enabled. Returns details including policy name, retention length, disposition action, status, and assignment counts.Input Parameters
Output
Get retention policy assignment
Get retention policy assignment
BOX_GET_RETENTION_POLICY_ASSIGNMENTRetrieves a retention policy assignment by its unique ID. A retention policy assignment represents a link between a retention policy and its target (a folder, the enterprise, or a metadata template). This action returns details about where and how the retention policy is applied. Requires Box Governance license and scopes: manage_data_retention, enterprise_content.Input Parameters
Output
Get shield information barrier with specified id
Get shield information barrier with specified id
BOX_GET_SHIELD_INFORMATION_BARRIER_BY_IDRetrieves a shield information barrier by its unique ID. Shield information barriers are used to separate individuals/groups within the same enterprise and prevent confidential information from passing between them. Note: This feature requires Box Shield enterprise licensing. Returns 404 if the barrier ID doesn’t exist or if Shield is not enabled for the enterprise.Input Parameters
Output
Get shield information barrier report by id
Get shield information barrier report by id
Get shield information barrier segment with specified 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. Shield information barriers are used to prevent conflicts of interest by restricting communication between specific groups of users. Segments define groups of users within a barrier. Note: This feature requires Box Shield, which is an enterprise-level add-on. The API will return 404 if Shield is not enabled for the enterprise.Input Parameters
Output
Get shield information barrier segment member by 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. Shield Information Barriers enforce compliance by restricting collaboration between departments (e.g., Investment Banking vs Research in financial institutions). Returns details about a user’s segment assignment including when added, by whom, and which barrier/segment. Prerequisites: Box Shield license, valid member ID from create/list operations. Returns 200 on success, 404 if not found or feature disabled. Related: create_shield_information_barrier_segment_member, list_shield_information_barrier_segment_membersInput Parameters
Output
Get shield information barrier segment restriction by 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. Shield information barrier segment restrictions define which segments cannot communicate or collaborate with each other. This action fetches the details of a specific restriction including the requesting segment, restricted segment, and the parent barrier information. Note: This feature requires Box Shield subscription and enterprise-level access.Input Parameters
Output
Get storage policy
Get storage policy
BOX_GET_STORAGE_POLICYFetches a specific storage policy by its ID. Storage policies define the geographic location where content is stored (data residency). This is an enterprise feature that requires Box Zones or similar subscription. Use this action to get details about a storage policy, including its name and the geographic region(s) it covers. To find available storage policy IDs, first use the ‘list_storage_policies’ action.Input Parameters
Output
Get storage policy assignment
Get storage policy assignment
BOX_GET_STORAGE_POLICY_ASSIGNMENTRetrieves information about a specific storage policy assignment. Storage policies control where data is physically stored (data residency). This action requires the Box Zones add-on or equivalent enterprise feature. Use ‘list_storage_policy_assignments’ to find assignment IDs for users or the enterprise.Input Parameters
Output
Get task
Get task
BOX_GET_TASKRetrieves detailed information about a specific task in Box. A task is a to-do item that can be assigned to users for a specific file. Tasks can be of type ‘review’ (approval workflow) or ‘complete’ (general task). Use this action to get task details including the associated file, assignees, due date, message, and completion status.Input Parameters
Output
Get task assignment
Get task assignment
BOX_GET_TASK_ASSIGNMENTRetrieves detailed information about a specific task assignment in Box. A task assignment represents a task that has been assigned to a specific user. This endpoint returns information including: - The file associated with the task - The user the task is assigned to - The user who created the assignment - The assignment status (incomplete, completed, approved, or rejected) - Timestamps for assignment, completion, and remindersInput Parameters
Output
Get terms of service
Get terms of service
BOX_GET_TERMS_OF_SERVICERetrieves a specific terms of service by its unique identifier. Returns the full terms of service object including: - Status (enabled/disabled) - Terms text content - Type (managed users or external collaborators) - Associated enterprise information - Creation and modification timestamps Note: This endpoint requires the Terms of Service feature to be enabled for the enterprise. Admin permissions may be required to access this data.Input Parameters
Output
Get trashed file
Get trashed file
BOX_GET_TRASHED_FILERetrieves a file that has been moved to the trash. Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the GET /folders/:id/trash API. To list all items that have been moved to the trash, please use the GET /folders/trash/items API.Input Parameters
https://*.app.box.com/files/123 the file_id is 123) or by listing trashed items. Returns 404 if the file is not found in the trash.Output
Get trashed folder
Get trashed folder
BOX_GET_TRASHED_FOLDERRetrieves a folder that has been moved to the trash. Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the GET /folders/:id/trash API. To list all items that have been moved to the trash, please use the GET /folders/trash/items API.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Get trashed web link
Get trashed web link
BOX_GET_TRASHED_WEB_LINKRetrieves a web link that has been moved to the trash. Returns detailed information about a trashed web link including its original URL, name, description, creator, when it was trashed, and when it will be permanently purged. The web link must exist in the trash (not permanently deleted) for this action to succeed.Input Parameters
Output
Get upload session
Get upload session
BOX_GET_UPLOAD_SESSIONRetrieves detailed information about an existing chunked upload session. Returns the session status including: - Total number of parts expected for the file upload - Size of each part in bytes - Number of parts already processed/uploaded - Session expiration timestamp - Available endpoints for uploading parts, committing, aborting, and checking status Use this action to monitor upload progress or retrieve session endpoints needed to continue a chunked file upload. The upload_session_id is obtained from the ‘Create upload session’ action.Input Parameters
Output
Get user
Get user
BOX_GET_USERRetrieves information about a user in the enterprise. The application and the authenticated user need to have the permission to look up users in the entire enterprise. This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.Input Parameters
Output
Get user avatar
Get user avatar
Get user exempt from collaboration domain restrictions
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. This endpoint returns information about a user who has been granted an exemption from the enterprise’s collaboration domain allowlist, allowing them to collaborate with external parties from any domain. PREREQUISITES: - The enterprise MUST have collaboration domain restrictions enabled. - The authenticated user must have admin privileges. - The exemption ID must exist (obtained from creating an exemption or listing exempt users). COMMON ERRORS: - 403 Forbidden: Enterprise doesn’t have collaboration domain restrictions enabled, or the authenticated user lacks admin permissions. - 404 Not Found: The specified exemption ID does not exist. USE CASE: Use this to verify a specific user’s exemption status or retrieve exemption metadata after creating or discovering an exemption ID.Input Parameters
Output
Get user invite status
Get user invite status
BOX_GET_USER_INVITE_STATUSReturns the status of a user invite. This endpoint retrieves detailed information about a specific invite, including: - The invited user’s details (email, name, ID) - The enterprise they were invited to - The user who created the invite - The invite status (e.g., ‘pending’, ‘accepted’) - Creation and modification timestamps Note: The invite_id must be obtained from creating an invite using the BOX_CREATE_USER_INVITE action. This endpoint requires the ‘manage_enterprise’ scope.Input Parameters
Output
Get watermark on file
Get watermark on file
BOX_GET_WATERMARK_ON_FILERetrieve the watermark for a file. Returns the watermark information (created_at and modified_at timestamps) for a file that has a watermark applied. If the file does not have a watermark, a 404 Not Found error is returned. Prerequisites: - The file must exist in Box - A watermark must have been applied to the file using BOX_APPLY_WATERMARK_TO_FILE Use BOX_APPLY_WATERMARK_TO_FILE to apply a watermark to a file first if needed.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Get watermark for folder
Get watermark for folder
BOX_GET_WATERMARK_ON_FOLDERRetrieve the watermark for a folder.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Get webhook
Get webhook
BOX_GET_WEBHOOKRetrieves detailed information about a specific webhook by its ID. Use this action to get the configuration of an existing webhook, including the target item being monitored (file or folder), the notification URL, the event triggers, and who created the webhook. Note: This action requires the ‘Manage Webhooks’ scope to be enabled for the application. The webhook must exist and be accessible to the authenticated user.Input Parameters
Output
Get web link
Get web link
BOX_GET_WEB_LINKRetrieve detailed information about a web link (bookmark) in Box. Returns the full web link object including its URL, name, description, parent folder, path collection, creation and modification timestamps, and ownership details. Web links are bookmarks to external URLs stored in Box folders.Input Parameters
Output
Get zip download status
Get zip download status
BOX_GET_ZIP_DOWNLOAD_STATUSGet the download status of a zip archive, including progress, skipped items, and current state. Prerequisites: Call ‘BOX_CREATE_ZIP_DOWNLOAD’ first to get a zip_download_id, then initiate the download via ‘BOX_DOWNLOAD_ZIP_ARCHIVE’. The status endpoint is only accessible after the download starts and remains valid for 12 hours. Skipped files/folders indicate permission issues.Input Parameters
Output
List ai agents
List ai agents
BOX_LIST_AI_AGENTSLists AI agents using the supplied filters and pagination parameters. HTTP 404 responses are returned as an empty agent list.Input Parameters
ask, text_gen, and extract.enabled, disabled and enabled_for_selected_users.Output
List all classifications
List all classifications
List all collections
List all collections
BOX_LIST_ALL_COLLECTIONSRetrieves all collections for a given user. Currently, only the favorites collection is supported.Input Parameters
Output
List all file versions
List all file versions
BOX_LIST_ALL_FILE_VERSIONSRetrieve a list of the past versions for a file. Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the GET /file/:id API.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
List all global metadata templates
List all global metadata templates
BOX_LIST_ALL_GLOBAL_METADATA_TEMPLATESUsed to retrieve all generic, global metadata templates available to all enterprises using Box.Input Parameters
usemarker to be set to true.Output
List allowed collaboration domains
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.Input Parameters
usemarker to be set to true.Output
List box sign requests
List box sign requests
BOX_LIST_BOX_SIGN_REQUESTSLists Box Sign requests created by the user or shared with them as a collaborator, with an optional sender filter for shared requests. Requests whose sign files or parent folder have been deleted do not appear in the list.Input Parameters
usemarker to be set to true.shared_requests must be set to true.true, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the user access level of the sign files of the request. Default is false. Must be set to true if senders are provided.Output
List box sign templates
List box sign templates
List box skill cards on file
List box skill cards on file
BOX_LIST_BOX_SKILL_CARDS_ON_FILEList the Box Skills metadata cards that are attached to a file.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
List collection items
List collection items
BOX_LIST_COLLECTION_ITEMSRetrieves the files and/or folders contained within a Box collection. Collections in Box are used to organize content. Currently, Box supports one type of collection: ‘Favorites’, which allows users to mark files and folders for quick access. Use this action to: - List all files and folders in a user’s Favorites collection - Paginate through large collections using offset and limit parameters - Request specific fields to reduce response size Note: To get the collection_id, first use the ‘List all collections’ action (BOX_LIST_ALL_COLLECTIONS).Input Parameters
Output
List enterprise device pins
List enterprise device pins
BOX_LIST_ENTERPRISE_DEVICE_PINSLists a page of device pins within an enterprise, with marker-based pagination. The user must have admin privileges and the application needs the manage enterprise scope.Input Parameters
usemarker to be set to true.ASC) or descending (DESC) order.Output
List groups for enterprise
List groups for enterprise
BOX_LIST_ENTERPRISE_GROUPSRetrieves a page of groups for the enterprise, optionally filtered by name prefix. The user must have admin permissions to inspect enterprise groups.Input Parameters
Output
List all metadata templates for 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 enterpriseInput Parameters
usemarker to be set to true.Output
List enterprise users
List enterprise users
BOX_LIST_ENTERPRISE_USERSLists a page of enterprise users, including ID, name and login, optionally filtered by name or login, user type, or external app user ID. The application and authenticated user need permission to look up users across the enterprise.Input Parameters
usemarker to be set to true.marker field that can be passed as a parameter to this endpoint to get the next page of the response.all returns every kind of user for whom the login or name partially matches the filter_term. It will only return an external user if the login matches the filter_term completely, and in that case it will only return that user. * managed returns all managed and app users for whom the login or name partially matches the filter_term. * external returns all external users for whom the login matches the filter_term exactly.name or login start with the search term. For externally managed users, the search term needs to completely match the in order to find the user, and it will only return one user at a time.external_app_user_id value. When creating an app user, an external_app_user_id value can be set. This value can then be used in this endpoint to find any users that match that external_app_user_id value.Output
List user and enterprise events
List user and enterprise events
BOX_LIST_EVENTSReturns up to a year of past events for a given user or for the entire enterprise. By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the stream_type to admin_logs_streaming for live monitoring of new events, or admin_logs for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope manage enterprise properties checked.Input Parameters
stream_type of admin_logs or adming_logs_streaming. For any other stream_type this value will be ignored.all returns everything for a user and is the default * changes returns events that may cause file tree changes such as file updates or collaborations. * sync is similar to changes but only applies to synced folders * admin_logs returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for programmatically pulling from a 1 year history of events across all users within the enterprise and within a created_after and created_before time frame. The complete history of events will be returned in chronological order based on the event time, but latency will be much higher than admin_logs_streaming. * admin_logs_streaming returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for polling for recent events across all users within the enterprise. Latency will be much lower than admin_logs, but events will not be returned in chronological order and may contain duplicates.stream_type of admin_logs. For any other stream_type this value will be ignored.stream_type of admin_logs. For any other stream_type this value will be ignored.now will return an empty list events and the latest stream position for initialization. * 0 or null will return all events.Output
List file app item associations
List file app item associations
BOX_LIST_FILE_APP_ITEM_ASSOCIATIONSLists a page of app items associated with a file, including associations inherited from its ancestors. This beta feature may have limited availability; users with access to the file can see app item types and IDs even without View permission on the app item.Input Parameters
next_marker value from a previous response to get the next page of results.https://*.app.box.com/files/123 the file_id is 123.Output
List file collaborations
List file collaborations
BOX_LIST_FILE_COLLABORATIONSRetrieves a page of pending and active collaborations for a file, representing users or groups granted or invited to access it.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
List file comments
List file comments
BOX_LIST_FILE_COMMENTSRetrieves a list of comments for a file.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Review files on legal hold policy assignment
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. In some cases you may want to get previous file versions instead. In these cases, use the GET /legal_hold_policy_assignments/:id/file_versions_on_hold API instead to return any previous versions of a file for this legal hold policy assignment. Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The GET /file_version_legal_holds API can be used to fetch current and past versions of files held within the legacy architecture. This endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub. The GET /legal_hold_policy_assignments?policy_id={id} API can be used to find a list of policy assignments for a given policy ID.Input Parameters
Output
List file version legal holds
List file version legal holds
BOX_LIST_FILE_VERSION_LEGAL_HOLDSLists file version legal holds for a legal hold policy. Results may be incomplete because this API returns only versions held in the legacy architecture.Input Parameters
Output
List file version retentions
List file version retentions
BOX_LIST_FILE_VERSION_RETENTIONSRetrieves all file version retentions for the given enterprise. Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.Input Parameters
usemarker to be set to true.Output
List folder app item associations
List folder app item associations
BOX_LIST_FOLDER_APP_ITEM_ASSOCIATIONSThis is a beta feature, which means that its availability might be limited. Returns all app items the folder is associated with. This includes app items associated with ancestors of the folder. Assuming the context user has access to the folder, the type/ids are revealed even if the context user does not have View permission on the app item.Input Parameters
next_marker field returned in a previous response.https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
List folder collaborations
List folder collaborations
BOX_LIST_FOLDER_COLLABORATIONSRetrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123.Output
List folder locks
List folder locks
BOX_LIST_FOLDER_LOCKSRetrieves folder lock details for a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. Note: The root folder (ID 0) does not support folder locks.Output
List group collaborations
List group collaborations
BOX_LIST_GROUP_COLLABORATIONSRetrieves a page of collaborations for a group, including the files or folders the group can access and its role. The user must have admin permissions to inspect enterprise groups.Input Parameters
Output
List members of group
List members of group
BOX_LIST_GROUP_MEMBERSRetrieve a page of members for a group using offset-based pagination. Only members of the group or users with admin-level permissions can use this API.Input Parameters
Output
List previous file versions for legal hold policy assignment
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. This endpoint returns file versions held under the new Box architecture. For current (latest) file versions, use BOX_REVIEW_FILES_ON_LEGAL_HOLD_POLICY_ASSIGNMENT instead. For file versions in the legacy architecture, use BOX_LIST_FILE_VERSION_LEGAL_HOLDS. Note: Due to ongoing re-architecture efforts, this API might not return all file versions held for this policy ID. This endpoint does not support returning content that is on hold due to a Custodian collaborating on a Hub. Requires the ‘manage_legal_holds’ scope and Legal Hold feature enabled for the enterprise.Input Parameters
Output
List Box Hubs
List Box Hubs
List items in folder
List items in folder
BOX_LIST_ITEMS_IN_FOLDERRetrieves a page of items in a folder. These items can be files, folders, and web links. To request more information about the folder itself, like its size, use the Get a folder endpoint instead.Input Parameters
type first, with folders listed before files, and files listed before web links. * Root folder: This parameter is not supported for marker-based pagination on the root folder (the folder with an id of 0). * Shared folder with parent path to the associated folder visible to the collaborator: Items are always sorted by their type first, with folders listed before files, and files listed before web links.metadata field as well as the scope and key of the template to retrieve, for example ?fields=metadata.enterprise_12345.contractTemplate.usemarker to be set to true.ASC) or descending (DESC) order.https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.marker field that can be passed as a parameter to this endpoint to get the next page of the response.Output
List all legal hold policies
List all legal hold policies
BOX_LIST_LEGAL_HOLD_POLICIESRetrieves a list of legal hold policies that belong to an enterprise.Input Parameters
usemarker to be set to true.Output
List legal hold policy assignments
List legal hold policy assignments
BOX_LIST_LEGAL_HOLD_POLICY_ASSIGNMENTSRetrieves a list of items a legal hold policy has been assigned to.Input Parameters
Output
List metadata cascade policies
List metadata cascade policies
BOX_LIST_METADATA_CASCADE_POLICIESRetrieve a page of metadata cascade policies applied to a folder. This cannot be used on the root folder with ID 0.Input Parameters
usemarker to be set to true.0.Output
List metadata instances on file
List metadata instances on file
BOX_LIST_METADATA_INSTANCES_ON_FILERetrieves all metadata instances applied to a file. Returns all metadata template instances that have been applied to the specified file, including both enterprise and global templates. The API does not support pagination and will return all metadata instances in a single response.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
List metadata instances on folder
List metadata instances on folder
BOX_LIST_METADATA_INSTANCES_ON_FOLDERRetrieves all metadata for a given folder. This can not be used on the root folder with ID 0.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
List metadata taxonomy nodes
List metadata taxonomy nodes
BOX_LIST_METADATA_TAXONOMY_NODESRetrieves metadata taxonomy nodes based on the specified parameters. Use when you need to browse or search hierarchical metadata classifications in Box. Results are sorted in lexicographic order unless a query parameter is passed, in which case results are sorted by relevance.Input Parameters
Output
List pending collaborations
List pending collaborations
BOX_LIST_PENDING_COLLABORATIONSRetrieves a page of pending collaboration invites for the current user, with offset and limit pagination.Input Parameters
Output
List recently accessed items
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.Input Parameters
usemarker to be set to true.Output
List retention policies
List retention policies
BOX_LIST_RETENTION_POLICIESLists retention policies for an enterprise, with optional filters. Results are paginated using a marker.Input Parameters
Output
List retention policy assignments
List retention policy assignments
BOX_LIST_RETENTION_POLICY_ASSIGNMENTSLists retention policy assignments for a specified policy, optionally filtered by enterprise, folder, or metadata-template assignment type. Results are paginated using a marker; the action requires the manage_retention_policies scope.Input Parameters
Output
List shield information barrier reports
List shield information barrier reports
BOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTSLists Shield information barrier reports for a specified barrier with marker-based pagination. Report objects can include status, creation timestamps, barrier references, and the folder ID for the report; this feature requires Box Shield.Input Parameters
Output
List shield information barriers
List shield information barriers
List shield information barrier segment members
List shield information barrier segment members
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERSLists Shield information barrier segment members for a specified segment ID, with marker-based pagination.Input Parameters
next_marker in the previous response to get the next page.Output
List shield information barrier segment restrictions
List shield information barrier segment restrictions
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONSLists all shield information barrier segment restrictions for a specific segment. Shield information barrier segment restrictions define which segments are prevented from collaborating with each other. This endpoint retrieves all restrictions where the specified segment is the requesting segment (the segment whose members are restricted from collaborating with other segments). Note: This feature requires Box Shield add-on and enterprise admin privileges. Returns 404 if Shield is not enabled for your enterprise or if the segment ID does not exist. Use Cases: - View all collaboration restrictions for a specific segment - Audit compliance boundaries between organizational divisions - Paginate through large sets of restrictions using marker-based paginationInput Parameters
Output
List shield information barrier segments
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. Shield Information Barriers are used to separate individuals/groups within the same enterprise to prevent confidential information from passing between them. Segments define the groups of users that are separated by the barrier. Note: This is an enterprise-level feature that requires Box Shield to be enabled. Returns a 404 error if Shield Information Barriers is not available for the enterprise.Input Parameters
Output
List slack integration mappings
List slack integration mappings
BOX_LIST_SLACK_INTEGRATION_MAPPINGSLists Slack integration mappings in a users’ enterprise. You need Admin or Co-Admin role to use this endpoint.Input Parameters
usemarker to be set to true.Output
List storage policies
List storage policies
BOX_LIST_STORAGE_POLICIESLists storage policies in the enterprise, returning a page of results with pagination markers.Input Parameters
usemarker to be set to true.Output
List storage policy assignments
List storage policy assignments
BOX_LIST_STORAGE_POLICY_ASSIGNMENTSLists storage policy assignments for a specified enterprise or user, returning a page of results.Input Parameters
usemarker to be set to true.Output
List task assignments
List task assignments
BOX_LIST_TASK_ASSIGNMENTSLists all of the assignments for a given task. Returns a collection of task assignment objects showing who has been assigned to complete or review a task. Each assignment includes the assigned user’s details, the assignment status, and the associated file information. This endpoint does not support pagination as tasks typically have a limited number of assignees.Input Parameters
Output
List tasks on file
List tasks on file
BOX_LIST_TASKS_ON_FILERetrieves a list of all the tasks for a file. This endpoint does not support pagination.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
List teams integration mappings
List teams integration mappings
BOX_LIST_TEAMS_INTEGRATION_MAPPINGSLists Teams integration mappings in a users’ enterprise. You need Admin or Co-Admin role to use this endpoint.Input Parameters
Output
List terms of services
List terms of services
List terms of service user statuses
List terms of service user statuses
BOX_LIST_TERMS_OF_SERVICE_USER_STATUSESLists user acceptance statuses for a specific terms of service, optionally filtered by user. The action declares both manage enterprise properties and manage users scopes.Input Parameters
Output
List trashed items
List trashed items
BOX_LIST_TRASHED_ITEMSRetrieves the files and folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the fields parameter to retrieve those specific attributes that are not returned by default. This endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the marker parameter.Input Parameters
type first, with folders listed before files, and files listed before web links. This parameter is not supported when using marker-based pagination.usemarker to be set to true.ASC) or descending (DESC) order.marker field that can be passed as a parameter to this endpoint to get the next page of the response.Output
List upload session parts
List upload session parts
BOX_LIST_UPLOAD_SESSION_PARTSList the parts (chunks) that have been uploaded to a chunked upload session. This is useful for tracking upload progress, verifying which parts have been successfully uploaded, and determining which parts still need to be uploaded. The upload_session_id is obtained from the ‘Create upload session’ action. Note: Chunked uploads are only for files larger than 20MB.Input Parameters
Output
List user's email aliases
List user's email aliases
List user's groups
List user's groups
BOX_LIST_USER_GROUPSRetrieves a page of a user’s group memberships, including the groups and roles. Only group members or users with admin-level permissions can use this API.Input Parameters
Output
List users exempt from collaboration domain restrictions
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. Note: This endpoint requires an enterprise account with collaboration domain restrictions enabled. A 403 Forbidden error will be returned if the feature is not available for the enterprise.Input Parameters
usemarker to be set to true.Output
List all webhooks
List all webhooks
BOX_LIST_WEBHOOKSReturns all defined webhooks for the requesting application. This API only returns webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.Input Parameters
Output
List workflows
List workflows
BOX_LIST_WORKFLOWSLists Box Relay workflows configured for a specific folder. Use the ‘trigger_type’ parameter to filter workflows by trigger type (e.g., ‘WORKFLOW_MANUAL_START’ for workflows that can be manually started via API). Your application must be authorized to use the ‘Manage Box Relay’ application scope within the Box developer console. Returns a paginated list of workflow objects with their flows and outcomes.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Preflight check before upload
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. This helps verify permissions, quota, and filename conflicts before starting the actual upload. A successful response (HTTP 200) indicates the upload can proceed. A 409 Conflict response indicates a file with the same name already exists.Input Parameters
Output
Promote file version
Promote file version
BOX_PROMOTE_FILE_VERSIONPromote a specific version of a file. If previous versions exist, this method can be used to promote one of the older versions to the top of the version history. This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, etag, and name as the original. Other properties such as comments do not get updated to their former values. Don’t use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Query files folders by metadata
Query files folders by metadata
BOX_QUERY_FILES_FOLDERS_BY_METADATAQuery files and folders by metadata using SQL-like syntax. Returns items that have metadata instances matching the specified template and optional query conditions. Use this action when you need to find files/folders based on their metadata values rather than searching by file name or content. This is useful for locating documents based on custom attributes like status, category, department, dates, etc. Examples: - Find all files with a specific metadata template: set from_ to “enterprise_XXXXX.templateKey” - Find files in a specific folder: set ancestor_folder_id to the folder ID (use “0” for all folders) - Filter by metadata values: use query and query_params (e.g., query=“status = :val”, query_params={“val”: “approved”}) Note: Classification templates cannot be queried with this endpoint.Input Parameters
created_by will add the details of the user who created the item to the response. * metadata.<scope>.<templateKey> will return the mini-representation of the metadata instance identified by the scope and templateKey. * metadata.<scope>.<templateKey>.<field> will return all the mini-representation of the metadata instance identified by the scope and templateKey plus the field specified by the field name. Multiple fields for the same scope and templateKey can be defined.direction must be the same for each item in the array.Output
Refresh access token
Refresh access token
BOX_REFRESH_ACCESS_TOKENRefresh an Access Token using its client ID, secret, and refresh token. This endpoint exchanges a refresh token for a new access token. The refresh token must be valid (they expire after 60 days). Each time a refresh token is used, it is invalidated and a new one is returned along with the new access token. Access tokens expire after 1 hour and need to be refreshed periodically. Note: This action requires valid OAuth2 credentials (client_id, client_secret, and a valid refresh_token) that cannot be automatically generated.Input Parameters
Output
Request access token
Request access token
BOX_REQUEST_ACCESS_TOKENRequests a Box access token using an authorization code, JWT assertion, client credentials, refresh token, or token exchange for downscoping. The returned token can be used for Box API calls within its permitted scope.Input Parameters
authorization_code as the grant_type.subject_token will need to have all of these scopes or the call will error with 401 Unauthorized.urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.authorization_code, client_credentials, or urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.authorization_code, client_credentials, or urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.refresh_token as the grant_type.urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.client_credentials as the grant_type. Value is determined by box_subject_type. If user use user ID and if enterprise use enterprise ID.actor_token passed in. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.subject_token passed in. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.Output
Resend Box Sign Request
Resend Box Sign Request
BOX_RESEND_BOX_SIGN_REQUESTResends signature request emails to all outstanding signers. Use this when a signer did not receive the original email, the email was lost, or the signer accidentally deleted it. The email is sent asynchronously after the API call returns. Rate limit: Can only be called once every 10 minutes per sign request. Note: For automated reminders, consider setting ‘are_reminders_enabled’ to true when creating the sign request, which sends automatic reminder emails after 3, 8, 13, and 18 days. Requires Box Sign feature to be enabled and sign_requests.readwrite scope.Input Parameters
Output
Restore file
Restore file
BOX_RESTORE_FILERestores a file that has been moved to the trash. An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.Input Parameters
https://*.app.box.com/files/123 the file_id is 123). Returns 404 if the file is not found in the trash.Output
Restore file version
Restore file version
BOX_RESTORE_FILE_VERSIONRestores a specific version of a file after it was deleted (trashed). This action restores a file version that was previously moved to the trash by setting its trashed_at field back to null. Do not use this endpoint to restore Box Notes - it only works with standard file formats such as PDF, DOC, PPTX, or similar. To restore a file version: 1. First use ‘List all file versions’ to find versions with trashed_at set 2. Then call this action with the file_id and file_version_id The restored version will have trashed_at=null and restored_at/restored_by fields populated.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Restore folder
Restore folder
BOX_RESTORE_FOLDERRestores a folder that has been moved to the trash. An optional new parent ID can be provided to restore the folder to in case the original folder has been deleted. During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder. For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Restore web link
Restore web link
BOX_RESTORE_WEB_LINKRestores a web link that has been moved to the trash. This action recovers a trashed web link and restores it to its original parent folder. If the original folder has been deleted, you can optionally specify an alternative parent folder using the parent_id parameter. You can also rename the web link during restoration using the name parameter. The web link must exist in the trash (not permanently deleted) for this action to succeed. Returns the restored web link with item_status changed from ‘trashed’ to ‘active’.Input Parameters
Output
Revoke access token
Revoke access token
Search for content
Search for content
BOX_SEARCH_FOR_CONTENTSearches for files, folders, web links, and shared files across the users content or across the entire enterprise.Input Parameters
relevance (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurrence of the search term in the items name, description, content, and additional properties. * modified_at returns the results ordered in descending order by date at which the item was last modified.file - Limits the search results to files * folder - Limits the search results to folders * web_link - Limits the search results to web links, also known as bookmarksuser_content, which limits the search results to content that is available to the currently authenticated user. The enterprise_content can be requested by an admin through our support channels. Once this scope has been enabled for a user, it will allow that use to query for content across the entire enterprise and not only the content that they have access to.DESC) order unless this parameter is explicitly specified. When results are sorted by relevance the ordering is locked to returning items in descending order of relevance, and this parameter is ignored.name - The name of the item, as defined by its name field. * description - The description of the item, as defined by its description field. * file_content - The actual content of the file. * comments - The content of any of the comments on a file or folder. * tags - Any tags that are applied to an item, as defined by its tags field.non_trashed_only). * trashed_only - Only searches for items currently in the trash * non_trashed_only - Only searches for items currently not in the trash * all_items - Searches for both trashed and non-trashed items.enterprise_content scope parameter which can be requested with our support team.,2014-05-17T13:35:01-07:00) anything created before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00,) the current date will be used as the end date instead.2014-05-17T13:35:01-07:00), anything deleted before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00), the current date will be used as the end date instead. The trash_content parameter needs to be set to trashed_only. If searching in trash is not performed, then an empty result is returned. Data available from 2023-02-01 onwards.trash_content parameter needs to be set to trashed_only. If searching in trash is not performed, an empty result set is returned. The items need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users, an empty result set is returned. Data available from 2023-02-01 onwards.,2014-05-17T13:35:01-07:00) anything updated before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00,) the current date will be used as the end date instead.HTTP 404 error code will be returned instead. To search across an entire enterprise, we recommend using the enterprise_content scope parameter which can be requested with our support team.Output
Starts workflow based on request body
Starts workflow based on request body
BOX_START_WORKFLOWStarts a Box Relay workflow with trigger type WORKFLOW_MANUAL_START. Prerequisites: - Your application must have the ‘Manage Box Relay’ scope enabled in the Box Developer Console. - Use the ‘List Workflows’ endpoint to get the workflow_id, flow.id, and folder.id. - All files specified must exist in the workflow’s configured folder. Workflow: 1. Call ‘List Workflows’ with the folder_id to get available workflows. 2. From the response, extract: workflow.id, flows[].id, and any outcome IDs if needed. 3. Call this endpoint with the extracted IDs and the file IDs to process. Returns HTTP 204 No Content on success.Input Parameters
Output
Create jobs to terminate user group session
Create jobs to terminate user group session
BOX_TERMINATE_USER_GROUP_SESSIONSTerminates all active sessions for users belonging to the specified Box enterprise groups. This action validates the roles and permissions of each group, then creates asynchronous background jobs to terminate sessions for all users in those groups. The operation is processed asynchronously - check admin events to monitor job status. Requires admin privileges. Use this to enforce security policies or respond to security incidents affecting entire groups.Input Parameters
Output
Create jobs to terminate users session
Create jobs to terminate users session
BOX_TERMINATE_USER_SESSIONSCreates asynchronous jobs to terminate active Box sessions for specified users. Use this when a user account may be compromised, a device is lost/stolen, or you need to force users to re-authenticate. This logs out users from all active sessions including web, desktop, and mobile apps. Both user_ids and user_logins parameters are required. Returns HTTP 202 on success with an async job created.Input Parameters
Output
Transfer owned folders
Transfer owned folders
BOX_TRANSFER_OWNED_FOLDERSTransfers all files and folders owned by one user to another user’s account in Box. This creates a new folder in the destination user’s root directory containing all the source user’s content. The operation is commonly used for employee offboarding, role transitions, or account consolidation. Important: This operation is irreversible and requires enterprise admin permissions. All existing shared links and folder-level collaborations are preserved during transfer.Input Parameters
Output
Trim metadata taxonomy levels
Trim metadata taxonomy levels
BOX_TRIM_METADATA_TAXONOMY_LEVELSDeletes the last level from a metadata taxonomy by trimming it. Use when you need to remove the deepest hierarchical level from a taxonomy structure.Input Parameters
Output
Unassign legal hold policy
Unassign legal hold policy
BOX_UNASSIGN_LEGAL_HOLD_POLICYRemove a legal hold policy assignment from an item (user, folder, file, or file version). This endpoint unassigns a legal hold policy by deleting the assignment record. When successful, the API returns a 202 Accepted response with an empty body. IMPORTANT: This is an asynchronous operation - the legal hold is not fully removed when the response returns. The removal process continues in the background. To get the assignment ID: - Use ‘assign_legal_hold_policy’ and capture the returned ‘id’ field - Or use ‘list_legal_hold_policy_assignments’ to find existing assignment IDs Prerequisites: - Box Enterprise account with Box Governance add-on - OAuth scope: ‘manage_legal_hold’ - Admin-level permissions on the Box account Use case: Remove legal holds when litigation is resolved or content no longer needs to be preserved for compliance purposes.Input Parameters
Output
Update AI Agent
Update AI Agent
BOX_UPDATE_AI_AGENTUpdates an existing custom AI agent in Box AI Studio. You can modify the agent’s name, access settings, icon, and capability configurations (ask, text_gen, extract). Requirements: - Box Enterprise Advanced account with Box AI Studio enabled - “Manage AI” scope must be enabled in the Box Developer Console Usage Notes: - The type field must always be set to ‘ai_agent’ - Only custom agents (origin=‘CUSTOM’) can be updated; Box default agents cannot be modified - When updating capabilities, provide all required fields (type, access_state, description) - Use enabled_for_selected_users access_state with allowed_entities to restrict access Example: To update an agent’s name and enable the ask capability: agent_id=“1234567890”, name=“Updated Agent”, access_state=“enabled”, ask_type=“ai_agent_ask”, ask_access_state=“enabled”, ask_description=“Ask questions about documents”Input Parameters
Output
Update all box skill cards on file
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. IMPORTANT: This endpoint is designed for Box Skills applications. The skill_id parameter must be a valid Box-assigned skill invocation ID that is received in the webhook payload when Box triggers a skill on a file. This ID is NOT a user-created identifier. Use Cases: - Update skill card metadata after processing a file with a custom Box Skill - Report processing status (success, failure, in-progress) back to Box - Overwrite existing skill cards with new results from ML/AI processing For creating skill cards on files without a skill invocation ID, use: - ‘create_box_skill_cards_on_file’ to add new skill cards - ‘list_box_skill_cards_on_file’ to view existing skill cards - ‘remove_box_skill_cards_from_file’ to delete skill cardsInput Parameters
Output
Update shield information barrier segment with specified id
Update shield information barrier segment with specified id
BOX_UPDATE_BARRIER_SEGMENTUpdates a shield information barrier segment’s name and/or description. Shield Information Barrier segments represent organizational divisions (e.g., ‘Investment Banking’, ‘Research’, ‘Trading’) that need to be isolated from each other for regulatory compliance or information security purposes. Use this action to modify a segment’s identifying information after creation. At least one of ‘name’ or ‘description’ should be provided. Requirements: - Box Shield license is required to use this feature - The segment must exist (obtained from list_shield_information_barrier_segments) - Admin permissions are required to update segments Returns 404 if segment not found, 409 if name conflicts with an existing segment.Input Parameters
Output
Update box skill cards on 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. This action allows you to selectively update specific skill cards by their index position without affecting other cards. Use the ‘replace’ operation to modify existing cards at specified positions (e.g., /cards/0 for the first card). NOTE: This updates existing cards in place. To view existing cards first, use ‘list_box_skill_cards_on_file’. To add new cards, use ‘create_box_skill_cards_on_file’. To remove all cards, use ‘remove_box_skill_cards_from_file’.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Update collaboration
Update collaboration
BOX_UPDATE_COLLABORATIONUpdates a collaboration, including its role and optionally its invitation status, expiration, or path visibility. A role is required even when accepting an invitation or changing another setting.Input Parameters
pending collaboration invitation, effectively accepting, or rejecting the invite.can_view_path enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a can_view_path of true. can_view_path can only be used for folder collaborations.Output
Update comment
Update comment
BOX_UPDATE_COMMENTUpdate the message of a comment.Input Parameters
Output
Update file
Update file
BOX_UPDATE_FILEUpdates a file, including renaming or moving it, changing its description or tags, and creating a lock.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.favorites collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array [] or null will remove the file from all collections. [1]: e://get-collectionsopen for everyone or company for the other members of the user”s enterprise. This setting overrides the download permissions that are normally part of the role of a collaboration. When set to company, this essentially removes the download option for external users with viewer or editor a roles. Note: When passing parameters as JSON, use ‘permissions__can__download’ (with double underscores).Output
Update file request
Update file request
BOX_UPDATE_FILE_REQUESTUpdates a file request in Box. File requests allow external users to upload files to a specific folder without needing a Box account. Use this action to modify file request settings such as title, description, status, and form requirements. Common use cases: - Activate or deactivate a file request by changing its status - Update the title or description shown to uploaders - Set or change form requirements (email, description) - Set an expiration date for the file request Note: File request IDs can only be obtained from the Box web application URL. There is no API endpoint to list all file requests. To find a file_request_id, navigate to the file request in Box web UI and copy the ID from the URL (e.g., https://*.app.box.com/filerequest/123).Input Parameters
Output
Update folder
Update folder
BOX_UPDATE_FOLDERUpdates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.favorites collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array [] or null will remove the folder from all collections. [1]: e://get-collectionsfalse, it is required to also set can_non_owners_invite_collaborators to false if it has not already been set.Output
Update group
Update group
BOX_UPDATE_GROUPUpdates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.Input Parameters
Active Directory, or Okta. Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.admins_only the enterprise admin, co-admins, and the group”s admin can invite the group. When set to admins_and_members all the admins listed above and group members can invite the group. When set to all_managed_users all managed users in the enterprise can invite the group.admins_only - the enterprise admin, co-admins, group”s group admin * admins_and_members - all admins and group members * all_managed_users - all managed users in the enterpriseOutput
Update group membership
Update group membership
BOX_UPDATE_GROUP_MEMBERSHIPUpdates a user’s group membership. Only admins of this group or users with admin-level permissions will be able to use this API.Input Parameters
Output
Update legal hold policy
Update legal hold policy
BOX_UPDATE_LEGAL_HOLD_POLICYUpdate the name, description, or release notes of an existing Box legal hold policy. Legal hold policies preserve content for litigation or compliance purposes.Input Parameters
Output
Update metadata instance on file
Update metadata instance on file
BOX_UPDATE_METADATA_INSTANCE_ON_FILEUpdates a metadata instance on a file using JSON-Patch operations. The metadata template must already be applied to the file before it can be updated. Only values that match the template schema are accepted. The update is atomic - if any operation fails, no changes are applied.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Update metadata instance on folder
Update metadata instance on folder
BOX_UPDATE_METADATA_INSTANCE_ON_FOLDERUpdates metadata on a folder using JSON-Patch operations (RFC 6902). The metadata template must already be applied to the folder. Only values matching the template schema are accepted (except global.properties which accepts any key-value pairs). All operations are applied atomically - if any fail, no changes are made.Input Parameters
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Output
Update metadata taxonomy
Update metadata taxonomy
BOX_UPDATE_METADATA_TAXONOMYTool to update an existing metadata taxonomy’s display name. Use when you need to rename a taxonomy while keeping its structure and key intact.Input Parameters
Output
Update metadata taxonomy node
Update metadata taxonomy node
Update metadata template
Update metadata template
BOX_UPDATE_METADATA_TEMPLATEUpdates a metadata template by applying JSON-Patch operations. The template must already exist. The update is applied atomically - if any error occurs during the application of operations, the metadata template will not be changed. Use this to modify template properties, add/edit/remove fields, or manage enum/multiSelect options.Input Parameters
Output
Update retention policy
Update retention policy
BOX_UPDATE_RETENTION_POLICYUpdates an existing Box retention policy. Use this action to modify retention policy settings such as name, description, retention duration, disposition action, and notification settings. Requires Box Governance add-on and ‘manage retention policies’ scope. Note: Non-modifiable policies have limited update options (can only extend duration, add folders, retire policy, or change notification settings).Input Parameters
Output
Change shield information barrier status
Change shield information barrier status
BOX_UPDATE_SHIELD_INFORMATION_BARRIER_STATUSChange the status of a shield information barrier. Shield information barriers are ethical walls that prevent exchanges or communication between individuals/groups within the same enterprise to avoid conflicts of interest. This action allows you to: - Set status to ‘pending’: Transition a barrier from ‘draft’ status in preparation for enablement - Set status to ‘disabled’: Deactivate an enabled or pending barrier Note: Barriers cannot be directly enabled via this endpoint. The ‘enabled’ status is set automatically by Box after all required segments and restrictions are configured on a ‘pending’ barrier.Input Parameters
Output
Update slack integration mapping
Update slack integration mapping
BOX_UPDATE_SLACK_INTEGRATION_MAPPINGUpdates an existing Slack integration mapping. Use this to change which Box folder is mapped to a Slack channel, or to update configuration options like automatic access management. Requires Admin or Co-Admin role and the ‘manage_enterprise_properties’ scope. At least one of ‘box_item’ or ‘options’ must be provided.Input Parameters
Output
Update storage policy assignment
Update storage policy assignment
BOX_UPDATE_STORAGE_POLICY_ASSIGNMENTUpdates a storage policy assignment for an enterprise or user. Storage policies control where data is stored geographically (data residency). Use this action to change which storage policy is assigned to a user or enterprise. This action requires Box Zones or similar enterprise feature to be enabled and admin-level permissions with ‘manage_enterprise_properties’ scope. Use ‘list_storage_policies’ to get available policies and ‘list_storage_policy_assignments’ to find existing assignment IDs.Input Parameters
Output
Update task
Update task
BOX_UPDATE_TASKUpdates a task’s configuration, including its action, message, due date, or completion rule.Input Parameters
Output
Update task assignment
Update task assignment
BOX_UPDATE_TASK_ASSIGNMENTUpdates a task assignment to change its resolution state or add a message. This endpoint allows updating the state of a task assigned to a user. Use this to mark tasks as completed, approved, rejected, or incomplete, and optionally add a message explaining the decision. Important notes: - Only the assignee can typically update their own task assignment - For ‘complete’ action tasks: use ‘completed’ or ‘incomplete’ - For ‘review’ action tasks: use ‘approved’, ‘rejected’, or ‘incomplete’ - At least one of ‘message’ or ‘resolution_state’ should be providedInput Parameters
Output
Update teams integration mapping
Update teams integration mapping
BOX_UPDATE_TEAMS_INTEGRATION_MAPPINGUpdates a Microsoft Teams integration mapping that links a Box folder to a Teams channel. This endpoint allows you to change which Box folder is associated with a Microsoft Teams channel through the Box for Teams integration. After updating, any new files shared in the Teams channel will be stored in the newly mapped Box folder. Requirements: - Admin or Co-Admin role in the Box enterprise - The ‘manage_enterprise_properties’ scope - Box for Teams must be installed in the relevant Microsoft Teams workspace Use Cases: - Reorganize where Teams channel files are stored in Box - Move team collaboration content to a different department folder - Update mappings after folder restructuring For more information, see: https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-TeamsInput Parameters
Output
Update terms of service
Update terms of service
BOX_UPDATE_TERMS_OF_SERVICEUpdates an existing terms of service for the enterprise. This action allows you to modify the status (enabled/disabled) and text content of an existing terms of service. When enabled, users will be prompted to accept the terms before accessing Box content. Note: This endpoint requires enterprise admin permissions with ‘Edit settings for your company’ enabled. The Terms of Service feature must also be enabled for the enterprise in the Box Admin Console. Use ‘list_terms_of_services’ to find the terms_of_service_id to update.Input Parameters
Output
Update terms of service status for existing user
Update terms of service status for existing user
BOX_UPDATE_TERMS_OF_SERVICE_STATUS_FOR_EXISTING_USERUpdates an existing user’s terms-of-service acceptance status by status record ID. The action declares the manage_enterprise scope.Input Parameters
Output
Update user
Update user
BOX_UPDATE_USERUpdates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.Input Parameters
Output
Update webhook
Update webhook
BOX_UPDATE_WEBHOOKUpdates an existing webhook’s configuration. Use this action to modify a webhook’s target item (file or folder), notification URL, or event triggers. Only the fields provided in the request will be updated; omitted fields remain unchanged. Requirements: - The notification URL must use HTTPS on port 443 - The URL must respond with HTTP 200-299 within 30 seconds - Requires ‘Manage Webhooks’ scope enabled for the application Note: When changing the target, both target_id and target_type must be provided together.Input Parameters
Output
Update web link
Update web link
BOX_UPDATE_WEB_LINKUpdates a web link object. This action allows you to modify an existing web link’s properties including: - Changing the URL destination - Updating the name and description - Moving it to a different folder - Configuring shared link settings (access level, password, vanity URL, expiration) All fields except web_link_id are optional - only provide the fields you want to update.Input Parameters
Output
Upload file
Upload file
BOX_UPLOAD_FILEUploads a small file to Box. For file sizes over 50MB we recommend using the Chunk Upload APIs. The attributes part of the body must come before the file part. Requests that do not follow this format when uploading the file will receive a HTTP 400 error with a metadata_after_file_contents error code.Input Parameters
Output
Upload file version
Upload file version
BOX_UPLOAD_FILE_VERSIONUpdate a file’s content. For file sizes over 50MB we recommend using the Chunk Upload APIs. The attributes part of the body must come before the file part. Requests that do not follow this format when uploading the file will receive a HTTP 400 error with a metadata_after_file_contents error code.Input Parameters
https://*.app.box.com/files/123 the file_id is 123.Output
Upload part of file
Upload part of file
BOX_UPLOAD_PART_OF_FILEUploads a chunk of a file for an upload session. The actual endpoint URL is returned by the Create upload session and Get upload session endpoints. Requirements: - Chunked uploads require files with a minimum size of 20MB - Each part’s size must match the part_size from the upload session (except the last part) - The offset must be a multiple of the part_size - Parts cannot overlap with previously uploaded partsInput Parameters
Output
Triggers
Collaboration Details Changed
Collaboration Details Changed
BOX_COLLABORATION_DETAILS_CHANGED_TRIGGERType: pollTriggers when a collaboration’s details change (e.g., role, status, expiration).This trigger monitors a specific collaboration and detects when any meaningful field changes, such as role, status, expiration date, access type, or acknowledgment status.Configuration
Payload
Comment Changed
Comment Changed
New File Comment Added
New File Comment Added
BOX_FILE_COMMENT_ADDED_TRIGGERType: pollTriggers when a new comment is added to a file in Box.This trigger monitors a specific Box file and fires when new comments are detected.Configuration
Payload
File Metadata Changed
File Metadata Changed
BOX_FILE_METADATA_CHANGED_TRIGGERType: pollTriggers when a file’s metadata or properties change in Box.This trigger monitors a specific Box file and fires when changes are detected in key fields like name, description, size, modification time, parent folder, or status.Configuration
Payload
New File Version Uploaded
New File Version Uploaded
BOX_FILE_VERSION_UPLOADED_TRIGGERType: pollTriggers when a new file version is uploaded to a file in Box.This trigger monitors a specific Box file and fires when new versions are detected.Configuration
https://*.app.box.com/files/123 the file_id is 123.Payload
New Item Added to Folder
New Item Added to Folder
BOX_FOLDER_ITEM_ADDED_TRIGGERType: pollTriggers when a new item (file, folder, or web link) is added to a folder in Box.This trigger monitors a specific Box folder and fires when new items are detected.Configuration
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Payload
Folder Properties Changed
Folder Properties Changed
BOX_FOLDER_PROPERTIES_CHANGED_TRIGGERType: pollTriggers when a folder’s core properties change in Box.This trigger monitors a specific Box folder and fires when changes are detected in properties like name, description, modification time, parent folder, item status, or shared link settings.Configuration
Payload
New File Added to Folder
New File Added to Folder
BOX_NEW_FILE_ADDED_TRIGGERType: pollTriggers when a new file is added to a folder in Box.This trigger monitors a specific Box folder and fires when new files are detected. Only files (not folders or web links) are monitored.Configuration
https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.Payload
New Folder Collaboration Created
New Folder Collaboration Created
BOX_NEW_FOLDER_COLLABORATION_CREATED_TRIGGERType: pollTriggers when a new collaboration is created on a specific folder in Box.This trigger monitors a specific Box folder and fires when new collaborations are detected.Configuration
https://*.app.box.com/folder/123 the folder_id is 123.Payload
New Pending Collaboration Invite
New Pending Collaboration Invite
New Sign Request Created
New Sign Request Created
New Task Assignment Added
New Task Assignment Added
BOX_NEW_TASK_ASSIGNMENT_TRIGGERType: pollTriggers when a new assignment is added to a task in Box.This trigger monitors a specific Box task and fires when new assignments are detected.Configuration
Payload
New Task Created on File
New Task Created on File
BOX_NEW_TASK_CREATED_TRIGGERType: pollTriggers when a new task is created on a Box file.This trigger monitors a specific Box file and fires when new tasks are detected.Configuration
https://*.app.box.com/files/123 the file_id is 123.Payload
Box Sign Request Status Changed
Box Sign Request Status Changed
BOX_SIGN_REQUEST_STATUS_CHANGED_TRIGGERType: pollTriggers when a Box Sign request’s status or meaningful fields change.This trigger monitors a specific Box Sign request and fires when changes are detected in key fields like status, signer decisions, document readiness, or completion state.Configuration
Payload
Task Assignment State Changed
Task Assignment State Changed
BOX_TASK_ASSIGNMENT_STATE_CHANGED_TRIGGERType: pollTriggers when a task assignment’s state changes.This trigger monitors task assignments for a specific task and detects when the resolution_state changes (e.g., from incomplete to completed, or from completed to approved/rejected).Configuration
Payload
Task State Changed
Task State Changed
BOX_TASK_STATE_CHANGED_TRIGGERType: pollTriggers when a task’s status or details change in Box.This trigger monitors a specific Box task and fires when changes are detected in key fields like status, due date, message, or completion state.Configuration
Payload
Trashed File State Changed
Trashed File State Changed
BOX_TRASHED_FILE_STATE_CHANGED_TRIGGERType: pollTriggers when a file’s trash state changes in Box.This trigger monitors a specific Box file and fires when its trash state changes (e.g., moved to trash or restored from trash).Configuration
Payload
Trashed Folder State Changed
Trashed Folder State Changed
BOX_TRASHED_FOLDER_STATE_CHANGED_TRIGGERType: pollTriggers when a folder’s trash state changes in Box.This trigger monitors a specific Box folder and fires when its trash state changes (e.g., moved to trash or restored from trash).
BOX_COMMENT_CHANGED_TRIGGERType: pollTriggers when a comment’s content or details change in Box.This trigger monitors a specific Box comment and detects when any meaningful field changes, such as message text edits, tagged message changes, or modification timestamp updates.Configuration
Payload