Box API
Tools that enable LLMs to interact directly with the box API.
1.0.0
BoxApi provides tools enabling LLMs to interact directly with the Box API, facilitating various file and folder operations within a Box environment.
Capabilities
- Manage files, folders, and metadata.
- Collaborate with users through invitations and shared links.
- Monitor upload sessions, download statuses, and event logs.
- Handle legal hold and retention policies.
- Integrate with third-party applications like Slack and Teams.
OAuth
- Provider: Unknown
- Scopes: None
Secrets
- No secrets are required for using this toolkit.
Available tools(188)
| Tool name | Description | Secrets | |
|---|---|---|---|
Abort an upload session and discard all uploaded data.
Use this tool to abort an ongoing upload session and discard all uploaded data. This action is irreversible, so it should be called when the user wants to cancel an upload session. | |||
Cancel an existing sign request to stop further processing.
This tool cancels a sign request based on the provided sign request ID, preventing any further action on it. | |||
Retrieve the status of a specific user invite.
This tool is used to get the current status of a user invite by its ID. | |||
Check the status of a zip archive download.
Use this tool to inspect the download progress of a zip archive, including the number of skipped items. This endpoint should be accessed after the download starts and is available for 12 hours. Follow the `status_url` obtained from the Create zip download API. | |||
Removes an AI agent by its ID.
This tool is used to delete an AI agent by specifying the agent's ID. It should be called when an AI agent needs to be removed from the system. | |||
Permanently delete an archive by ID.
Use this tool to permanently delete an archive using its unique ID. This action cannot be undone. | |||
Delete a specific file version from Box.
Use this tool to move a specific version of a file to the trash on Box. Applicable only for users with premium accounts. | |||
Delete a specific Box Hub using its ID.
This tool is used to delete a specific Box Hub by providing its unique hub ID. It should be called when a user wants to remove a particular hub from the Box service. | |||
Remove a specific Box Hub collaboration.
Use this tool to delete a specific collaboration from a Box Hub by providing the collaboration ID. It should be called when you need to remove a user's collaboration access. | |||
Deletes a specified collaboration by ID.
This tool is used to delete a collaboration by providing the specific collaboration ID. It should be called when a collaboration needs to be removed from the system. | |||
Permanently deletes a specific comment by ID.
Use this tool to permanently remove a comment by providing its unique ID. Call this when you need to delete a comment and ensure it's not recoverable. | |||
Delete a specific device pin from the system.
This tool is used to delete a specified device pin by its unique identifier. It should be called when there is a need to remove a device pin. | |||
Delete a file from Box or move it to trash.
This tool deletes a file from Box. Depending on enterprise settings, the file is either permanently deleted or moved to the trash. It should be called when a user requests to remove a file from their Box storage. | |||
Deletes metadata from a specified file.
Use this tool to delete a specific piece of metadata from a file by providing the file ID, metadata scope, and template key. | |||
Permanently delete a specific file request.
Use this tool to permanently delete a file request by its ID. | |||
Delete a folder permanently or move it to the trash.
Use this tool to remove a folder from Box, either permanently or by sending it to the trash. | |||
Delete a specific folder lock if you're the owner or co-owner.
Use this tool to delete a lock on a folder you own or co-own, ensuring that only authorized modifications are permitted. | |||
Deletes metadata from a specified folder.
Use this tool to remove a specific piece of metadata from a folder by providing the folder ID, scope, and template key. | |||
Permanently delete a group with admin permissions.
This tool is used to permanently delete a specified group. Only users with admin-level permissions are able to perform this action. | |||
Delete a specific group membership by ID.
This tool deletes a group membership identified by its ID. It should be used by group admins or users with admin-level permissions to remove a member from a group. | |||
Initiate deletion of a legal hold policy.
Use this tool to start the process of deleting an existing legal hold policy. The deletion is asynchronous, meaning the policy won't be fully deleted when the response is received. | |||
Deletes a metadata cascade policy by ID.
This tool deletes a specified metadata cascade policy using its unique ID. It should be called when you need to remove a cascade policy from your metadata handling. | |||
Permanently delete a metadata template and its instances.
Use this tool to permanently delete a metadata template and all its instances. This action is irreversible and should be used with caution. | |||
Permanently deletes a specified retention policy.
Use this tool to permanently delete a retention policy by its ID. It should be called when there is a need to remove a retention policy completely. | |||
Delete a specific shield barrier segment restriction by ID. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
BoxApi.AbortUploadSession
Abort an upload session and discard all uploaded data. Use this tool to abort an ongoing upload session and discard all uploaded data. This action is irreversible, so it should be called when the user wants to cancel an upload session.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
upload_session_id | string | Required | The unique identifier of the upload session to be aborted. This ID is required to specify which upload session should be cancelled and its data discarded. |
Requirements
Output
json— Response from the API endpoint 'delete_files_upload_sessions_id'.BoxApi.CancelSignRequest
Cancel an existing sign request to stop further processing. This tool cancels a sign request based on the provided sign request ID, preventing any further action on it.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
sign_request_id | string | Required | The unique identifier of the signature request to be cancelled. |
Requirements
Output
json— Response from the API endpoint 'post_sign_requests_id_cancel'.BoxApi.CheckUserInviteStatus
Retrieve the status of a specific user invite. This tool is used to get the current status of a user invite by its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invite_id | string | Required | The unique identifier for the user invite you want to check. This ID is necessary to retrieve the invite's status. |
included_attributes | array<string> | Optional | A list of attributes to include in the response. Specify attributes not normally returned in a standard response. Only the mini representation fields are returned unless explicitly specified. |
Requirements
Output
json— Response from the API endpoint 'get_invites_id'.BoxApi.CheckZipDownloadStatus
Check the status of a zip archive download. Use this tool to inspect the download progress of a zip archive, including the number of skipped items. This endpoint should be accessed after the download starts and is available for 12 hours. Follow the `status_url` obtained from the Create zip download API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
zip_archive_unique_identifier | string | Required | The unique identifier representing the zip archive for which to check download status. Obtainable from the `status_url` in the Create zip download API. |
Requirements
Output
json— Response from the API endpoint 'get_zip_downloads_id_status'.BoxApi.DeleteAiAgent
Removes an AI agent by its ID. This tool is used to delete an AI agent by specifying the agent's ID. It should be called when an AI agent needs to be removed from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_id | string | Required | The unique identifier of the AI agent you want to delete. This ID specifies which agent will be removed. |
Requirements
Output
json— Response from the API endpoint 'delete_ai_agents_id'.BoxApi.DeleteArchive
Permanently delete an archive by ID. Use this tool to permanently delete an archive using its unique ID. This action cannot be undone.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archive_id | string | Required | The unique identifier of the archive to be permanently deleted. This ID is required for the deletion process. |
Requirements
Output
json— Response from the API endpoint 'delete_archives_id_v2025.0'.BoxApi.DeleteBoxFileVersion
Delete a specific file version from Box. Use this tool to move a specific version of a file to the trash on Box. Applicable only for users with premium accounts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for a file in Box. Obtain it from the file's URL in the web app. Example: '123' for URL 'https://*.app.box.com/files/123'. |
file_version_id | string | Required | The unique identifier of the file version to be deleted. Obtainable from the Box platform. |
if_match_etag_value | string | Optional | Pass the item's last observed etag value to ensure it hasn't changed before deletion. Use this to prevent conflicts. |
Requirements
Output
json— Response from the API endpoint 'delete_files_id_versions_id'.BoxApi.DeleteBoxHub
Delete a specific Box Hub using its ID. This tool is used to delete a specific Box Hub by providing its unique hub ID. It should be called when a user wants to remove a particular hub from the Box service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
box_hub_unique_id | string | Required | The unique identifier for a Box Hub, obtainable from the hub's URL. |
Requirements
Output
json— Response from the API endpoint 'delete_hubs_id_v2025.0'.BoxApi.DeleteBoxHubCollaboration
Remove a specific Box Hub collaboration. Use this tool to delete a specific collaboration from a Box Hub by providing the collaboration ID. It should be called when you need to remove a user's collaboration access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hub_collaboration_identifier | string | Required | The unique identifier for the Box Hub collaboration to be deleted. |
Requirements
Output
json— Response from the API endpoint 'delete_hub_collaborations_id_v2025.0'.BoxApi.DeleteCollaboration
Deletes a specified collaboration by ID. This tool is used to delete a collaboration by providing the specific collaboration ID. It should be called when a collaboration needs to be removed from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collaboration_id_to_delete | string | Required | The unique identifier of the collaboration to be deleted. Provide this ID to remove the specified collaboration. |
Requirements
Output
json— Response from the API endpoint 'delete_collaborations_id'.BoxApi.DeleteComment
Permanently deletes a specific comment by ID. Use this tool to permanently remove a comment by providing its unique ID. Call this when you need to delete a comment and ensure it's not recoverable.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | string | Required | The unique identifier of the comment you want to permanently delete. |
Requirements
Output
json— Response from the API endpoint 'delete_comments_id'.BoxApi.DeleteDevicePin
Delete a specific device pin from the system. This tool is used to delete a specified device pin by its unique identifier. It should be called when there is a need to remove a device pin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
device_pin_id | string | Required | The unique identifier of the device pin to be deleted. |
Requirements
Output
json— Response from the API endpoint 'delete_device_pinners_id'.BoxApi.DeleteFileFromBox
Delete a file from Box or move it to trash. This tool deletes a file from Box. Depending on enterprise settings, the file is either permanently deleted or moved to the trash. It should be called when a user requests to remove a file from their Box storage.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique ID representing a file in Box. Found in the URL when viewing a file: https://*.app.box.com/files/{file_id}. |
ensure_no_recent_changes_etag | string | Optional | Pass the file's last observed etag value to ensure it hasn't changed before deletion. If the etag has changed, the operation will fail. |
Requirements
Output
json— Response from the API endpoint 'delete_files_id'.BoxApi.DeleteFileMetadata
Deletes metadata from a specified file. Use this tool to delete a specific piece of metadata from a file by providing the file ID, metadata scope, and template key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for a file, retrievable from the file URL, e.g., `https://*.app.box.com/files/123` where `123` is the ID. |
metadata_scope | string | Required | Specifies the scope of the metadata template. Choose 'global' or 'enterprise'. |
metadata_template_name | string | Required | The name of the metadata template to be deleted from the file. |
Requirements
Output
json— Response from the API endpoint 'delete_files_id_metadata_id_id'.BoxApi.DeleteFileRequest
Permanently delete a specific file request. Use this tool to permanently delete a file request by its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_request_identifier | string | Required | The unique ID representing a file request, extracted from the URL in the file request builder. |
Requirements
Output
json— Response from the API endpoint 'delete_file_requests_id'.BoxApi.DeleteFolder
Delete a folder permanently or move it to the trash. Use this tool to remove a folder from Box, either permanently or by sending it to the trash.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier representing a folder. Determine it by copying the ID from the folder's URL in the Box web application. The root folder ID is '0'. |
ensure_unchanged_etag | string | Optional | Last observed `etag` value to ensure the folder hasn't changed before deletion. If changed, the operation fails with a 412 error. |
delete_recursively | boolean | Optional | Set to true to delete a non-empty folder and all its content recursively. |
Requirements
Output
json— Response from the API endpoint 'delete_folders_id'.BoxApi.DeleteFolderLock
Delete a specific folder lock if you're the owner or co-owner. Use this tool to delete a lock on a folder you own or co-own, ensuring that only authorized modifications are permitted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_lock_identifier | string | Required | The unique ID of the folder lock to be deleted. You must be the owner or co-owner of the folder. |
Requirements
Output
json— Response from the API endpoint 'delete_folder_locks_id'.BoxApi.DeleteFolderMetadata
Deletes metadata from a specified folder. Use this tool to remove a specific piece of metadata from a folder by providing the folder ID, scope, and template key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier for a folder. Obtainable from the folder URL; use '0' for the root folder. |
metadata_template_scope | string | Required | The scope of the metadata template. Choose either 'global' or 'enterprise'. |
metadata_template_name | string | Required | The name of the metadata template to be deleted from the folder. |
Requirements
Output
json— Response from the API endpoint 'delete_folders_id_metadata_id_id'.BoxApi.DeleteGroup
Permanently delete a group with admin permissions. This tool is used to permanently delete a specified group. Only users with admin-level permissions are able to perform this action.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_id | string | Required | The unique identifier of the group to be permanently deleted. Must be used by an admin. |
Requirements
Output
json— Response from the API endpoint 'delete_groups_id'.BoxApi.DeleteGroupMembership
Delete a specific group membership by ID. This tool deletes a group membership identified by its ID. It should be used by group admins or users with admin-level permissions to remove a member from a group.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_membership_id | string | Required | The unique identifier for the group membership to be deleted. Required for specifying which membership to remove. |
Requirements
Output
json— Response from the API endpoint 'delete_group_memberships_id'.BoxApi.DeleteLegalHoldPolicy
Initiate deletion of a legal hold policy. Use this tool to start the process of deleting an existing legal hold policy. The deletion is asynchronous, meaning the policy won't be fully deleted when the response is received.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legal_hold_policy_id | string | Required | The ID of the legal hold policy to delete. This is necessary to identify and initiate the deletion of the specified policy. |
Requirements
Output
json— Response from the API endpoint 'delete_legal_hold_policies_id'.BoxApi.DeleteMetadataCascadePolicy
Deletes a metadata cascade policy by ID. This tool deletes a specified metadata cascade policy using its unique ID. It should be called when you need to remove a cascade policy from your metadata handling.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metadata_cascade_policy_id | string | Required | The unique ID of the metadata cascade policy to be deleted. Ensure it is valid and exists. |
Requirements
Output
json— Response from the API endpoint 'delete_metadata_cascade_policies_id'.BoxApi.DeleteMetadataTemplate
Permanently delete a metadata template and its instances. Use this tool to permanently delete a metadata template and all its instances. This action is irreversible and should be used with caution.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metadata_template_scope | string | Required | Specifies the scope of the metadata template. Allowed values are 'global' or 'enterprise'. |
metadata_template_name | string | Required | The name of the metadata template to be permanently deleted. |
Requirements
Output
json— Response from the API endpoint 'delete_metadata_templates_id_id_schema'.BoxApi.DeleteRetentionPolicy
Permanently deletes a specified retention policy. Use this tool to permanently delete a retention policy by its ID. It should be called when there is a need to remove a retention policy completely.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_policy_id | string | Required | The unique identifier of the retention policy to be permanently deleted. |
Requirements
Output
json— Response from the API endpoint 'delete_retention_policies_id'.BoxApi.DeleteShieldBarrierSegmentRestriction
Delete a specific shield barrier segment restriction by ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
barrier_segment_restriction_id | string | Required | The ID of the shield information barrier segment restriction to delete. |
Requirements
Output
json— Response from the API endpoint 'delete_shield_information_barrier_segment_restrictions_id'.BoxApi.DeleteShieldInformationBarrierSegment
Delete a shield information barrier segment by ID. Use this tool to delete a specific shield information barrier segment by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
shield_information_barrier_segment_id | string | Required | The ID of the shield information barrier segment to delete. This should be a valid string representing the segment's unique identifier. |
Requirements
Output
json— Response from the API endpoint 'delete_shield_information_barrier_segments_id'.BoxApi.DeleteShieldListById
Delete a shield list using its ID. Use this tool to delete a specific shield list by providing its ID. Ideal for managing and updating list configurations when a list is no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
shield_list_id | string | Required | The unique identifier for the shield list to be deleted. Obtainable from the response of fetching all shield lists for the enterprise. |
Requirements
Output
json— Response from the API endpoint 'delete_shield_lists_id_v2025.0'.BoxApi.DeleteSlackIntegrationMapping
Deletes a Slack integration mapping for Box content. This tool deletes a specified Slack integration mapping in Box. It requires admin or co-admin permissions. Use it when a Slack integration mapping needs to be removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
slack_integration_mapping_id | string | Required | The ID of the Slack integration mapping to be deleted. This requires Admin or Co-Admin permission. |
Requirements
Output
json— Response from the API endpoint 'delete_integration_mappings_slack_id'.BoxApi.DeleteStoragePolicyAssignment
Delete a user's storage policy assignment. Use this tool to delete a storage policy assignment for a user. After deletion, the user will inherit the enterprise's default storage policy. Note the rate limit of two deletions per user within 24 hours.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
storage_policy_assignment_id | string | Required | The ID of the storage policy assignment to delete. This is required and identifies which assignment to delete, reverting the user to the default policy. |
Requirements
Output
json— Response from the API endpoint 'delete_storage_policy_assignments_id'.BoxApi.DeleteTaskAssignment
Delete a specific task assignment. Use this tool to remove a specific task assignment by its ID. It confirms the deletion upon successful completion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
task_assignment_id | string | Required | The unique identifier of the task assignment to be deleted. |
Requirements
Output
json— Response from the API endpoint 'delete_task_assignments_id'.BoxApi.DeleteTaskFromFile
Removes a specific task from a file. Use this tool to delete a specific task from a file by providing the task ID. It is useful when tasks need to be removed as part of file management.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
task_identifier | string | Required | The unique identifier for the task to be removed from the file. |
Requirements
Output
json— Response from the API endpoint 'delete_tasks_id'.BoxApi.DeleteTeamsIntegrationMapping
Deletes a Teams integration mapping in Box. Use this tool to delete a Teams integration mapping in Box. Admin or Co-Admin roles are required to perform this action.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
integration_mapping_identifier | string | Required | The ID of the Teams integration mapping to be deleted. Required for identifying the specific mapping. |
Requirements
Output
json— Response from the API endpoint 'delete_integration_mappings_teams_id'.BoxApi.DeleteUserAccount
Delete a user account from the system. Use this tool to delete a user account. Ensure the user does not own content, or use the 'force' option to remove the user along with their files.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The unique identifier for the user to be deleted. Required for specifying which user account to delete. |
send_deletion_notification | boolean | Optional | Indicate whether the user should receive an email notification about the deletion. Set to true to send notification. |
force_delete_user | boolean | Optional | Set to true to delete the user and their files even if they still own content. |
Requirements
Output
json— Response from the API endpoint 'delete_users_id'.BoxApi.DeleteWebhook
Delete a specified webhook. This tool deletes a webhook when provided with its unique identifier. Use it to manage and remove webhooks that are no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_id | string | Required | The unique identifier of the webhook to be deleted. It must be a valid string. |
Requirements
Output
json— Response from the API endpoint 'delete_webhooks_id'.BoxApi.DeleteWebLink
Delete a specified web link based on its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
web_link_id | string | Required | The unique identifier for the web link to be deleted. |
Requirements
Output
json— Response from the API endpoint 'delete_web_links_id'.BoxApi.DownloadFileContent
Retrieve the binary content of a specified file. This tool is used to download the contents of a file from a given file ID. It should be called when access to the file data in binary format is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for the file to download. Obtainable from the file's URL in the web application. |
file_version_to_download | string | Optional | The specific version of the file to retrieve in binary format. |
optional_access_token | string | Optional | A string for an optional access token to pre-authenticate the file download request. Ensure it's scoped for read access only. |
download_byte_range | string | Optional | Specify the byte range for the content to download in the format `bytes={start_byte}-{end_byte}` to define which section of the file to retrieve. |
shared_link_with_optional_password | string | Optional | Provide the shared link URL of the item. Include a password if required, using the format `shared_link=[link]` or `shared_link=[link]&shared_link_password=[password]`. This allows access to files not explicitly shared with the user. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_content'.BoxApi.DownloadZipContent
Download the contents of a zip archive. This tool retrieves the contents of a zip archive from a specified URL, which is valid for a short time. It's useful for downloading the archive to a device, but remember that once a download starts, it cannot be paused or resumed. A new request must be created for a fresh URL.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
zip_archive_unique_id | string | Required | The unique identifier for the zip archive to be downloaded. This ID must be obtained from the 'Create zip download' API response. |
Requirements
Output
json— Response from the API endpoint 'get_zip_downloads_id_content'.BoxApi.FetchBoxSignTemplateDetails
Retrieve details of a specific Box Sign template. This tool is used to fetch information about a specific Box Sign template by its ID. It should be called when users need to access detailed information about a sign template in Box.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
box_sign_template_id | string | Required | The unique identifier for a Box Sign template to retrieve its details. |
Requirements
Output
json— Response from the API endpoint 'get_sign_templates_id'.BoxApi.FetchCommentDetails
Retrieve detailed information about a specific comment. This tool fetches the message, metadata, and creator information for a specified comment ID. It should be used when detailed comment insights are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | string | Required | The unique identifier for the comment whose details are being fetched. This ID is required to retrieve the comment's message, metadata, and creator information. |
include_fields | array<string> | Optional | A list of attributes to include in the response. Only specified fields will be returned along with the mini representation. |
Requirements
Output
json— Response from the API endpoint 'get_comments_id'.BoxApi.FetchEnterpriseStoragePolicies
Fetches all storage policies in the enterprise. Use this tool to retrieve a complete list of storage policies available within an enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_attributes | array<string> | Optional | An array of attribute names to include in the response. Specify attributes not normally returned in a standard response. Only mini representation fields and requested attributes will be returned. |
pagination_marker | string | Optional | Defines the starting position for returning results using marker-based pagination. Requires `usemarker` to be `true`. |
max_items_per_page | integer | Optional | Specify the maximum number of storage policy items to return per page. |
Requirements
Output
json— Response from the API endpoint 'get_storage_policies'.BoxApi.FetchMetadataTemplateById
Retrieve a metadata template using its ID. Use this tool to get detailed information about a specific metadata template by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_id | string | Required | The unique identifier for the metadata template to be retrieved. Provide a valid template ID. |
Requirements
Output
json— Response from the API endpoint 'get_metadata_templates_id'.BoxApi.FetchSafeCollaborationDomain
Retrieve a designated safe collaboration domain within an enterprise. This tool is used to obtain information about a domain that has been marked as safe for creating collaborations within the current enterprise. It should be called when there is a need to verify if a domain can be trusted for collaboration purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collaboration_whitelist_entry_id | string | Required | The ID of the trusted domain entry in the whitelist. Provide this to retrieve its details. |
Requirements
Output
json— Response from the API endpoint 'get_collaboration_whitelist_entries_id'.BoxApi.FetchShieldBarrierReport
Retrieve details of a shield information barrier report by ID. Use this tool to get information about a specific shield information barrier report by providing its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
shield_barrier_report_id | string | Required | The unique ID of the shield information barrier report to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barrier_reports_id'.BoxApi.FetchSignatureRequests
Retrieve signature requests created by a user. Fetches a list of signature requests that have been created by a user. Signature requests won't be listed if their associated files or parent folder are deleted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_marker | string | Optional | Defines the starting point for returning results, used for marker-based pagination. Requires use_marker to be true. |
max_items_per_page | integer | Optional | Specify the maximum number of signature requests to return per page. |
sender_email_list | array<string> | Optional | A list of sender emails to filter the signature requests by sender. `shared_requests` must be `true` if provided. |
include_shared_requests | boolean | Optional | Set to true to include signature requests where the user is a collaborator but not the owner. Must be true if sender emails are provided. |
Requirements
Output
json— Response from the API endpoint 'get_sign_requests'.BoxApi.FetchStoragePolicy
Retrieve details of a specific storage policy. Use this tool to fetch information about a particular storage policy using its ID. It is useful when you need to view or verify details of a storage policy by its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
storage_policy_identifier | string | Required | The unique ID of the storage policy to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'get_storage_policies_id'.BoxApi.FetchStoragePolicyAssignment
Retrieve a storage policy assignment by ID. This tool is used to fetch detailed information about a specific storage policy assignment using its unique ID. Call this tool when you need to get details about a particular storage policy assignment in the Box storage system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
storage_policy_assignment_id | string | Required | The unique identifier of the storage policy assignment to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get_storage_policy_assignments_id'.BoxApi.FetchStoragePolicyAssignments
Retrieve storage policy assignments for enterprise or user. Use this tool to fetch all storage policy assignments associated with a specific enterprise or user, providing insights into storage management configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
target_type_for_assignments | string | Required | Specifies whether to return storage policy assignments for a 'user' or 'enterprise'. |
target_user_or_enterprise_id | string | Required | The ID of the user or enterprise to fetch storage policy assignments for. |
pagination_marker | string | Optional | Defines the position marker to start returning results for pagination. Requires 'usemarker' to be true. |
Requirements
Output
json— Response from the API endpoint 'get_storage_policy_assignments'.BoxApi.FindMetadataTemplate
Retrieve metadata template details by ID. Use this tool to find and retrieve details of a metadata template by searching for the ID of a template instance.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metadata_instance_id | string | Required | The ID of the metadata template instance to retrieve details for. |
pagination_position_marker | string | Optional | Defines the starting position for marker-based pagination results. Requires `usemarker` to be `true`. |
items_per_page_limit | integer | Optional | Specify the maximum number of items to return per page for pagination purposes. |
Requirements
Output
json— Response from the API endpoint 'get_metadata_templates'.BoxApi.GetAiAgentDefaultConfig
Retrieve the default configuration for the AI agent. Call this tool to get the default settings and configurations for the AI agent. Useful for understanding the baseline setup or preparing to customize AI agent parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_mode | string | Required | Specifies the mode to filter and return the agent configuration. Options: 'ask', 'text_gen', 'extract', 'extract_structured'. |
agent_config_language_code | string | Optional | The ISO language code to specify the language for the AI agent configuration. Default is returned if unsupported. |
model_identifier | string | Optional | Specify the model name to retrieve the default agent configuration. Ensure it matches the supported model names. |
Requirements
Output
json— Response from the API endpoint 'get_ai_agent_default'.BoxApi.GetAiAgentDetails
Retrieve details of a specific AI agent by ID. Call this tool to get detailed information about a specific AI agent using their unique agent ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_unique_identifier | string | Required | The unique identifier of the AI agent to retrieve details for. |
fields_to_return | array<string> | Optional | List of specific fields to return in the response for the AI agent details. |
Requirements
Output
json— Response from the API endpoint 'get_ai_agents_id'.BoxApi.GetAuthenticatedUserInfo
Retrieve details of the currently authenticated user. This tool retrieves information about the user who is currently authenticated via OAuth 2.0 or JWT. It can also be used with the `As-User` header to retrieve information on behalf of another user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
requested_user_attributes | array<string> | Optional | List of user attributes to include in the response. Use to request non-standard fields, results in basic fields only unless specified. |
Requirements
Output
json— Response from the API endpoint 'get_users_me'.BoxApi.GetBoxDocgenJobDetails
Retrieve details of a Box Doc Gen job using its ID. This tool fetches detailed information about a specific Box Doc Gen job, identified by its job ID. It should be called when details about a particular document generation task in Box are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
box_doc_gen_job_id | string | Required | The unique identifier for the Box Doc Gen job you want details for. |
Requirements
Output
json— Response from the API endpoint 'get_docgen_jobs_id_v2025.0'.BoxApi.GetBoxDocgenTemplateDetails
Fetch details of a specific Box Doc Gen template. Call this tool to retrieve detailed information about a specific template from Box Doc Gen using its template ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
box_docgen_template_id | string | Required | The ID of the Box Doc Gen template to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'get_docgen_templates_id_v2025.0'.BoxApi.GetBoxEvents
Retrieve up to a year of past events for a user or enterprise. Fetches past events for a specific user by default, or for the entire enterprise if the stream type is set. Requires admin privileges and appropriate application scope for enterprise events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_stream_type | string | Optional | Specifies the category of events to retrieve. Options: 'all' for all user events, 'changes' for file updates, 'sync' for synced folders, 'admin_logs' for full enterprise events (requires admin), and 'admin_logs_streaming' for live enterprise events (requires admin). |
event_stream_start_position | string | Optional | Specifies where to start receiving events in the stream. Use 'now' for initialization or '0' to retrieve all events. |
event_limit | integer | Optional | The maximum number of events to retrieve. Fewer events may be returned if already available. |
event_type_filter | array<string> | Optional | List of event types to filter by. Only applicable for 'admin_logs' or 'admin_logs_streaming' stream types. |
event_start_date | string | Optional | The start date and time for filtering events. Used only with 'admin_logs' stream type. |
event_time_upper_bound | string | Optional | The upper bound date and time for returning events, used only with 'admin_logs' stream type. Ignored for other stream types. |
Requirements
Output
json— Response from the API endpoint 'get_events'.BoxApi.GetBoxHubCollaborationDetails
Retrieve details for a Box Hub collaboration by ID. Use this tool to obtain information about a specific Box Hub collaboration by providing the collaboration ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hub_collaboration_id | string | Required | The unique identifier for the specific Box Hub collaboration you want to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'get_hub_collaborations_id_v2025.0'.BoxApi.GetBoxHubs
Retrieve all Box Hubs for the user. This tool retrieves all the Box Hubs associated with the requesting user. It should be called when there's a need to list or display the user's Box Hubs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hub_search_query | string | Optional | The string to search for specific Box Hubs. Use keywords to refine search results. |
hub_scope | string | Optional | Specifies which Box Hubs to retrieve. Options: `editable`, `view_only`, `all`. Default is `all`. |
sort_results_by | string | Optional | Field to sort Box Hubs by: `name`, `updated_at`, `last_accessed_at`, `view_count`, `relevance` (default: `relevance`). |
sort_direction | string | Optional | Specify the sort order: 'ASC' for ascending or 'DESC' for descending. |
pagination_start_marker | string | Optional | Defines the position marker to begin returning results, used for marker-based pagination. |
max_items_per_page | integer | Optional | The maximum number of Box Hubs to return per page. Use for pagination control. |
Requirements
Output
json— Response from the API endpoint 'get_hubs_v2025.0'.BoxApi.GetBoxSignTemplates
Retrieve Box Sign templates created by a user. Call this tool to get a list of all Box Sign templates that have been created by a specific user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_marker | string | Optional | The starting position marker for result pagination. Requires `usemarker` to be set to `true`. |
max_items_per_page | integer | Optional | The maximum number of templates to return in a single response. |
Requirements
Output
json— Response from the API endpoint 'get_sign_templates'.BoxApi.GetBoxSkillsMetadata
Retrieve Box Skills metadata cards for a given file. This tool is used to list the Box Skills metadata cards that are attached to a specific file in Box. It should be called when you need to obtain metadata information about the skills applied to a file.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_id | string | Required | The unique identifier for the file in Box. Obtainable from the file's URL in the Box web app. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_metadata_global_boxSkillsCards'.BoxApi.GetClassificationMetadata
Retrieve classification metadata template for the enterprise. This tool retrieves classification metadata templates and lists all classifications available to a specified enterprise. It can be used to understand the security classification options within the enterprise.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema'.BoxApi.GetCollaborationDetails
Retrieve details of a specific collaboration. Use this tool to obtain information about a specific collaboration by its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collaboration_id | string | Required | The unique identifier for the collaboration to retrieve details about. |
include_fields | array<string> | Optional | List of specific attributes to include in the response, which are not typically returned. Specify explicitly to retrieve these fields. |
Requirements
Output
json— Response from the API endpoint 'get_collaborations_id'.BoxApi.GetCollaborationWhitelistExemptUser
Retrieve user exempt from collaboration restrictions. This tool retrieves information about a user who is exempt from collaboration domain restrictions. It should be called when there is a need to identify such exempt users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exemption_target_id | string | Required | The ID of the user who is exempt from collaboration domain restrictions. This ID is required to retrieve specific user details. |
Requirements
Output
json— Response from the API endpoint 'get_collaboration_whitelist_exempt_targets_id'.BoxApi.GetCollaborationWhitelistExemptUsers
Retrieve users exempt from collaboration restrictions. Use this tool to obtain a list of users who are not restricted by collaboration domain rules. It provides a quick way to identify exempt users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_position_marker | string | Optional | Start position for returning results. Used for marker-based pagination. Requires `usemarker` set to `true`. |
max_items_per_page | integer | Optional | The maximum number of users to return per page. Controls pagination size. |
Requirements
Output
json— Response from the API endpoint 'get_collaboration_whitelist_exempt_targets'.BoxApi.GetDevicePinInfo
Retrieve details of a specific device pin. This tool fetches information about a specific device pin by its identifier. It should be called when detailed information about a particular device pin is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
device_pin_identifier | string | Required | The unique identifier for the device pin to retrieve information about. |
Requirements
Output
json— Response from the API endpoint 'get_device_pinners_id'.BoxApi.GetEnterpriseBoxHubs
Retrieve Box Hubs for an enterprise. This tool retrieves all Box Hubs for a specified enterprise. It should be used by admins or Hub Co-admins with GCM scope to get information about the enterprise's Box Hubs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query_for_box_hubs | string | Optional | The search query string to find specific Box Hubs within an enterprise. |
sort_results_by | string | Optional | The field to sort the Box Hubs by. Options: 'name', 'updated_at', 'last_accessed_at', 'view_count', 'relevance'. Default is 'relevance'. |
sort_direction | string | Optional | The direction to sort results: alphabetical ascending ('ASC') or descending ('DESC'). |
pagination_marker | string | Optional | The starting position marker for returning results, used in marker-based pagination. |
max_items_per_page | integer | Optional | The maximum number of Box Hubs to return per page. This controls the page size for the result set. |
Requirements
Output
json— Response from the API endpoint 'get_enterprise_hubs_v2025.0'.BoxApi.GetEnterpriseDevicePins
Retrieve all device pins for a specific enterprise. This tool should be used to retrieve all device pins within a specified enterprise. It requires admin privileges and the application needs the 'manage enterprise' scope to access the data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_id | string | Required | The unique identifier for the enterprise whose device pins are to be retrieved. This is a mandatory field. |
pagination_start_marker | string | Optional | Defines the starting position for paginated results. Requires 'usemarker' to be true. |
max_items_per_page | integer | Optional | The maximum number of device pins to retrieve per page. |
sort_direction | string | Optional | The direction to sort results: alphabetical ascending ('ASC') or descending ('DESC'). |
Requirements
Output
json— Response from the API endpoint 'get_enterprises_id_device_pinners'.BoxApi.GetEnterpriseRetentionPolicies
Retrieve all retention policies for an enterprise. This tool retrieves all retention policies associated with an enterprise. Use it to get a comprehensive list of retention policies.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_policy_name_prefix | string | Optional | Filter results using a case-sensitive prefix for retention policy names. |
filter_by_retention_policy_type | string | Optional | Filter retention policies by type: 'finite' or 'indefinite'. |
filter_by_creator_user_id | string | Optional | Filters the retention policies by the ID of the user who created them. Provide the user ID for specific filtering. |
include_fields | array<string> | Optional | A list of attributes to include in the response, replacing standard fields unless specified. |
maximum_items_per_page | integer | Optional | The maximum number of retention policies to return per page. |
pagination_start_marker | string | Optional | Defines the position marker to begin returning results for marker-based pagination. |
Requirements
Output
json— Response from the API endpoint 'get_retention_policies'.BoxApi.GetEnterpriseShieldLists
Retrieve all shield lists for the enterprise. This tool retrieves all security shield lists available within an enterprise, providing information on the protection settings implemented.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get_shield_lists_v2025.0'.BoxApi.GetEnterpriseTermsOfService
Retrieve the enterprise's terms of service. This tool fetches the most recent terms of service text and settings for the enterprise. Use it to obtain or verify the terms currently in effect.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
terms_of_service_type | string | Optional | Specify the type of terms of service to retrieve. Options are 'external' or 'managed'. |
Requirements
Output
json— Response from the API endpoint 'get_terms_of_services'.BoxApi.GetFileAppAssociations
Retrieve app items associated with a specific file. This tool retrieves all app items associated with a specified file, including those linked to its ancestors. It reveals type/ids even if the user lacks View permission on the app item, assuming the user has access to the file.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique ID representing a file in Box. Can be obtained from the file URL. |
items_per_page_limit | integer | Optional | The maximum number of items to return per page. |
pagination_marker | string | Optional | Defines the position marker for pagination. Required if using marker-based pagination. Ensure `usemarker` is set to `true`. |
filter_by_application_type | string | Optional | Specify the application type to filter and return only app items related to it. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_app_item_associations'.BoxApi.GetFileClassificationMetadata
Retrieve classification metadata for a specific file. Fetches the applied classification metadata instance for a given file using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for a file, obtained from the file's URL in the Box web application. For example, in `https://*.app.box.com/files/123`, the `file_id` is `123`. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_metadata_enterprise_securityClassification-6VMVochwUWo'.BoxApi.GetFileCollaborations
Retrieve collaborations for a specific file. Fetches pending and active collaborations for a file, showing all users with access or invitations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique file ID needed to retrieve collaborations. Obtainable from the file's URL in the web app. |
requested_fields | array<string> | Optional | A list of specific attributes to include in the response. These fields are not typically included and override the standard response fields. |
max_items_per_page | integer | Optional | The maximum number of collaboration items to return per page in the response. Useful for paginating results. |
pagination_start_marker | string | Optional | Specifies the position marker for starting result pagination. Requires 'usemarker' set to 'true'. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_collaborations'.BoxApi.GetFileComments
Retrieve comments for a specific file. This tool retrieves a list of comments associated with a given file. It should be called when you need to access comments on a file identified by its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique file ID, found in the Box web app URL, e.g., for `https://*.app.box.com/files/123`, the ID is `123`. |
include_fields_in_response | array<string> | Optional | List of attributes to include in the response. Only specified fields and mini representation are returned. |
maximum_items_per_page | integer | Optional | The maximum number of comments to return per page for the specified file. |
response_start_offset | integer | Optional | The starting point for comments retrieval. Must not exceed 10000, or a 400 error occurs. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_comments'.BoxApi.GetFilesOnLegalHold
Retrieve files currently on legal hold for a specific assignment. This tool retrieves a list of files with their current versions that are under a legal hold for a specified assignment. It should be used when you need to know which files are currently on hold for legal purposes associated with a specific legal hold policy assignment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legal_hold_policy_assignment_id | string | Required | The ID of the legal hold policy assignment to retrieve files currently on hold. |
pagination_marker | string | Optional | Position marker for starting the result set when using marker-based pagination. Requires the 'usemarker' parameter to be true. |
maximum_items_per_page | integer | Optional | The maximum number of items to return per page. Use this to control pagination size. |
included_attributes | array<string> | Optional | A list of specific attributes to include in the response. Only these attributes will be returned unless others are explicitly specified. Use this to customize the response fields. |
Requirements
Output
json— Response from the API endpoint 'get_legal_hold_policy_assignments_id_files_on_hold'.BoxApi.GetFileTasks
Retrieve all tasks associated with a specific file. This tool retrieves all tasks linked to a given file using its file ID. It's used when there is a need to fetch task details for file management or task tracking purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for a file, found in the file URL on the Box web application. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_tasks'.BoxApi.GetFileVersionHistory
Retrieve a list of past versions for a file. This tool retrieves past versions of a specified file from Box, applicable only for premium account users. Use it to track file changes and version history.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique ID representing a file in Box. Obtainable from the file's URL, e.g., `https://*.app.box.com/files/123` where `123` is the ID. |
requested_fields | array<string> | Optional | A list of specific file attributes to include in the response. Only these fields, plus the mini representation, will be returned. |
max_items_per_page | integer | Optional | Maximum number of file versions to return per page. |
response_start_offset | integer | Optional | The item offset to begin the response from. Must not exceed 10000; otherwise, a 400 error will be returned. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_versions'.BoxApi.GetFileVersionRetentionInfo
Retrieve details of a file version retention. This tool provides information about a specific file version retention. Note that the file retention API is deprecated. For details on files and file versions under retention, refer to alternative endpoints.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_version_retention_id | string | Required | The ID of the specific file version retention to retrieve information for. This is required to access retention details. |
Requirements
Output
json— Response from the API endpoint 'get_file_version_retentions_id'.BoxApi.GetFileVersionRetentions
Retrieve file version retentions for an enterprise. Retrieves all file version retentions for a specified enterprise. Note that this API is deprecated; consider using newer alternatives for files and file versions under retention.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_file_id | string | Optional | Filters results to include only files with this specific file ID. |
filter_by_file_version_id | string | Optional | Filters results by file versions matching this ID. |
retention_policy_id | string | Optional | Filter results by the specific retention policy ID. |
filter_by_disposition_action | string | Optional | Filter results based on the retention policy's disposition action, such as 'permanently_delete' or 'remove_retention'. |
filter_by_disposition_before_date | string | Optional | Provide a date to filter results by files that will have their disposition come into effect before this date. Format: YYYY-MM-DD. |
disposition_effective_after_date | string | Optional | Filter results by files with disposition effective after this date. Use ISO 8601 format (e.g., '2023-10-01'). |
max_items_per_page | integer | Optional | The maximum number of items to return per page. |
pagination_start_marker | string | Optional | Defines the starting point for paginated results using a position marker. Requires marker-based pagination to be enabled. |
Requirements
Output
json— Response from the API endpoint 'get_file_version_retentions'.BoxApi.GetFileVersionsOnLegalHold
Retrieve previous file versions under a legal hold assignment. Use this tool to obtain a list of previous file versions associated with a specific legal hold policy assignment. For current versions, use a different endpoint. This tool focuses on past file versions within the ongoing system architecture. It excludes content held due to custodian collaborations on a Hub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legal_hold_policy_assignment_id | string | Required | The ID of the legal hold policy assignment to retrieve previous file versions for. |
pagination_start_marker | string | Optional | Defines the position marker to start returning results for paginated data retrieval. Requires `usemarker` to be set to `true`. |
max_items_per_page | integer | Optional | The maximum number of items to return per page when retrieving file versions. |
include_additional_fields_in_response | array<string> | Optional | List of attribute names to include in the response. Only specified fields and mini representation fields will be returned. |
Requirements
Output
json— Response from the API endpoint 'get_legal_hold_policy_assignments_id_file_versions_on_hold'.BoxApi.GetFileVersionsUnderRetention
Fetch file versions under a specific retention policy assignment. This tool retrieves a list of file versions that are currently under retention for a specified retention policy assignment. Use it to manage or review file retention statuses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_policy_assignment_id | string | Required | The ID of the retention policy assignment to retrieve file versions under retention. |
pagination_start_marker | string | Optional | Defines the position marker to start returning results. Requires `usemarker` to be `true` for marker-based pagination. |
max_items_per_page | integer | Optional | Specifies the maximum number of file versions to return per page during retrieval. |
Requirements
Output
json— Response from the API endpoint 'get_retention_policy_assignments_id_file_versions_under_retention'.BoxApi.GetFileWatermark
Retrieve the watermark for a file by its ID. Use this tool to get the watermark information of a specific file. It requires the file ID to identify which file's watermark needs to be retrieved.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier of a file. Obtainable from the URL when viewing a file on the web application. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_watermark'.BoxApi.GetFolderAppItemAssociations
Retrieve app items associated with a specific folder. This tool returns all app items associated with a specified folder, including those linked through ancestor folders. It reveals type and IDs of the app items if the user has access to the folder, regardless of their permission on the app items themselves.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier representing a folder. Obtainable from the folder's URL. The root folder ID is '0'. |
max_items_per_page | integer | Optional | The maximum number of items to return per page when retrieving app items associated with a folder. |
pagination_start_marker | string | Optional | Position marker to begin returning results. Used for marker-based pagination. Requires `usemarker` set to `true`. |
filter_by_application_type | string | Optional | Return only app items for the specified application type. |
Requirements
Output
json— Response from the API endpoint 'get_folders_id_app_item_associations'.BoxApi.GetFolderClassification
Retrieve classification metadata for a specific folder. This tool retrieves the security classification metadata applied to a specific folder. It can be used to understand how a folder is classified within an enterprise. The tool should be called when needing to access classification details for data management or security reviews.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier for a folder, retrievable from the folder's URL or as `0` for the root folder. |
Requirements
Output
json— Response from the API endpoint 'get_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo'.BoxApi.GetFolderCollaborations
Retrieve pending and active collaborations for a folder. This tool retrieves a list of users who have access to or have been invited to a specified folder. It returns both pending and active collaborations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier for a folder, obtainable from the folder's URL in the Box web application. For example, in the URL `https://*.app.box.com/folder/123`, the `folder_id` is `123`. |
included_attributes | array<string> | Optional | List of attributes to include in the response, overriding standard fields unless specified. |
max_items_per_page | integer | Optional | The maximum number of items to return per page. |
start_position_marker | string | Optional | The position marker to begin returning results for marker-based pagination. Requires usemarker set to true. |
Requirements
Output
json— Response from the API endpoint 'get_folders_id_collaborations'.BoxApi.GetFolderDetails
Retrieve details for a folder and its first 100 entries. Use this tool to get information about a folder, along with the first 100 items it contains. This includes options for sorting and pagination. For accessing more items in the folder, a different endpoint should be used.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_unique_identifier | string | Required | The unique identifier for a folder. Obtainable from the folder's URL, e.g., `123` in `https://*.app.box.com/folder/123`. The root folder's ID is `0`. |
requested_fields | array<string> | Optional | A list of attributes to include in the response. Use for fields not normally returned in standard responses or for querying file metadata. |
secondary_sort_attribute | string | Optional | Defines the second attribute by which folder items are sorted. Options include 'id', 'name', 'date', or 'size'. Not supported for root folders. |
sort_direction | string | Optional | The order to sort results: 'ASC' for ascending or 'DESC' for descending. |
response_offset | integer | Optional | The zero-based index to start the response from. Values exceeding 10000 are rejected with a 400 error. |
max_items_per_page | integer | Optional | The maximum number of items to return in a single page of results. Controls pagination by limiting the number of entries per response. |
ensure_item_has_changed | string | Optional | Supply the item's last known etag value to receive a response only if the item has changed. If unchanged, it returns a 304 status. |
shared_link_credentials | string | Optional | The URL and optional password for the shared link to access items. Format as `shared_link=[link]` or `shared_link=[link]&shared_link_password=[password]`. |
Requirements
Output
json— Response from the API endpoint 'get_folders_id'.BoxApi.GetFolderMetadata
Retrieve metadata template instance applied to a folder. This tool retrieves the metadata template instance from a specified folder, excluding the root folder (ID `0`).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique ID representing a folder. Obtainable from the folder's URL, but not the root folder (ID `0`). |
metadata_scope | string | Required | The scope of the metadata template. It can be either 'global' or 'enterprise'. |
metadata_template_name | string | Required | The name of the metadata template to retrieve from the folder. Excludes root folder (ID `0`). |
Requirements
Output
json— Response from the API endpoint 'get_folders_id_metadata_id_id'.BoxApi.GetFolderWatermark
Retrieve the watermark for a specific folder. Use this tool to get the watermark information for a folder identified by its ID. Useful for checking watermark status and details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique ID representing a folder. It can be found in the URL when viewing the folder in the web app. The root folder ID is '0'. |
Requirements
Output
json— Response from the API endpoint 'get_folders_id_watermark'.BoxApi.GetGroupCollaborations
Retrieve collaborations for a specified group. Fetches all collaborations associated with a group, including access details for files or folders. Requires admin permissions to view enterprise groups.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_id | string | Required | The unique identifier of the group whose collaborations you want to retrieve. This ID is required to specify the group. |
max_items_per_page | integer | Optional | Specifies the maximum number of collaboration items to return per page. Accepts an integer value. |
response_offset | integer | Optional | Starting point in the list of collaborations. Must be an integer not exceeding 10000 to avoid rejection. |
Requirements
Output
json— Response from the API endpoint 'get_groups_id_collaborations'.BoxApi.GetLegacyFileVersionLegalHolds
Retrieve file versions on legal hold in the legacy system. This endpoint fetches file versions under legal hold in the legacy architecture for a specific legal hold assignment. It may not return all file versions for the policy ID. For file versions held in the new architecture, refer to the appropriate newer endpoints. This API will be deprecated after re-architecture completion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legal_hold_policy_id | string | Required | The ID of the legal hold policy for which file version legal holds need to be retrieved. |
pagination_marker | string | Optional | A string that defines the starting point for marker-based pagination. Requires `usemarker` to be true. |
max_items_per_page | integer | Optional | Specify the maximum number of items to return per page for the request. |
Requirements
Output
json— Response from the API endpoint 'get_file_version_legal_holds'.BoxApi.GetLegalHoldPolicyAssignments
Retrieve items assigned to a legal hold policy. Use this tool to fetch all items that have been associated with a specific legal hold policy.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legal_hold_policy_id | string | Required | The unique identifier for the legal hold policy to retrieve assignments for. |
filter_by_assignment_type | string | Optional | Specify the type of item (e.g., file, folder, user, etc.) the policy was applied to. Choices: ['file', 'file_version', 'folder', 'user', 'ownership', 'interactions']. |
filter_by_item_id | string | Optional | Filters results by the ID of the item the policy was applied to. |
pagination_marker | string | Optional | Specifies the position to start retrieving results using marker-based pagination. Requires `usemarker` to be set to `true`. |
maximum_items_per_page | integer | Optional | Set the maximum number of items to retrieve per page for optimal pagination control. |
response_fields | array<string> | Optional | List of attributes to include in the response, overriding standard fields unless specified. |
Requirements
Output
json— Response from the API endpoint 'get_legal_hold_policy_assignments'.BoxApi.GetManualStartWorkflows
Retrieve workflows with manual start triggers for a folder. Use this tool to get workflows associated with a specific folder ID that have a manual start trigger type. Ensure your application is authorized to use the 'Manage Box Relay' application scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_id | string | Required | The unique identifier representing a folder. You can find this by visiting the folder in the web application and copying the ID from the URL. The root folder is always represented by ID '0'. |
trigger_type_filter | string | Optional | Specify the trigger type to search for in workflows. Use 'WORKFLOW_MANUAL_START' for manual triggers. |
max_items_per_page | integer | Optional | The maximum number of workflows to retrieve per page. Adjust based on your needs to control pagination. |
pagination_marker | string | Optional | Specifies the position marker to start returning results. Used for marker-based pagination and requires `usemarker` to be set to `true`. |
Requirements
Output
json— Response from the API endpoint 'get_workflows'.BoxApi.GetMetadataCascadePolicies
Retrieve metadata cascade policies for a folder. Use this tool to obtain a list of metadata cascade policies applied to a specific folder, excluding the root folder.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
target_folder_id | string | Required | The ID of the folder to query for metadata cascade policies. The root folder with ID '0' is not allowed. |
owner_enterprise_id | string | Optional | The ID of the enterprise to find metadata cascade policies for. Defaults to the current enterprise if not specified. |
pagination_marker | string | Optional | Position marker for paginating results. Set `usemarker` to true to enable. |
response_offset | integer | Optional | The offset at which to begin the response, must not exceed 10000. |
Requirements
Output
json— Response from the API endpoint 'get_metadata_cascade_policies'.BoxApi.GetPendingCollaborationInvites
Retrieve user's pending collaboration invites from Box. This tool fetches all pending collaboration invitations for a user from the Box service. It should be called when you need to check for any outstanding collaboration invites for a user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collaboration_status | string | Required | Set to 'pending' to retrieve all pending collaboration invitations. |
include_attributes | array<string> | Optional | List of attribute names to include in the response. This overrides default fields, returning only specified attributes. |
starting_item_offset | integer | Optional | Starting index for the response items. Cannot exceed 10000 to avoid errors. |
maximum_items_per_page | integer | Optional | The maximum number of collaboration invites to return per page. |
Requirements
Output
json— Response from the API endpoint 'get_collaborations'.BoxApi.GetRecentItemsInfo
Fetch recent items accessed by a user in Box. Retrieves information on the most recent items a user has accessed in Box, up to 1000 items or within the last 90 days.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_additional_fields | array<string> | Optional | A list of attributes to include in the response, overriding the default fields. |
max_items_per_page | integer | Optional | The maximum number of items to return per page when fetching recent items accessed by a user. |
pagination_start_marker | string | Optional | A position marker to begin returning results, used for marker-based pagination. Requires `usemarker=true`. |
Requirements
Output
json— Response from the API endpoint 'get_recent_items'.BoxApi.GetRetentionPolicy
Retrieve details of a specified retention policy. Use this tool to get details about a specific retention policy using its ID. It should be called when you need to understand or display the specifics of a particular retention policy.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_policy_id | string | Required | The ID of the retention policy to retrieve details for. This ID is essential for accessing the specific policy information. |
include_attributes | array<string> | Optional | List of attributes to include in the response. Standard fields are omitted unless explicitly specified. |
Requirements
Output
json— Response from the API endpoint 'get_retention_policies_id'.BoxApi.GetRetentionPolicyAssignments
Retrieve retention policy assignments by policy ID. This tool returns a list of all retention policy assignments associated with a specified retention policy ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_policy_id | string | Required | The unique identifier of the retention policy to retrieve assignments for. |
assignment_type | string | Optional | The type of retention policy assignment to retrieve, such as 'folder', 'enterprise', or 'metadata_template'. |
include_fields_in_response | array<string> | Optional | A list of attribute names to include in the response. These specify additional fields to return beyond the standard response. |
pagination_start_marker | string | Optional | The position marker to begin returning results for marker-based pagination. |
max_items_per_page | integer | Optional | The maximum number of items to return per page when retrieving retention policy assignments. |
Requirements
Output
json— Response from the API endpoint 'get_retention_policies_id_assignments'.BoxApi.GetSafeCollaborationDomains
Retrieve domains approved for safe collaboration. Use this tool to get a list of domains that are considered safe for creating collaborations within the current enterprise environment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_start_marker | string | Optional | The position marker to begin returning results, used for marker-based pagination. Requires `usemarker` to be `true`. |
maximum_items_per_page | integer | Optional | The maximum number of domains to return per page. Adjust this to control the page size of results. |
Requirements
Output
json— Response from the API endpoint 'get_collaboration_whitelist_entries'.BoxApi.GetShieldInfoBarrierMember
Retrieve details of a shield information barrier segment member. This tool retrieves details about a specific shield information barrier segment member based on its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
member_id | string | Required | The ID of the shield information barrier segment member to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barrier_segment_members_id'.BoxApi.GetShieldInfoBarrierSegment
Retrieve shield information barrier segment by ID. Use this tool to obtain details about a shield information barrier segment using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
barrier_segment_id | string | Required | The unique ID of the shield information barrier segment to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barrier_segments_id'.BoxApi.GetShieldInformationBarrier
Retrieve shield information barrier by ID. Use this tool to get details of a shield information barrier using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
shield_information_barrier_id | string | Required | The unique identifier for the shield information barrier to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barriers_id'.BoxApi.GetShieldInformationBarrierReports
Retrieve shield information barrier reports. This tool fetches a list of reports related to shield information barriers, which can be used to understand and analyze the barriers in place.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
shield_information_barrier_id | string | Required | The unique identifier for the shield information barrier whose reports need to be fetched. |
pagination_marker | string | Optional | Position marker to start returning results for pagination. Requires 'usemarker' set to 'true'. |
maximum_items_per_page | integer | Optional | The maximum number of shield information barrier reports to return per page. This integer value controls the page size for result sets. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barrier_reports'.BoxApi.GetShieldInformationBarriers
Retrieve shield information barriers for the enterprise. This tool fetches a list of shield information barrier objects associated with the enterprise according to the JWT.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_marker | string | Optional | Defines the starting point for paginated results using marker-based pagination. |
max_items_per_page | integer | Optional | The maximum number of shield information barrier objects to return per page. This controls the pagination size. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barriers'.BoxApi.GetShieldInformationBarrierSegmentInfo
Retrieve shield barrier segment restriction by ID. This tool retrieves details of a shield information barrier segment restriction using the specified ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_restriction_id | string | Required | The unique identifier for the shield information barrier segment restriction. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barrier_segment_restrictions_id'.BoxApi.GetShieldInformationBarrierSegments
Retrieve shield information barrier segment details. Use this tool to fetch details of shield information barrier segment objects for a specified Information Barrier ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
shield_information_barrier_id | string | Required | The unique identifier for the shield information barrier that specifies the segment objects to retrieve. |
pagination_position_marker | string | Optional | Defines the position marker to start returning results from, used for marker-based pagination. Requires usemarker to be true. |
maximum_items_per_page | integer | Optional | The maximum number of shield information barrier segment items to return in a single request. Ideal for controlling page size during pagination. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barrier_segments'.BoxApi.GetShieldInformationRestrictions
Retrieve restrictions for a shield information barrier segment. Use this tool to list restrictions for a specific shield information barrier segment based on its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_id | string | Required | The unique identifier for the shield information barrier segment to retrieve restrictions. |
pagination_position_marker | string | Optional | Defines the position marker to begin results, used for marker-based pagination. Requires `usemarker` to be `true`. |
max_items_per_page | integer | Optional | The maximum number of items to return per page when retrieving shield information barrier segment restrictions. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barrier_segment_restrictions'.BoxApi.GetSpecificTermsOfService
Fetches details of a specific terms of service. Use this tool to retrieve information about a specific terms of service using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
terms_of_service_id | string | Required | The unique identifier for the terms of service to be fetched. |
Requirements
Output
json— Response from the API endpoint 'get_terms_of_services_id'.BoxApi.GetSpecificWebhook
Retrieve details of a specific webhook by ID. Use this tool to get information about a specific webhook by providing its ID. It retrieves details such as URL, triggers, and other related metadata.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_id | string | Required | The unique identifier of the webhook to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'get_webhooks_id'.BoxApi.GetTeamsIntegrationMappings
Retrieve Teams integration mappings for an enterprise. This tool retrieves a list of Teams integration mappings within a user's enterprise. It requires Admin or Co-Admin access to execute this call.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mapped_item_type | string | Optional | Specify the type of item ('channel' or 'team') for which the mapping should be returned. |
mapped_item_id | string | Optional | The ID of the mapped item for which the mapping should be returned. Required for retrieving specific integration mappings. |
box_item_id_for_mappings | string | Optional | The Box item ID to retrieve integration mappings for. Required for fetching specific mappings. |
box_item_type | string | Optional | Specify the type of Box item for which the mappings should be returned. Acceptable value is 'folder'. |
Requirements
Output
json— Response from the API endpoint 'get_integration_mappings_teams'.BoxApi.GetUploadedChunksList
Retrieve the list of uploaded chunks for an upload session. Use this tool to get a list of file chunks that have been uploaded to a specific upload session. This is helpful for tracking upload progress and ensuring all parts are correctly uploaded.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
upload_session_identifier | string | Required | The unique identifier for the upload session. Use this to retrieve the list of uploaded chunks. |
response_offset | integer | Optional | The starting position of the response item list. Must not exceed 10000, as higher values will result in a 400 error. |
max_items_per_page | integer | Optional | The maximum number of uploaded chunks to return per page in the response. |
Requirements
Output
json— Response from the API endpoint 'get_files_upload_sessions_id_parts'.BoxApi.GetUploadSessionDetails
Retrieve details of a specific file upload session. This tool retrieves information about a file upload session using the session ID. It is useful for checking the status or details of ongoing or past file uploads.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
upload_session_id | string | Required | The ID of the upload session to retrieve information for. |
Requirements
Output
json— Response from the API endpoint 'get_files_upload_sessions_id'.BoxApi.GetUserAvatar
Retrieve the image of a user's avatar. Use this tool to get the avatar image for a specific user by their user ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id | string | Required | The ID of the user whose avatar you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get_users_id_avatar'.BoxApi.GetUserEmailAliases
Retrieve all email aliases for a specific user. Fetches all email aliases associated with a user, excluding their primary login email.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique ID of the user to retrieve email aliases for, formatted as a string. |
Requirements
Output
json— Response from the API endpoint 'get_users_id_email_aliases'.BoxApi.GetUserGroupMemberships
Retrieve all groups a user belongs to. Fetches all the groups associated with a specific user. This is accessible only to group members or users with admin-level permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The ID of the user to retrieve group memberships for. |
max_items_per_page | integer | Optional | Maximum number of items to return per page. Set an integer value to limit the results displayed at once. |
response_offset | integer | Optional | The starting point offset for the response items. Must be 10000 or less. |
Requirements
Output
json— Response from the API endpoint 'get_users_id_memberships'.BoxApi.GetUserInformation
Retrieve detailed user information in the enterprise. Use this tool to get information about a user in the enterprise. Requires permission to access user details. Returns limited info for external users with appropriate scopes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique identifier for the user whose information you want to retrieve. |
requested_user_fields | array<string> | Optional | An array of attributes to include in the response. Only specified fields are returned unless otherwise stated. |
Requirements
Output
json— Response from the API endpoint 'get_users_id'.BoxApi.GetUserTosStatus
Retrieve user acceptance status for terms of service. This tool retrieves information about users and their status regarding terms of service acceptance, including whether they have accepted the terms and when.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
terms_of_service_id | string | Required | The unique identifier for the specific terms of service document. |
filter_by_user_id | string | Optional | Limits results to the specified user ID for retrieving their terms of service acceptance status. |
Requirements
Output
json— Response from the API endpoint 'get_terms_of_service_user_statuses'.BoxApi.ListAiAgents
Retrieve a list of AI agents with specified parameters. This tool fetches AI agents from the service based on provided filters or parameters. It should be called when information about available AI agents is needed, such as their names, types, or statuses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_mode | array<string> | Optional | List of modes to filter the agent configuration. Options: `ask`, `text_gen`, `extract`. |
response_fields | array<string> | Optional | List of fields to return for each AI agent in the response. Specify as an array of strings. |
agent_state_filter | array<string> | Optional | Specify the states of agents to return. Acceptable values include: 'enabled', 'disabled', and 'enabled_for_selected_users'. |
results_start_position_marker | string | Optional | The starting point marker for returning paginated results. Use this to continue a previous query from where it left off. |
max_items_per_page | integer | Optional | The maximum number of AI agents to return for a single page of results. |
include_box_default_agents | boolean | Optional | Set to true to include Box default AI agents in the response, false otherwise. |
Requirements
Output
json— Response from the API endpoint 'get_ai_agents'.BoxApi.ListBoxDocgenJobs
Retrieves a list of Box Doc Gen jobs for a user. Use this tool to get all the Box Doc Gen job details associated with a user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_marker | string | Optional | Starting position marker for paginating results. Requires 'usemarker' set to true. |
maximum_items_per_page | integer | Optional | The maximum number of items to return per page. Specify an integer value to set the limit for pagination. |
Requirements
Output
json— Response from the API endpoint 'get_docgen_jobs_v2025.0'.BoxApi.ListBoxDocgenTemplateTags
Retrieve tags from a specific Box Doc Gen template. Call this tool to list all tags used in a specific Box Doc Gen template. Use it when you need to access or manage the tags associated with a given template.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_id | string | Required | The unique identifier for the Box Doc Gen template whose tags you want to retrieve. |
template_version_id | string | Optional | The ID of the specific version of the template to retrieve tags from. |
pagination_start_marker | string | Optional | Defines the starting position for results when using marker-based pagination. Must have `usemarker` set to `true`. |
maximum_items_per_page | integer | Optional | Specifies the maximum number of tags to return per page from the Box Doc Gen template. |
Requirements
Output
json— Response from the API endpoint 'get_docgen_templates_id_tags_v2025.0'.BoxApi.ListBoxDocTemplates
Retrieve Box Doc Gen templates the user collaborates on. Fetches a list of Box Doc Gen templates where the user is a collaborator. Useful for managing or accessing document templates in Box.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_start_marker | string | Optional | Defines the starting position for pagination of results. Requires `usemarker` to be set to `true`. |
max_items_per_page | integer | Optional | Specify the maximum number of Box Doc Gen templates to return in a single page. |
Requirements
Output
json— Response from the API endpoint 'get_docgen_templates_v2025.0'.BoxApi.ListDefinedWebhooks
Retrieve all webhooks for your application. Used to get all webhooks defined for files or folders owned by the authenticated user. Note: Admins can't see webhooks created by service accounts unless they have access to those folders.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_start_marker | string | Optional | The position marker to start returning results from. Required for marker-based pagination with `usemarker` set to `true`. |
maximum_items_per_page | integer | Optional | The maximum number of webhooks to return per page. |
Requirements
Output
json— Response from the API endpoint 'get_webhooks'.BoxApi.ListDocgenBatchJobs
Retrieve details of Box Doc Gen jobs in a batch. Use this tool to get a list of Box Doc Gen jobs contained within a specific batch using the batch ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
box_doc_gen_batch_id | string | Required | The identifier for a Box Doc Gen batch used to retrieve specific job details. |
pagination_marker | string | Optional | The position marker to start returning results. Use for marker-based pagination. Requires `usemarker` set to `true`. |
maximum_items_per_page | integer | Optional | The maximum number of items to return per page when retrieving Box Doc Gen jobs. |
Requirements
Output
json— Response from the API endpoint 'get_docgen_batch_jobs_id_v2025.0'.BoxApi.ListEnterpriseUsers
Retrieve all users in the enterprise. Fetches a list of users for the enterprise, including user IDs, public names, and login information. Requires appropriate permissions to access user data across the enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_term_for_user_filtering | string | Optional | Limits results to users whose name or login begins with the specified term. Complete match required for external users. |
user_type_filter | string | Optional | Specify the type of users to include: 'all', 'managed', or 'external'. |
filter_by_external_app_user_id | string | Optional | Filter results to app users with the specified external app user ID. Used for retrieving users matching this ID. |
include_additional_fields | array<string> | Optional | Specify additional attributes for inclusion in the response. Only selected fields and mini representation fields will be returned. |
response_offset | integer | Optional | The starting point for the response; queries exceeding 10000 will return a 400 error. |
max_items_per_page | integer | Optional | The maximum number of user records to return per page. |
pagination_start_marker | string | Optional | Defines the position marker where results begin when using marker-based pagination. Requires `usemarker` set to `true`. |
use_marker_pagination | boolean | Optional | Set to true to use marker-based pagination. This enables a `marker` field in the response for pagination. |
Requirements
Output
json— Response from the API endpoint 'get_users'.BoxApi.ListFilesUnderRetentionPolicy
Retrieve files under a retention policy assignment. This tool fetches a list of files that are under retention for a given retention policy assignment ID. It should be called when you need to identify files associated with a specific retention policy.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_policy_assignment_id | string | Required | The ID of the retention policy assignment used to identify which retention policy's files to retrieve. |
position_marker | string | Optional | A string to define where to start returning results for pagination using marker-based pagination. Requires `usemarker` to be `true`. |
max_items_per_page | integer | Optional | The maximum number of files to retrieve per page. Determines the page size for the results. |
Requirements
Output
json— Response from the API endpoint 'get_retention_policy_assignments_id_files_under_retention'.BoxApi.ListShieldBarrierSegmentMembers
Retrieve members of shield information barrier segments. This tool lists the members of shield information barrier segments based on provided segment IDs. It should be called when there's a need to identify or review members within these segments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
segment_id | string | Required | The ID of the shield information barrier segment to retrieve members for. |
pagination_marker | string | Optional | The position marker to begin returning paginated results. Requires `usemarker` to be `true`. |
items_per_page_limit | integer | Optional | The maximum number of segment members to return per page. Use this to control pagination by specifying the number of results per page. |
Requirements
Output
json— Response from the API endpoint 'get_shield_information_barrier_segment_members'.BoxApi.ListSlackIntegrationMappings
Retrieve Slack integration mappings for a Box enterprise. This tool is used to list Slack integration mappings within a user's enterprise on Box. It requires Admin or Co-Admin privileges.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_start_marker | string | Optional | Defines the starting position for pagination results. Requires 'usemarker' to be true. |
max_items_per_page | integer | Optional | The maximum number of Slack integration mappings to return per page from the user's enterprise. |
mapped_item_type | string | Optional | The type of mapped item for which the Slack integration mapping should be returned. Only 'channel' is supported. |
mapped_item_id | string | Optional | ID of the mapped item for which the Slack integration mapping should be retrieved. |
box_item_id | string | Optional | Box item ID for which to retrieve Slack integration mappings. Must be a valid ID within the user's enterprise. |
box_item_type | string | Optional | Specify the type of Box item for which the mappings should be returned. Currently, only 'folder' is supported. |
include_manually_created_mappings | boolean | Optional | Set to true to include mappings that have been manually created. |
Requirements
Output
json— Response from the API endpoint 'get_integration_mappings_slack'.BoxApi.ListTaskAssignments
Retrieve all assignments for a specified task. This tool is used to list all the assignments associated with a given task by providing the task ID. Use this tool to get details on who is assigned to a specific task.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
task_id | string | Required | The unique identifier of the task for which assignments need to be retrieved. It must be provided as a string. |
Requirements
Output
json— Response from the API endpoint 'get_tasks_id_assignments'.BoxApi.ListTemplateJobs
Retrieve jobs associated with a specific document template. Use this tool to get a list of all user jobs linked to a particular document generation template by providing the template ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
template_identifier | string | Required | The unique ID of the template for which jobs need to be retrieved. |
pagination_start_marker | string | Optional | Defines the starting position for pagination. Requires 'usemarker' to be set to true. |
max_items_per_page | integer | Optional | The maximum number of items to return per page from the list of jobs. |
Requirements
Output
json— Response from the API endpoint 'get_docgen_template_jobs_id_v2025.0'.BoxApi.PermanentlyDeleteFileFromTrash
Permanently delete a file that is in the trash. This tool is used to permanently remove a file that has been moved to the trash. This action is irreversible and should be called when a file needs to be deleted without the possibility of recovery.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier of a file to be permanently deleted from the trash. Obtainable from the file URL. |
Requirements
Output
json— Response from the API endpoint 'delete_files_id_trash'.BoxApi.PermanentlyDeleteFolderInTrash
Permanently delete a folder from the trash. This tool permanently deletes a folder that is in the trash, and this action cannot be undone. It should be called when there is a need to remove a folder from the trash permanently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier representing a folder to be permanently deleted from the trash. Obtainable from folder URL or use '0' for root folder. |
Requirements
Output
json— Response from the API endpoint 'delete_folders_id_trash'.BoxApi.PermanentlyDeleteTrashedWebLink
Permanently delete a trashed web link. Use this tool to permanently delete a web link that is currently in the trash. This action is irreversible and should be used when the web link is no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
web_link_identifier | string | Required | The unique identifier of the web link to be permanently deleted from the trash. This ID is required to specify which web link should be removed. |
Requirements
Output
json— Response from the API endpoint 'delete_web_links_id_trash'.BoxApi.RemoveBoxSkillsMetadata
Remove Box Skills cards metadata from a file. Use this tool to delete any Box Skills cards metadata associated with a specific file. It should be called when there is a need to clean metadata from files stored in Box.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for a file, which can be extracted from the URL in the web application. For example, in `https://*.app.box.com/files/123`, the `file_id` is `123`. |
Requirements
Output
json— Response from the API endpoint 'delete_files_id_metadata_global_boxSkillsCards'.BoxApi.RemoveCollaborationWhitelistExemption
Remove a user's exemption from domain restrictions in collaborations. This tool is used to revoke a specific user's exemption from the list of allowed domains for collaborative activities, ensuring that the domain restrictions apply.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exemption_id | string | Required | The ID of the user's exemption to be removed from the collaboration whitelist. |
Requirements
Output
json— Response from the API endpoint 'delete_collaboration_whitelist_exempt_targets_id'.BoxApi.RemoveFileClassification
Remove classifications from a specified file. This tool is used to remove any security classifications from a file in the Box service. It should be called when there's a need to clear security classifications.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for the file whose classification is to be removed. Obtainable from the Box file URL. |
Requirements
Output
json— Response from the API endpoint 'delete_files_id_metadata_enterprise_securityClassification-6VMVochwUWo'.BoxApi.RemoveFileWatermark
Removes the watermark from a specified file. This tool is used to remove a watermark from a file in the Box service. It should be called when there's a need to delete the watermark from a specified file.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique ID for the file, found in its Box URL. For example, from `https://*.app.box.com/files/123`, `file_id` is `123`. |
Requirements
Output
json— Response from the API endpoint 'delete_files_id_watermark'.BoxApi.RemoveFolderClassifications
Remove classifications from a specified folder. Use this tool to remove any security classifications applied to a specific folder. It is useful when needing to update or clear the classification status of folders in an enterprise setting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier representing a folder. Obtain this by visiting the folder URL (e.g., `https://*.app.box.com/folder/123`). The root folder ID is `0`. |
Requirements
Output
json— Response from the API endpoint 'delete_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo'.BoxApi.RemoveLegalHoldFromItem
Initiate removal of a legal hold from an item. Use this tool to start the process of removing a legal hold from a specific item. It is an asynchronous operation, meaning the hold is not fully removed immediately upon response.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legal_hold_policy_assignment_id | string | Required | The unique identifier for the legal hold policy assignment you wish to remove. This value is necessary to initiate the removal process. |
Requirements
Output
json— Response from the API endpoint 'delete_legal_hold_policy_assignments_id'.BoxApi.RemoveRetentionPolicyAssignment
Removes a retention policy assignment from content. This tool is used to delete a specific retention policy assignment identified by its ID. It should be called when you need to remove the association of retention policies from specific content.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_policy_assignment_id | string | Required | The unique identifier for the retention policy assignment to be removed. |
Requirements
Output
json— Response from the API endpoint 'delete_retention_policy_assignments_id'.BoxApi.RemoveSafeCollaborationDomain
Remove a domain from the safe collaboration list. Use this tool to delete a domain from the list of approved domains for collaborations in the enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
whitelist_entry_id | string | Required | The unique identifier for the domain entry in the safe collaboration list to be removed. |
Requirements
Output
json— Response from the API endpoint 'delete_collaboration_whitelist_entries_id'.BoxApi.RemoveShieldBarrierMember
Delete a shield information barrier segment member by ID. This tool deletes a member from a shield information barrier segment using the provided member ID. Use this to manage and update segment member lists.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
member_id_for_deletion | string | Required | The ID of the shield information barrier segment member to be deleted. |
Requirements
Output
json— Response from the API endpoint 'delete_shield_information_barrier_segment_members_id'.BoxApi.RemoveUserAvatar
Removes a user's existing avatar. Use this tool to permanently delete a user's avatar. This action is irreversible, so it should be called when you want to ensure a user's avatar is removed from their profile.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique identifier of the user whose avatar is to be deleted. Ensure this ID is correct, as the operation cannot be reversed. |
Requirements
Output
json— Response from the API endpoint 'delete_users_id_avatar'.BoxApi.RemoveUserEmailAlias
Removes an email alias from a user account. Call this tool to delete a specific email alias from a user's account using their user ID and the email alias ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique ID of the user whose email alias is to be removed. |
email_alias_id | string | Required | The unique identifier of the email alias to be removed. This is required to specify which alias to delete from the user account. |
Requirements
Output
json— Response from the API endpoint 'delete_users_id_email_aliases_id'.BoxApi.RemoveWatermarkFromFolder
Removes the watermark from a specified folder. Use this tool to remove the watermark from a folder by providing the folder's ID in the request.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier for a folder. This ID can be found in the URL when visiting the folder in the Box web application. For instance, in `https://*.app.box.com/folder/123`, the `folder_id` is `123`. The root folder is always `0`. |
Requirements
Output
json— Response from the API endpoint 'delete_folders_id_watermark'.BoxApi.ResendSignatureRequestEmail
Resend signature request email to outstanding signers. This tool is used to resend a signature request email to all signers who have not yet completed the sign request. It should be called when you need to prompt signers again to complete a signing process.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
signature_request_id | string | Required | The unique identifier of the signature request to resend emails to outstanding signers. |
Requirements
Output
json— Response from the API endpoint 'post_sign_requests_id_resend'.BoxApi.RetrieveBoxHubCollaborations
Retrieves collaborations for a Box Hub. This tool fetches all the collaborations associated with a given Box Hub. It should be called when there is a need to access or review the collaborative associations within a Box Hub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hub_identifier | string | Required | The unique string identifier for a Box Hub, found in the Hub's URL. |
pagination_marker | string | Optional | The position marker to begin returning results, used for marker-based pagination. Ensure `usemarker` is set to `true`. |
max_items_per_page | integer | Optional | The maximum number of collaboration items to return per page. Determines the page size for results. |
Requirements
Output
json— Response from the API endpoint 'get_hub_collaborations_v2025.0'.BoxApi.RetrieveBoxHubDetails
Fetch Box Hub details using its ID. Use this tool to obtain detailed information about a specific Box Hub by providing its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
box_hub_identifier | string | Required | The unique ID representing a Box Hub, found in the URL when visiting the hub. |
Requirements
Output
json— Response from the API endpoint 'get_hubs_id_v2025.0'.BoxApi.RetrieveBoxHubItems
Fetch all items from a specified Box Hub. Use this tool to retrieve all items associated with a particular Box Hub. This is useful for accessing and managing the contents of a hub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hub_identifier | string | Required | The unique ID representing a Box Hub, retrievable from the hub's URL. |
pagination_start_marker | string | Optional | Defines the starting position for results when using marker-based pagination. Requires `usemarker` to be `true`. |
maximum_items_per_page | integer | Optional | The maximum number of items to return per page from a Box Hub. Specify an integer value to limit the number of items in each result set. |
Requirements
Output
json— Response from the API endpoint 'get_hub_items_v2025.0'.BoxApi.RetrieveCollectionById
Retrieve details of a collection using its ID. Use this tool to get detailed information about a specific collection by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collection_identifier | string | Required | The unique ID of the collection to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'get_collections_id'.BoxApi.RetrieveCollectionContents
Fetch files and folders from a specific collection. This tool retrieves the files and/or folders contained within a specified collection. It should be called when a user needs to access or browse the contents of a particular collection using its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collection_id | string | Required | The unique identifier for the collection whose contents are to be retrieved. |
attributes_to_include | array<string> | Optional | List of attributes to include in the response. Only the specified fields will be returned alongside the mini representation. |
response_offset | integer | Optional | The starting position in the collection. Must not exceed 10000 to avoid errors. |
max_items_per_page | integer | Optional | Specifies the maximum number of items to return per page when retrieving the collection contents. This controls pagination and helps manage large datasets. |
Requirements
Output
json— Response from the API endpoint 'get_collections_id_items'.BoxApi.RetrieveEnterpriseArchives
Retrieve archives for an enterprise from Box. This tool retrieves archives for an enterprise using Box's API. It should be called when information about stored archives is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_items_per_page | integer | Optional | The maximum number of archive items to return per page when retrieving data. |
pagination_start_marker | string | Optional | Defines the position marker to start returning results for pagination in archive retrieval. |
Requirements
Output
json— Response from the API endpoint 'get_archives_v2025.0'.BoxApi.RetrieveEnterpriseGroups
Retrieve all groups for an enterprise with admin rights. Use this tool to get a list of all groups within a specific enterprise. Requires admin permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_name_starts_with | string | Optional | Returns groups whose names start with this search term. |
included_attributes | array<string> | Optional | List of specific attributes to include in the response. Defaults to mini representation if unspecified. |
max_items_per_page | integer | Optional | The maximum number of groups to return per page. |
starting_item_offset | integer | Optional | The offset of the item at which to begin the response. Ensure the value does not exceed 10000 to avoid errors. |
Requirements
Output
json— Response from the API endpoint 'get_groups'.BoxApi.RetrieveEnterpriseMetadataTemplates
Retrieve metadata templates for the user's enterprise. Used to fetch all metadata templates designated for use within the user's enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_start_marker | string | Optional | Position marker to begin returning results, used with marker-based pagination. Requires `usemarker` to be `true`. |
maximum_items_per_page | integer | Optional | The maximum number of items to return per page when retrieving metadata templates. |
Requirements
Output
json— Response from the API endpoint 'get_metadata_templates_enterprise'.BoxApi.RetrieveFileDetails
Fetch details about a specific file using its ID. Use this tool to get information about a file by providing its ID. It retrieves detailed metadata and properties of the file.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for a file, found in the URL of the file in the web application. Example: from `https://*.app.box.com/files/123`, use `123`. |
included_file_attributes | array<string> | Optional | Specify attributes to include in the response as a list of strings. Additional attributes replace standard fields unless explicitly included. Metadata can be queried using 'metadata' with scope and key. |
etag_conditional_retrieval | string | Optional | Provide the last observed etag value to retrieve the file only if it has changed. Returns a 304 status if unchanged. |
shared_link_with_optional_password | string | Optional | Provide the shared link URL for the item. Use the format 'shared_link=[link]' or 'shared_link=[link]&shared_link_password=[password]' if a password is required. |
file_representations_request | string | Optional | Request specific representations of a file using hints, e.g., '[jpg?dimensions=32x32][jpg?dimensions=64x64]'. |
Requirements
Output
json— Response from the API endpoint 'get_files_id'.BoxApi.RetrieveFileMetadata
Retrieve all metadata for a specific file. This tool is used to obtain comprehensive metadata information for a given file. It should be called when there is a need to access detailed metadata associated with a specific file ID in the Box service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier of a file, obtained from the URL in the Box web application. For example, from `https://*.app.box.com/files/123`, the `file_id` is `123`. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_metadata'.BoxApi.RetrieveFileRequestInfo
Retrieve information about a specific file request. This tool retrieves detailed information about a file request using its unique identifier. It should be called when you need to access metadata or details related to a specific file request.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_request_unique_id | string | Required | The unique identifier for a file request, obtainable from the URL in the file request builder. |
Requirements
Output
json— Response from the API endpoint 'get_file_requests_id'.BoxApi.RetrieveFileTemplateMetadata
Retrieve metadata for a specific file template. Use this tool to get the metadata template instance applied to a file. It should be called when metadata information about a file is needed, such as tags, classifications, or other custom data types.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for a file, obtainable from the file URL in the Box web application. |
metadata_scope | string | Required | Defines the scope of the metadata template to be retrieved. Options are 'global' or 'enterprise'. |
metadata_template_name | string | Required | The name of the metadata template to retrieve for the specified file. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_metadata_id_id'.BoxApi.RetrieveFileThumbnail
Retrieves a thumbnail image of a specified file. This tool retrieves a thumbnail of a file in various sizes, such as 32x32, 64x64, 128x128, and 256x256 in .png format, or 32x32, 160x160, and 320x320 in .jpg format. Use this tool to get a smaller image representation of images and videos.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier for the file. You can find this ID in the file URL on the Box web application. |
thumbnail_file_format | string | Required | Specify the file format for the thumbnail, either 'png' or 'jpg'. |
minimum_thumbnail_height | integer | Optional | Specify the minimum height for the thumbnail image required. Accepts an integer value. |
minimum_thumbnail_width | integer | Optional | The minimum width of the thumbnail to be retrieved. Specify an integer value. |
maximum_thumbnail_height | integer | Optional | The maximum height of the thumbnail in pixels. Valid values depend on the specified format. For .png, maximum is 256; for .jpg, maximum is 320. |
maximum_thumbnail_width | integer | Optional | The maximum width for the thumbnail image in pixels. Define the width according to the available sizes in .png or .jpg formats. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_thumbnail_id'.BoxApi.RetrieveFileVersion
Retrieve a specific version of a file for premium Box users. Use this tool to fetch details about a specific version of a file stored on Box. Only applicable for Box users with premium accounts who have version tracking enabled.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
unique_file_identifier | string | Required | The unique identifier for a file on Box. Obtainable from the file's URL (e.g., '123' in 'https://*.app.box.com/files/123'). |
file_version_identifier | string | Required | The unique ID representing the specific version of a file to retrieve. |
include_additional_attributes | array<string> | Optional | List of additional attributes to include in the response. Specify as an array of strings. Only fields specified will be returned, along with the mini representation. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_versions_id'.BoxApi.RetrieveFileVersionLegalHolds
Get details of legal holds on a specific file version. Use this tool to retrieve information about legal hold policies assigned to a specific file version. This is useful for compliance and legal purposes when you need to know which legal holds are applied.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_version_legal_hold_id | string | Required | The unique identifier of the file version legal hold to retrieve specific legal hold policy details. |
Requirements
Output
json— Response from the API endpoint 'get_file_version_legal_holds_id'.BoxApi.RetrieveFolderItems
Retrieve items in a specified folder, including files and links. Use this tool to get a list of items such as files, folders, and web links contained within a specific folder. To obtain details about the folder itself, use a different endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | Unique ID of a folder. Obtainable from the folder's URL. Root folder ID is always '0'. |
included_attributes | array<string> | Optional | List of attributes to include in the response. Specify fields normally omitted in standard responses or query metadata using the format 'metadata.<scope>.<key>'. |
pagination_start_marker | string | Optional | Specifies the starting point for marker-based pagination. Requires 'usemarker' to be set to true. |
starting_item_offset | integer | Optional | Specifies the starting point for the items to be returned. Must be an integer and cannot exceed 10000, or a 400 response is returned. |
max_items_per_page | integer | Optional | The maximum number of items to return per page. Specify an integer value. |
sort_attribute | string | Optional | Specifies the secondary attribute for sorting folder items. Options: 'id', 'name', 'date', or 'size'. Not supported for marker-based pagination on root folders. |
sort_direction | string | Optional | The direction to sort results: alphabetical ascending (ASC) or descending (DESC). |
shared_link_credentials | string | Optional | Provide the shared link URL and optional password to access items not explicitly shared with a user. Use 'shared_link=[link]' or 'shared_link=[link]&shared_link_password=[password]'. |
use_marker_based_pagination | boolean | Optional | Set to true to enable marker-based pagination, which returns a marker for fetching the next page. Only one pagination method can be active at a time. |
Requirements
Output
json— Response from the API endpoint 'get_folders_id_items'.BoxApi.RetrieveFolderLockDetails
Retrieve lock details for a specific folder. Use this tool to get information about locks on a folder. Authentication as the owner or co-owner is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier for a folder. Obtainable by visiting the folder URL in the Box web app. The root folder is ID '0'. |
Requirements
Output
json— Response from the API endpoint 'get_folder_locks'.BoxApi.RetrieveFolderMetadata
Retrieve all metadata for a specific folder. Use this tool to get metadata details for any folder except the root folder.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier for a folder, excluding the root folder with ID `0`. Obtainable from the URL when viewing a folder in Box. |
Requirements
Output
json— Response from the API endpoint 'get_folders_id_metadata'.BoxApi.RetrieveGlobalMetadataTemplates
Fetches global metadata templates from Box. Use this tool to retrieve all available global metadata templates provided by Box for enterprises.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pagination_start_marker | string | Optional | Specifies the position marker to begin returning results for paginated data. |
max_items_per_page | integer | Optional | The maximum number of metadata templates to return per page from the Box global templates. |
Requirements
Output
json— Response from the API endpoint 'get_metadata_templates_global'.BoxApi.RetrieveGroupInfo
Retrieve detailed information about a specified group. This tool fetches information about a group from Box. It's intended for use by group members or users with admin-level permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_id | string | Required | The unique identifier of the group to retrieve information for. Ensure the user has the necessary permissions. |
include_additional_fields | array<string> | Optional | A list of attributes to include in the response. Only specified fields will be returned alongside default mini representation fields. |
Requirements
Output
json— Response from the API endpoint 'get_groups_id'.BoxApi.RetrieveGroupMembership
Fetch details of a specific group membership. This tool retrieves details for a specific group membership. It should be called by group admins or users with admin-level permissions to access membership information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_membership_id | string | Required | The unique identifier for the specific group membership to retrieve. Only admins or users with admin-level permissions can access this information. |
include_fields_list | array<string> | Optional | List of specific attributes to include in the response, overriding standard fields. |
Requirements
Output
json— Response from the API endpoint 'get_group_memberships_id'.BoxApi.RetrieveGroupMemberships
Fetch members of a specified group. Retrieves all the members of a specified group. This tool should be called when you need to get a list of users in a group. Note that access is restricted to members of the group or users with admin-level permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_identifier | string | Required | The unique ID of the group to fetch its members. Only members or admins can access this. |
max_items_per_page | integer | Optional | Specify the maximum number of members to retrieve per page. |
response_offset | integer | Optional | The starting point for retrieving members. Must not exceed 10000 to avoid errors. |
Requirements
Output
json— Response from the API endpoint 'get_groups_id_memberships'.BoxApi.RetrieveLegalHoldPolicies
Retrieve a list of enterprise legal hold policies. Use this tool to obtain a list of legal hold policies associated with an enterprise. Ideal for managing or reviewing legal compliance requirements.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
policy_name_prefix | string | Optional | Limits results to policies where names start with this term. It's case-insensitive. |
response_attributes | array<string> | Optional | A list of attributes to include in the response. Only the specified fields and mini representation fields will be returned. |
pagination_marker | string | Optional | The position marker to start returning results, used for marker-based pagination. Requires `usemarker` to be `true`. |
maximum_items_per_page | integer | Optional | The maximum number of items to return per page. This controls the number of legal hold policies retrieved in a single request. |
Requirements
Output
json— Response from the API endpoint 'get_legal_hold_policies'.BoxApi.RetrieveLegalHoldPolicy
Retrieve information about a specific legal hold policy. This tool is used to fetch details of a legal hold policy based on its ID. It should be called when users need to access information about a particular legal hold policy.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legal_hold_policy_id | string | Required | The unique identifier for the specific legal hold policy to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get_legal_hold_policies_id'.BoxApi.RetrieveLegalHoldPolicyAssignment
Retrieve details of a specific legal hold policy assignment. Use this tool to get information about a specific legal hold policy assignment by its ID. It provides details such as the policy name, status, and related information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legal_hold_policy_assignment_id | string | Required | The unique identifier for the legal hold policy assignment to retrieve details about. |
Requirements
Output
json— Response from the API endpoint 'get_legal_hold_policy_assignments_id'.BoxApi.RetrieveMetadataCascadePolicy
Retrieve a specific metadata cascade policy for a folder. This tool retrieves detailed information about a specific metadata cascade policy that is assigned to a folder. Use this when you need to access the policy information by its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metadata_cascade_policy_id | string | Required | The unique identifier for the metadata cascade policy to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get_metadata_cascade_policies_id'.BoxApi.RetrieveMetadataTemplate
Retrieve a metadata template by scope and template key. This tool retrieves a metadata template using its `scope` and `templateKey`. It is useful for accessing specific template details for Box. To find these values, list all templates for an enterprise or globally, or list those applied to specific files or folders.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
metadata_template_scope | string | Required | Specifies the scope for the metadata template. Choose between 'global' or 'enterprise'. |
metadata_template_name | string | Required | The name of the metadata template to retrieve its details. |
Requirements
Output
json— Response from the API endpoint 'get_metadata_templates_id_id_schema'.BoxApi.RetrieveRetentionPolicyAssignment
Fetch details of a retention policy assignment by ID. Use this tool to retrieve information about a specific retention policy assignment by providing the assignment ID. Useful for managing and reviewing data retention policies in Box.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
retention_policy_assignment_id | string | Required | The ID of the specific retention policy assignment to retrieve details for. |
include_fields_in_response | array<string> | Optional | A list of attributes to include in the response. If specified, standard fields are excluded unless explicitly mentioned. |
Requirements
Output
json— Response from the API endpoint 'get_retention_policy_assignments_id'.BoxApi.RetrieveShieldListById
Retrieve details of a specific shield list by ID. Use this tool to get information about a shield list using its unique ID. It's called to access details of specific shield lists when needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
shield_list_identifier | string | Required | The unique identifier for a shield list. Retrieve this ID by calling the endpoint that lists all shield lists for your enterprise. |
Requirements
Output
json— Response from the API endpoint 'get_shield_lists_id_v2025.0'.BoxApi.RetrieveSignRequestById
Retrieve details of a specific sign request by ID. Use this tool to obtain information about a sign request using its unique identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
signature_request_id | string | Required | The unique identifier for the signature request to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get_sign_requests_id'.BoxApi.RetrieveTaskAssignmentInfo
Retrieve detailed information about a task assignment. This tool is used to get information on a specific task assignment by its ID. It can be called when users need to understand the status, assignee, or other details related to a task assignment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
task_assignment_id | string | Required | The unique identifier for the task assignment to retrieve its details. |
Requirements
Output
json— Response from the API endpoint 'get_task_assignments_id'.BoxApi.RetrieveTaskInformation
Fetch details of a specific task by ID. This tool retrieves information about a specific task using its ID. It should be called when you need detailed information about a particular task.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
task_id | string | Required | The unique identifier for the specific task to retrieve information about. |
Requirements
Output
json— Response from the API endpoint 'get_tasks_id'.BoxApi.RetrieveTrashedFile
Retrieve a file that has been moved to the trash. This tool retrieves details of a specific file that has been directly moved to the trash. It cannot be used if one of its parent folders was trashed instead.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | The unique identifier of a file moved to trash, obtained from the file's URL in the web application. |
include_attributes_in_response | array<string> | Optional | A list of attributes to include in the response. Only specified fields and mini representation fields are returned. |
Requirements
Output
json— Response from the API endpoint 'get_files_id_trash'.BoxApi.RetrieveTrashedFolder
Retrieve a specific folder from the trash. This tool retrieves a folder that has been specifically moved to the trash. It can only be used if the folder itself, rather than a parent folder, is in the trash.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_identifier | string | Required | The unique identifier for a folder. Obtainable from the folder's URL in the web application. '0' represents the root folder. |
include_attributes_in_response | array<string> | Optional | A list of attribute names to include in the response, specifying non-standard fields for retrieval. |
Requirements
Output
json— Response from the API endpoint 'get_folders_id_trash'.BoxApi.RetrieveTrashedItems
Retrieve files and folders from the trash. Use this tool to access files and folders that have been moved to the trash. Supports retrieval of specific attributes and pagination options.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_attributes | array<string> | Optional | List of attributes to include in the response, such as non-default fields. Only these and mini representation fields will be returned. |
maximum_items_per_page | integer | Optional | Specify the maximum number of items to return per page when retrieving trashed items. This value controls pagination to limit the items returned in a single request. |
pagination_offset | integer | Optional | The index to start retrieving items from the trash. Must be less than or equal to 10000. |
pagination_marker | string | Optional | Defines the position marker for marker-based pagination. Requires 'use_marker_based_pagination' to be true. |
sort_direction | string | Optional | The direction to sort results: 'ASC' for ascending or 'DESC' for descending alphabetical order. |
secondary_sort_attribute | string | Optional | Defines the second attribute by which items are sorted, such as 'name', 'date', or 'size'. Unsupported with marker-based pagination. |
use_marker_based_pagination | boolean | Optional | Set to true to use marker-based pagination instead of offset-based pagination, allowing retrieval of the next page with a 'marker' field. |
Requirements
Output
json— Response from the API endpoint 'get_folders_trash_items'.BoxApi.RetrieveTrashedWebLink
Retrieves a web link that has been moved to the trash. Use this tool to get information about a specific web link that has been moved to the trash. Call this when you need to access details of a trashed web link by its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
web_link_id | string | Required | The unique identifier of the web link to retrieve from the trash. |
include_fields_in_response | array<string> | Optional | List of attributes to include in the response, overriding standard fields; only mini representation plus these fields will be returned. |
Requirements
Output
json— Response from the API endpoint 'get_web_links_id_trash'.BoxApi.RetrieveUserCollections
Retrieve collections for a user, including favorites. This tool retrieves all collections for a specified user, currently supporting only the 'favorites' collection.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
requested_fields | array<string> | Optional | A list of attribute names to include in the response. Only specified fields will be returned along with the mini representation. |
pagination_offset | integer | Optional | Offset of the item to start the response. Must be 10000 or less to avoid rejection with a 400 error. |
maximum_items_per_page | integer | Optional | The maximum number of items to return per page when retrieving user collections. |
Requirements
Output
json— Response from the API endpoint 'get_collections'.BoxApi.RetrieveWebLinkInfo
Retrieve information about a specific web link. This tool is used to get details about a web link by its ID. Call this tool when you need information regarding a particular web link from the Box service.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
web_link_id | string | Required | The unique identifier for the web link to retrieve information about. |
shared_link_access_details | string | Optional | The URL and optional password for accessing the shared link, formatted as `shared_link=[link]` or `shared_link=[link]&shared_link_password=[password]`. Use this to access items not explicitly shared with a user. |
Requirements
Output
json— Response from the API endpoint 'get_web_links_id'.BoxApi.UnmarkBoxDocTemplate
Unmarks a file as a Box Doc Gen template. This tool should be called to remove the designation of a Box file as a Doc Gen template. It confirms whether the unmarking was successful.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_id_to_unmark | string | Required | The ID of the file that will no longer be marked as a Box Doc Gen template. |
Requirements
Output
json— Response from the API endpoint 'delete_docgen_templates_id_v2025.0'.