Skip to main content
Box logo
  • Category: file management & storage
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 286
  • Triggers: 20
  • Slug: BOX
  • Version: 20261101_00

Tools

Slug: BOX_ADD_ALLOWED_COLLABORATION_DOMAINCreates a new entry in the list of allowed domains for collaboration within your enterprise. This allows you to whitelist specific domains for external collaboration. Use ‘inbound’ to allow users from the specified domain to collaborate on your enterprise’s files and folders. Use ‘outbound’ to allow your enterprise users to collaborate on content owned by the specified domain. Use ‘both’ for bidirectional collaboration. Note: This action requires enterprise admin privileges and the ‘manage_enterprise_properties’ scope.

Input Parameters

string
required
The domain to add to the list of allowed collaboration domains (e.g., ‘example.com’). This domain will be whitelisted for collaboration with your enterprise based on the specified direction.
string ("both" | "inbound" | "outbound")
required
The direction in which collaborations are allowed. Use ‘inbound’ to allow external users from this domain to collaborate on your content, ‘outbound’ to allow your users to collaborate on their content, or ‘both’ for bidirectional collaboration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ADD_CLASSIFICATION_TO_FILEAdds a classification to a file by specifying the label of the classification to add. Enterprise-only feature: This action requires a Box enterprise account with classification templates configured. Users without an enterprise account will receive an error when attempting to use this feature. This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
required
The name of the classification to apply to this file. This is a required field. To list the available classifications in an enterprise, use the classification API to retrieve the classification template which lists all available classification keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ADD_CLASSIFICATION_TO_FOLDERAdds a classification to a folder by specifying the label of the classification to add. Enterprise-only feature: This action requires a Box enterprise account with classification templates configured. Users without an enterprise account will receive an error when attempting to use this feature. Prerequisites: - A classification template must exist in the enterprise. Use list_all_classifications to retrieve available classification keys. - If no classifications exist, an admin must first create the classification template using add_initial_classifications. Common errors: - 404: Classification template not found (no classifications exist in enterprise) - 409: Classification already exists on this folder (use update action instead) - 403: Insufficient permissions to add classifications This API can also be called by including the enterprise ID in the URL explicitly, for example /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Input Parameters

string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string
required
The name of the classification to apply to this folder. This is a required field. To list the available classifications in an enterprise, use the classification API to retrieve the classification template which lists all available classification keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ADD_INITIAL_CLASSIFICATIONSInitializes the classification template for an enterprise with an initial set of classification options. IMPORTANT: This action requires admin permissions and should only be called once per enterprise when no classifications exist. If classifications already exist, use the ‘add_classification’ action to add more options. Common classification examples: ‘Confidential’, ‘Internal’, ‘Public’, ‘Restricted’. Returns 400 if the classification template already exists. Returns 403 if the user lacks admin permissions.

Input Parameters

string ("enterprise")
required
The scope for the classification template. Must be ‘enterprise’.
array
required
The classification field definition. Must contain exactly one field of type ‘enum’ that holds all valid classification values.
boolean
Whether to hide the classification template from web and mobile interfaces.
string ("Classification")
required
The display name. Must be ‘Classification’.
string ("securityClassification-6VMVochwUWo")
required
The template key. Must be ‘securityClassification-6VMVochwUWo’.
boolean
Whether to copy classifications when a file or folder is copied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ADD_OR_UPDATE_USER_AVATARAdds or updates a user avatar.

Input Parameters

object
required
The avatar image file to upload. Requirements: file must be.jpg or.png format, maximum 1MB size, maximum 1024x1024 pixels.
string
required
The ID of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ADD_USER_TO_GROUPCreates a group membership. Only users with admin-level permissions will be able to use this API.

Input Parameters

string ("admin" | "member")
The role of the user in the group. Can be ‘admin’ or ‘member’. Admins have elevated permissions to manage the group. Members have standard access. Defaults to ‘member’ if not specified.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier (ID) of the user to add to the group. This is a required field.
string
required
The unique identifier (ID) of the group to add the user to. This is a required field.
object
Custom configuration for the permissions an admin of a group will receive. This option has no effect on members with a role of ‘member’. Setting these permissions overwrites the default access levels of an admin. Specifying a value of null for this object will disable all configurable permissions. Specifying permissions will set them accordingly, omitted permissions will be enabled by default. Example: {‘can_run_reports’: true, ‘can_instant_login’: false}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_APPEND_METADATA_TAXONOMY_LEVELAppends a new level to a metadata taxonomy structure. Use when adding hierarchical categories to organize metadata. If no levels exist, this creates the first level.

Input Parameters

string
required
The namespace of the metadata taxonomy. Use format ‘enterprise_{enterprise_id}’ for enterprise taxonomies (e.g., ‘enterprise_123456’).
string
The description of the taxonomy level. Provides additional context about this level (e.g., ‘French Republic’, ‘Second level taxonomy for testing’).
string
required
The display name of the taxonomy level to append. This is the label shown to users (e.g., ‘France’, ‘Level 2’).
string
required
The key of the metadata taxonomy to append the level to (e.g., ‘geography’, ‘product_catalog’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_APPLY_WATERMARK_TO_FILEApplies or update a watermark on a file.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string ("default")
The type of watermark to apply. Currently only supports ‘default’. This value is required by the Box API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_APPLY_WATERMARK_TO_FOLDERApplies or update a watermark on a folder.

Input Parameters

string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string ("default")
The type of watermark to apply. Currently only supports ‘default’ as the value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ASK_QUESTIONAsk natural-language questions about Box files or a Box Hub using Box AI. Supports single-item and multiple-item question-answering modes, with optional conversation history and citations; requires the manage_ai scope.

Input Parameters

string ("multiple_item_qa" | "single_item_qa")
required
The query mode: ‘single_item_qa’ for questions about one file (items array must have exactly 1 element), or ‘multiple_item_qa’ for questions across multiple files (up to 25 files).
array
required
List of files to query. For ‘single_item_qa’ mode, provide exactly 1 item. For ‘multiple_item_qa’ mode, provide 1-25 items. Each item needs ‘id’ and ‘type’ fields.
string
required
The question to ask about the file(s). Maximum 10,000 characters.
object
Schema for specifying a custom AI agent to handle the request.
array
Optional conversation history to provide context for follow-up questions.
boolean
Set to true to include source citations in the response showing where the answer came from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ASSIGN_RETENTION_POLICYAssigns a retention policy to an item in Box to enforce content retention. Use this action to apply a retention policy to: - An entire enterprise (assign_to_type=‘enterprise’, no ID needed) - A specific folder (assign_to_type=‘folder’, provide folder ID) - Items matching metadata criteria (assign_to_type=‘metadata_template’, provide template ID) Prerequisites: - Box Governance license is required - Admin permissions with ‘manage_data_retention’ and ‘enterprise_content’ scopes - A retention policy must exist (use create_retention_policy first) Example usage for folder assignment: - policy_id: “173463” (from create_retention_policy or list_retention_policies) - assign_to_type: “folder” - assign_to_id: “6564564” (the folder ID)

Input Parameters

string
required
The unique ID of the retention policy to assign (e.g., ‘173463’). Get this from list_retention_policies or create_retention_policy.
array
Optional metadata filters when assign_to_type is ‘metadata_template’. Array of objects with ‘field’ (metadata attribute key ID) and ‘value’ (field value ID). Only enum and multiselect field types are supported. Currently limited to one filter object.
string
The ID of the target item. Required for ‘folder’ (folder ID like ‘6564564’) and ‘metadata_template’ (template ID). Omit or set to null when assign_to_type is ‘enterprise’.
string ("enterprise" | "folder" | "metadata_template")
required
The type of item to assign the policy to. Options: ‘enterprise’ (applies to all enterprise content), ‘folder’ (applies to specific folder by ID), ‘metadata_template’ (applies based on metadata criteria).
string
The date field that determines when retention begins. For ‘metadata_template’ assignments, this can be a date field’s metadata attribute key ID (e.g., ‘upload_date’). Only applicable when assign_to_type is ‘metadata_template’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ASSIGN_STORAGE_POLICYCreates a storage policy assignment for an enterprise or user. Storage policies control where data is stored geographically (data residency). This action requires Box Zones or similar enterprise feature to be enabled. Use ‘list_storage_policies’ to get available policies before assignment.

Input Parameters

string
required
The ID of the entity to assign the policy to. If assigned_to_type is ‘user’, provide a user ID. If ‘enterprise’, provide the enterprise ID.
string ("enterprise" | "user")
required
The type of entity to assign the storage policy to. Use ‘user’ to assign to a specific user, or ‘enterprise’ to set the default policy for the entire enterprise.
string
required
The unique ID of the storage policy to assign. Get available policies using the ‘list_storage_policies’ action.
string ("storage_policy")
The type of policy to assign. Must be ‘storage_policy’. This field is fixed and agents typically don’t need to specify it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_ASSIGN_TASKAssigns a task to a user. A task can be assigned to more than one user by creating multiple assignments.

Input Parameters

string
required
The unique identifier of the task to assign. Required.
string ("task")
The type of the item being assigned. Must be ‘task’.
string
The user ID of the person to assign the task to. Either this or assign_to_login must be provided, but not both.
string
The email address (login) of the user to assign the task to. Either this or assign_to_id must be provided, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_AUTHORIZE_USERConstructs a Box OAuth 2.0 authorization URL for the user to visit and grant permission to act on their behalf.

Input Parameters

string
A space-separated list of application scopes to request (e.g., ‘root_readwrite manage_users’). Defaults to all scopes configured for the application if not specified.
string
A custom string of your choice. Box will pass the same string to the redirect URL when authentication is complete. This parameter can be used to identify a user on redirect, as well as protect against hijacked sessions and other exploits.
string
required
The Client ID of the application requesting to authenticate the user. Found in the Box developer console under your application’s OAuth 2.0 Parameters section.
string
The HTTPS URI to which Box redirects the browser after the user grants or denies permission. Must match one of the redirect URIs configured in your Box application. Required if multiple redirect URIs are configured; otherwise a ‘redirect_uri_missing’ error occurs.
string ("code")
required
The type of response to receive. Must be ‘code’ for the authorization code grant flow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CANCEL_BOX_SIGN_REQUESTCancels a pending Box Sign request that has not yet been fully signed or declined. After cancellation, any outstanding signers will no longer be able to sign the document. Only the user who created the request (the requester) is able to cancel it. Note: A request cannot be cancelled if it was already declined, fully signed, or if the document is still in the converting state. Returns the cancelled sign request object with updated status set to ‘cancelled’.

Input Parameters

string
required
The unique identifier of the Box Sign request to cancel. This ID is returned when creating a sign request or can be retrieved from the list of sign requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_COMMIT_UPLOAD_SESSIONCommits an upload session and creates a file from the uploaded chunks. This is the final step in a chunked upload workflow: 1. Create an upload session using ‘create_upload_session’ 2. Upload file parts using ‘upload_part_of_file’ 3. Commit the session using this action to finalize the file Requirements: - All parts must be uploaded before committing - The digest header must contain the SHA1 hash of the entire file (Base64 encoded) - Parts array must include part_id, offset, and size for each uploaded chunk Note: The API may return 202 if processing is not complete. In this case, check the retry_after field and retry after the specified number of seconds.

Input Parameters

array
required
List of uploaded parts to commit. Each part must include: ‘part_id’ (string), ‘offset’ (integer byte position), ‘size’ (integer bytes). Optionally includes ‘sha1’ (string hash of the part). These values are returned by the upload part API.
string
required
The Base64-encoded SHA1 hash of the entire file being uploaded. Format should be the raw Base64 string (e.g., ‘fpRyg5eVQletdZqEKaFlqwBXJzM=’). The ‘sha=’ prefix will be added automatically.
string
Optional. The last known ETag value of the upload session. If provided, the request fails with 412 if the session has changed.
object
Optional file attributes to set on the uploaded file, such as ‘content_modified_at’ (ISO 8601 timestamp). Example: {‘content_modified_at’: ‘2024-01-15T12:00:00Z’}.
string
Optional. ETag value to check for changes. Request fails with 304 if item unchanged.
string
required
The ID of the upload session to commit. This is returned when creating an upload session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_COPY_FILECreates a copy of a file.

Input Parameters

string
An optional new name for the copied file. There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (/, “), and protected names like . and .. are automatically sanitized by removing the non-allowed characters.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
An optional ID of the specific file version to copy.
string
required
The ID of folder to copy the file to. This parameter is required - the destination folder must be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_COPY_FILE_REQUESTCopies an existing file request to a new folder. File requests allow external users to upload files to a specific folder without needing a Box account. This action creates a copy of an existing file request and associates it with a different destination folder. IMPORTANT LIMITATION: File request IDs cannot be discovered via API - they can only be obtained from the Box web application. To find a file_request_id: 1. Navigate to Box web UI (https://app.box.com) 2. Go to the folder containing the file request 3. Open the file request settings 4. Copy the ID from the URL (e.g., https://*.app.box.com/filerequest/123 → ID is “123”) Common use cases: - Creating file request templates that can be copied to multiple project folders - Automating file request creation for new cases/customers/projects - Duplicating file requests with different settings (title, description, etc.) When copying, you can optionally override settings from the source file request including title, description, status, and form requirements.

Input Parameters

string
The title to use for the copied file request. This is displayed to uploaders on the file request form. If not provided, the title from the source file request is used.
object
required
The destination folder to associate with the copied file request. Must include the folder ‘id’ field.
string ("active" | "inactive")
Status of the file request.
string
The date after which the copied file request will no longer accept submissions (ISO 8601 format, e.g., ‘2030-12-31T23:59:59Z’). After this date, the status is automatically set to ‘inactive’. If not provided, no expiration is set.
string
The description to use for the copied file request. This is displayed to uploaders on the file request form. If not provided, the description from the source file request is used.
string
required
The unique identifier of the file request to copy. IMPORTANT: File request IDs can ONLY be obtained from the Box web application URL - there is no API to list file requests. Visit a file request in the Box web UI (e.g., https://*.app.box.com/filerequest/123) and copy the ID from the URL. In this example, the file_request_id would be ‘123’.
boolean
Whether uploaders must provide their email address when submitting files to the copied file request. If not provided, the setting from the source file request is used.
boolean
Whether uploaders must provide a description when submitting files to the copied file request. If not provided, the setting from the source file request is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_COPY_FOLDERCreates a copy of a folder within a destination folder. The original folder will not be changed.

Input Parameters

string
An optional new name for the copied folder. There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (/, “), as well as names with trailing spaces are prohibited. Additionally, the names . and .. are not allowed either.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier of the folder to copy. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder with the ID 0 can not be copied.
string
required
The ID of the destination folder where the copy will be placed. Use ‘0’ to copy to the root folder (All Files). This is a required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_AI_AGENTCreates a custom AI agent in Box AI Studio. At least one capability required: ask (Q&A), text_gen (content generation), or extract (metadata extraction). Requirements: Box Enterprise Advanced account, Box AI Studio enabled, “Manage AI” scope in Developer Console. Access options: ‘enabled’ (all users), ‘disabled’ (none), ‘enabled_for_selected_users’ (specified in allowed_entities). Example: Set name + ask__type=‘ai_agent_ask’ + ask__access__state=‘enabled’ + ask__description to create Q&A agent.

Input Parameters

string
required
The display name of the AI Agent visible to users in the Box interface.
string ("ai_agent")
The type of agent. Must be ‘ai_agent’.
string ("ai_agent_ask")
Type identifier for ask capability. Must be ‘ai_agent_ask’ when enabling this capability.
string
Access control for the agent. Options: ‘enabled’ (all enterprise users), ‘disabled’ (no access), ‘enabled_for_selected_users’ (only specified users/groups in allowed_entities).
string ("ai_agent_extract")
Type identifier for extract capability. Must be ‘ai_agent_extract’ when enabling this capability.
string
Avatar icon URL for the agent. Format: https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>. Available icons: logo_boxAi, logo_stamp, logo_legal, logo_finance, logo_config, logo_handshake, logo_analytics, logo_classification (both .png and .svg supported). Example: https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg
string ("ai_agent_text_gen")
Type identifier for text generation capability. Must be ‘ai_agent_text_gen’ when enabling this capability.
array
Users/groups with access when access_state=‘enabled_for_selected_users’. Format: [{‘type’: ‘user’|‘group’, ‘id’: ‘<entity_id>’}]
string
User-facing description of what questions this agent can answer.
string
Enable state for ask capability. Options: ‘enabled’, ‘disabled’.
string
User-facing description of what metadata/data this agent can extract from documents.
string
Enable state for extract capability. Options: ‘enabled’, ‘disabled’.
string
User-facing description of what content this agent can generate.
string
Enable state for text generation capability. Options: ‘enabled’, ‘disabled’.
string
System prompt/instructions defining agent behavior, tone, and constraints for answering questions.
array
Up to 4 suggested questions shown to users. Example: [‘What is in this file?’, ‘Summarize the key points’]
string
System prompt/instructions defining extraction rules, field mappings, and output formatting.
string
System prompt/instructions defining writing style, format, and content generation guidelines.
array
Up to 4 suggested prompts shown to users. Example: [‘Write a summary’, ‘Create a report’]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_BOX_SIGN_REQUESTCreates a Box Sign request to send documents for electronic signing. Prepares documents and sends signature requests to signers via email. Signers do not need Box accounts. Supports up to 10 files, 35 signers, sequential signing order, templates, and custom redirect URLs. Requires Box Sign feature enabled and sign_requests.readwrite scope.

Input Parameters

string
Name of the signature request. Used for identification purposes.
array
required
List of signers for the signature request. At least one signer required, maximum 35 signers.
integer
Number of days (0-730) until the signature request automatically expires. No expiration if not set.
string
External reference ID for tracking the signature request in your system.
string
ID of a Box Sign template to use. When provided, template settings are applied to the request.
array
List of tags to pre-populate in the document before sending to signers.
string
Global URL to redirect all signers to after successfully signing.
array
required
List of files to be signed. At least one file required, maximum 10 files. All file types are converted to PDF.
string
Custom message in the signature request email. Supports limited HTML tags: a, abbr, b, blockquote, code, em, i, ul, li, ol, strong.
string
Custom subject line for the signature request email sent to signers.
object
Destination folder for signed documents. Cannot be the root folder (id=‘0’).
string ("blue" | "black" | "red")
Color to use for the signature
string
Name of the external system for the signing log reference.
boolean
Whether to send automatic reminders on days 3, 8, 13, and 18 to outstanding signers.
string
Global URL to redirect signers to if they decline to sign.
boolean
Whether signers can use typed text as their signature (default: true).
boolean
If true, returns a prepare_url for completing document preparation in the Box UI before sending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_BOX_SKILL_CARDS_ON_FILEApplies one or more Box Skills metadata cards to a file. NOTE: This action creates NEW Box Skill cards on a file. If Box Skill cards already exist on the file, this action will fail with a 409 Conflict error. In that case: - Use ‘remove_box_skill_cards_from_file’ to delete existing cards first, then create new ones, OR - Use ‘update_all_box_skill_cards_on_file’ to overwrite all existing cards

Input Parameters

array
required
A list of Box Skill cards to apply to this file. Each card must include: ‘type’ (always ‘skill_card’), ‘skill_card_type’ (one of: ‘keyword’, ‘transcript’, ‘timeline’, ‘status’), ‘skill’ (object with ‘type’: ‘service’ and ‘id’), ‘invocation’ (object with ‘type’: ‘skill_invocation’ and ‘id’), and ‘skill_card_title’ (object with ‘code’ and ‘message’). Additional fields depend on card type: keyword cards need ‘entries’ array with ‘text’ fields; transcript cards need ‘entries’ with ‘text’ and ‘appears’ (array of start/end timestamps) plus optional ‘duration’; timeline cards need ‘entries’ with ‘text’, ‘appears’, and optional ‘image_url’ plus ‘duration’; status cards need ‘status’ object with ‘code’ and ‘message’.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123. Note: This file must NOT have existing Box Skill cards metadata, otherwise a 409 Conflict error will occur.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_COLLAB_EXEMPTIONExempts a specific user from the enterprise’s collaboration domain restrictions. This allows the specified user to collaborate with external parties from any domain, bypassing the enterprise’s allowed collaboration domain list. PREREQUISITES: - The enterprise MUST have at least one allowed collaboration domain configured. Use ‘Add domain to list of allowed collaboration domains’ first if needed. - The user must not already have an exemption (returns 409 Conflict if exists). - Requires enterprise admin privileges with ‘manage_users’ scope. COMMON ERRORS: - 409 Conflict: User already exempt OR no whitelisted domains exist for enterprise. - 403 Forbidden: Insufficient permissions to manage user exemptions. - 404 Not Found: The specified user ID does not exist.

Input Parameters

string
required
The unique identifier (ID) of the Box user to exempt from collaboration domain restrictions. This allows the specified user to collaborate with external parties regardless of the enterprise’s allowed domain list. Example: ‘23522323’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_COLLABORATIONAdds a collaboration for a single user or a single group to a file or folder. Collaborations can be created using email address, user IDs, or a group IDs. If a collaboration is being created with a group, access to this endpoint is dependent on the group’s ability to be invited. If collaboration is in pending status, the following fields are redacted: - login and name are hidden if a collaboration was created using user_id, - name is hidden if a collaboration was created using login.

Input Parameters

string ("co-owner" | "editor" | "previewer" | "previewer uploader" | "uploader" | "viewer" | "viewer uploader")
required
The level of access granted. Valid values are: ‘editor’ (full read/write access), ‘viewer’ (read-only access), ‘previewer’ (preview-only), ‘uploader’ (upload-only), ‘previewer uploader’ (preview and upload), ‘viewer uploader’ (view and upload), or ‘co-owner’ (full access including sharing).
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
boolean
Determines if users should receive email notification for the action performed.
string
The unique ID of the file or folder to grant access to. Required for creating a new collaboration. You can find this ID in the Box web interface URL or from other API responses.
string
Set the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the Automatically remove invited collaborators: Allow folder owners to extend the expiry date setting has been enabled in the Enterprise Settings of the Admin Console. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error.
string ("file" | "folder")
The type of the item that this collaboration will be granted access to. Must be either ‘file’ or ‘folder’. Required for creating a new collaboration.
boolean
Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee”s All Files page. We recommend you limit the number of collaborations with can_view_path enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a can_view_path of true. can_view_path can only be used for folder collaborations.
boolean
If set to true, collaborators have access to shared items, but such items won”t be visible in the All Files list. Additionally, collaborators won”t see the the path to the root folder for the shared item.
string
The Box user ID or group ID to invite. Either this field or ‘accessible_by_login’ must be provided (not both). Use this when you know the exact Box user/group ID.
string ("group" | "user")
The type of collaborator to invite. Must be either ‘user’ or ‘group’. Required. Use ‘user’ when inviting an individual (by email or user ID), or ‘group’ when sharing with a Box group.
string
The email address of the user to invite as a collaborator. Either this field or ‘accessible_by_id’ must be provided (not both). Use this for user invitations when you have the email address but not the Box user ID. Not applicable for groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_COMMENTAdds a comment by the user to a specific file, or as a reply to an other comment.

Input Parameters

array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
The text of the comment. Required unless tagged_message is provided. To mention a user, use tagged_message instead.
string
required
The ID of the item to attach the comment to. This can be a file ID or a comment ID (when replying to a comment).
string ("comment" | "file")
required
The type of item this comment will be placed on. Use ‘file’ to comment on a file, or ‘comment’ to reply to an existing comment.
string
The text of the comment with user mentions. Use the format @[user_id:name] to mention a user, which sends them an email notification. The user_id is the target user’s ID, and name is a display phrase that links to the user’s profile in Box UI. Either message or tagged_message must be provided, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_EMAIL_ALIASAdds a new email alias to a user account. The email domain must be registered to your enterprise. Returns the newly created email alias object with id, type, email, and is_confirmed fields.

Input Parameters

string
required
The email address to add to the account as an alias. Note: The domain of the email alias must be registered to your enterprise. See the domain verification guide (https://support.box.com/hc/en-us/articles/4408619650579-Domain-Verification) for steps to add a new domain.
string
required
The ID of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_FOLDERCreates a new empty folder within the specified parent folder.

Input Parameters

string
required
The name for the new folder. There are some restrictions to the file name. Names containing non-printable ASCII characters, forward and backward slashes (/, “), as well as names with trailing spaces are prohibited. Additionally, the names . and .. are not allowed either.
string
A comma-separated list of attributes to include in the response (e.g., ‘id,name,created_at’). When specified, only the requested fields plus mini representation fields are returned. Common fields: id, type, name, description, size, created_at, modified_at, path_collection, created_by, modified_by, owned_by, shared_link, parent, item_status, tags, has_collaborations.
string
The ID of the parent folder where the new folder will be created. Use ‘0’ for the root folder (All Files). Example: ‘123456789’.
string ("not_synced" | "partially_synced" | "synced")
Specifies whether a folder should be synced to a user”s device or not. This is used by Box Sync (discontinued) and is not used by Box Drive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_FOLDER_LOCKCreates a folder lock on a folder, preventing it from being moved and/or deleted. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Input Parameters

string
The ID of the folder.
string
The content type the lock is being applied to. Only folder is supported.
boolean
Whether moving the folder should be locked.
boolean
Whether deleting the folder should be locked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_GROUPCreates a new group of users in an enterprise. Only users with admin permissions can create new groups.

Input Parameters

string
required
The name of the new group to be created. This name must be unique within the enterprise.
array
A list of additional attributes to include in the response. Provide as a list of strings, e.g. [‘description’, ‘provenance’, ‘invitability_level’]. Available fields: ‘id’, ‘name’, ‘description’, ‘provenance’, ‘external_sync_identifier’, ‘invitability_level’, ‘member_viewability_level’, ‘created_at’, ‘modified_at’, ‘permissions’. If specified, only the mini representation fields plus the requested fields are returned.
string
Keeps track of which external source this group is coming, for example Active Directory, or Okta. Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.
string
A human readable description of the group.
string ("admins_and_members" | "admins_only" | "all_managed_users")
Specifies who can invite the group to collaborate on folders. When set to admins_only the enterprise admin, co-admins, and the group”s admin can invite the group. When set to admins_and_members all the admins listed above and group members can invite the group. When set to all_managed_users all managed users in the enterprise can invite the group.
string
An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an Active Directory Object ID or a Google Group ID. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
string ("admins_and_members" | "admins_only" | "all_managed_users")
Specifies who can see the members of the group. * admins_only - the enterprise admin, co-admins, group”s group admin * admins_and_members - all admins and group members * all_managed_users - all managed users in the enterprise

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_METADATA_CASCADE_POLICYCreates a new metadata cascade policy that automatically applies a metadata template to all files and subfolders within a specified folder. Prerequisites: - A metadata instance must already be applied to the target folder before creating the cascade policy. - The target folder cannot be the root folder (ID ‘0’). - Enterprise admin must have enabled ‘Cascading Folder Level Metadata’ in Admin Console > Enterprise Settings > Content & Sharing. Common use case: After applying metadata to a folder, create a cascade policy to ensure all new items added to that folder automatically inherit the metadata. Returns: A MetadataCascadePolicy object with id, type, owner_enterprise, parent, scope, and templateKey fields. Error codes: - 400: Invalid format for scope, templateKey, or folder_id - 403: Policy cannot apply to restricted folders (e.g., root folder) - 404: Folder or template not found/inaccessible - 409: Duplicate policy already exists for this folder/template combination

Input Parameters

string ("enterprise" | "global")
required
The scope of the metadata template. Use ‘global’ for Box’s built-in templates (e.g., ‘global.properties’), or ‘enterprise’ for custom enterprise templates. The metadata instance with this scope must already exist on the target folder.
string
required
The unique identifier of the folder to apply the cascade policy to. IMPORTANT: This folder must already have a metadata instance of the targeted template applied to it before creating the cascade policy. The folder ID can be found in Box URLs (e.g., ‘https://app.box.com/folder/123’ has folder_id ‘123’). Note: Cannot be applied to the root folder (ID ‘0’).
string
required
The key identifying the metadata template. Common examples include ‘properties’ for the global.properties template. For enterprise templates, the key is often derived from the template’s display name (e.g., ‘Contract Template’ becomes ‘contractTemplate’). You can find template keys by listing templates for an enterprise or getting metadata instances on a file/folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_METADATA_INSTANCE_ON_FILEApplies an instance of a metadata template to a file. The metadata_fields parameter contains key-value pairs that match the fields defined in the template. In most cases only field keys present in the metadata template will be accepted, except for the global.properties template which accepts any key-value pair. Common error codes: - 409 (tuple_already_exists): A metadata instance of this template already exists on the file. - 404 (not_found): The file was not found or the user does not have access. - 404 (instance_tuple_not_found): The metadata template was not found. - 400 (schema_validation_failed): Invalid field key or value type for the template.

Input Parameters

string
required
The scope of the metadata template. Use ‘global’ for global templates (like ‘properties’) or ‘enterprise’ for enterprise templates. For enterprise templates, the scope will be automatically converted to the enterprise ID format (e.g., ‘enterprise_12345’).
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
required
The name of the metadata template (templateKey). For example: ‘properties’ for the global.properties template, or a custom template key like ‘testTemplate’. Use BOX_LIST_ALL_METADATA_TEMPLATES_FOR_ENTERPRISE or BOX_LIST_ALL_GLOBAL_METADATA_TEMPLATES to find available template keys.
object
A dictionary of metadata field key-value pairs to set on the file. The keys must match the field keys defined in the metadata template. For the ‘global.properties’ template, any key-value pairs can be used. Example: {‘author’: ‘John’, ‘status’: ‘draft’}. For enum fields, provide the option key string. For multiSelect fields, provide a list of strings. For date fields, use ISO 8601 format (e.g., ‘2024-01-15T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_METADATA_INSTANCE_ON_FOLDERApplies an instance of a metadata template to a folder. In most cases only values that are present in the metadata template will be accepted, except for the global.properties template which accepts any key-value pair. To display the metadata template in the Box web app the enterprise needs to be configured to enable Cascading Folder Level Metadata for the user in the admin console.

Input Parameters

string
required
The scope of the metadata template. Use ‘global’ for global templates or ‘enterprise’ for enterprise templates (will use the enterprise ID like ‘enterprise_12345’).
object
A dictionary of key-value pairs representing the metadata fields to apply. For the ‘global.properties’ template, any key-value pairs are accepted. For enterprise templates, keys must match the template’s field names. Example: {‘field1’: ‘value1’, ‘field2’: ‘value2’}
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string
required
The name of the metadata template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_METADATA_TAXONOMYTool to create a new metadata taxonomy in Box. Use when you need to set up a hierarchical classification system for organizing and categorizing metadata templates.

Input Parameters

string
The taxonomy key. If not provided, it will be automatically generated from the displayName by converting to lowercase and replacing spaces and non-alphanumeric characters with underscores. Maximum length is 256 characters. Must match pattern ^[a-zA-Z_][-a-zA-Z0-9_]*$.
string
required
The namespace of the metadata taxonomy to create. Must be in the format ‘enterprise_{enterprise_id}’ where enterprise_id is your Box enterprise ID. You can retrieve your enterprise ID from the /users/me endpoint with fields=enterprise.
string
required
The display name of the taxonomy. This name will be visible in the Box web app and can be used to identify the taxonomy. Maximum length is 4096 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_METADATA_TAXONOMY_LEVELSAppends hierarchical levels to a metadata taxonomy in ascending order of the supplied level numbers. Levels are appended individually, so an error can leave earlier levels in place.

Input Parameters

array
required
An array of taxonomy levels to create. Each level must have a unique level number (starting from 1), a display name, and optionally a description. Levels should be ordered hierarchically.
string
required
The namespace of the metadata taxonomy. For enterprise taxonomies, this is typically in the format ‘enterprise_<enterprise_id>’ (e.g., ‘enterprise_123456’).
string
required
The unique key identifier of the metadata taxonomy to which the levels will be added. This key was assigned when the taxonomy was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_METADATA_TAXONOMY_NODETool to create a new metadata taxonomy node within a specified taxonomy. Use when you need to add a new classification or category to an existing metadata taxonomy hierarchy.

Input Parameters

integer
required
The level of the taxonomy node in the hierarchy. Root-level nodes have level 1, their children have level 2, and so on. Must be a positive integer.
string
The identifier of the parent taxonomy node. Omit this field when creating root-level nodes (level 1). For child nodes, provide the UUID of the parent node.
string
required
The namespace of the metadata taxonomy. Typically follows the format ‘enterprise_{enterprise_id}’ for enterprise taxonomies. For example: ‘enterprise_1351007304’.
string
required
The display name of the taxonomy node. This is the human-readable name that will be shown in the Box UI. For example: ‘France’, ‘California’, ‘Engineering Department’.
string
required
The key of the metadata taxonomy under which to create the node. This identifies the specific taxonomy within the namespace. For example: ‘geography’ or ‘department’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_METADATA_TEMPLATECreates a new metadata template that can be applied to files and folders.

Input Parameters

string
The scope of the metadata template to create. Must be set to ‘enterprise’ as applications cannot create global templates. Defaults to ‘enterprise’.
array
An ordered list of template fields which are part of the template. Each field can be a regular text field, date field, number field, as well as a single or multi-select list.
boolean
Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API.
string
required
The display name of the template.
string
A unique identifier for the template. This identifier needs to be unique across the enterprise for which the metadata template is being created. When not provided, the API will create a unique templateKey based on the value of the displayName.
boolean
Whether or not to copy any metadata attached to a file or folder when it is copied. By default, metadata is not copied along with a file or folder when it is copied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_RETENTION_POLICYCreates a retention policy for managing content lifecycle in Box. Retention policies prevent permanent deletion of content for a specified duration. Once created, policies can be assigned to folders or the entire enterprise. Note: This endpoint requires the Box Governance add-on feature and the ‘manage retention policies’ scope enabled in your application.

Input Parameters

string
The additional text description of the retention policy (max 500 characters).
string
required
The name for the retention policy. Must be unique within the enterprise.
string ("finite" | "indefinite")
required
The type of the retention policy. Use ‘finite’ when the retention duration is known upfront, or ‘indefinite’ when the retention duration is unknown. For finite policies, retention_length must be specified.
string ("modifiable" | "non_modifiable")
Retention type enum: controls if policy can be modified after creation.
integer
The number of days to retain content under this policy. Required when policy_type is ‘finite’. Minimum value is 1 day. For ‘indefinite’ policies, this field should not be set. Specify as an integer (e.g., 30, 365, 2555).
string ("permanently_delete" | "remove_retention")
required
The action to take when the retention policy expires. ‘permanently_delete’ will permanently delete the retained content. ‘remove_retention’ lifts the retention policy, allowing users to delete the content manually.
boolean
Whether owners and co-owners of files are notified when the retention policy nears expiration.
boolean
Whether file owners are allowed to extend the retention period before it expires.
array
A list of users to notify when the retention policy duration is about to end. Each user should be specified with at least their ‘id’ field. Example: [{‘type’: ‘user’, ‘id’: ‘12345678’}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_SHIELD_INFORMATION_BARRIERCreates a shield information barrier to establish an “ethical wall” that separates individuals/groups within an enterprise and prevents confidential information sharing. Prerequisites: Box Shield add-on must be licensed and enabled. Admin-level permissions required. Only one barrier allowed per enterprise. NOT available in Shield trials. Workflow: 1) Get enterprise ID from /users/me, 2) Create barrier (starts in ‘draft’), 3) Create segments and add users, 4) Define segment restrictions, 5) Enable barrier. Common errors: 400 (missing enterprise), 404 (Shield not enabled/invalid ID), 409 (barrier already exists).

Input Parameters

string
required
The unique identifier of the enterprise where the shield information barrier will be created. This ID can be obtained from the GET /users/me endpoint (enterprise.id field). Example: ‘1351007304’
string
The type of the enterprise object. Must be ‘enterprise’. This field has a sensible default and typically doesn’t need to be changed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORTCreates a shield information barrier report for a given barrier. Shield information barrier reports track the configuration status of information barriers in Box Shield. When created, reports start with status ‘pending’ and transition to ‘done’, ‘error’, or ‘cancelled’. Note: Requires Box Shield enterprise add-on license. Returns 404 if Shield is not enabled for the enterprise. Returns 409 if a report is already being created.

Input Parameters

string
required
The ID of the shield information barrier to create a report for. Get this from BOX_LIST_SHIELD_INFORMATION_BARRIERS or BOX_CREATE_SHIELD_INFORMATION_BARRIER.
string ("shield_information_barrier")
The type of the shield information barrier resource. Must be ‘shield_information_barrier’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENTCreates a new shield information barrier segment for compliance and information isolation. Segments represent organizational divisions (e.g., Investment Banking, Research, Trading) that need to be isolated from each other for regulatory compliance. Each segment can have users assigned to it, and restrictions can be created to prevent collaboration between specific segments. Prerequisites: Box Shield license, existing barrier (create_shield_information_barrier), barrier in ‘draft’/‘pending’ status. Returns 404 if Shield not enabled or barrier doesn’t exist. Returns 409 if segment name already exists. Related: create_shield_information_barrier_segment_member, create_shield_information_barrier_segment_restriction, list_shield_information_barrier_segments

Input Parameters

string
required
Required. The name of the segment to create (e.g., ‘Investment Banking’, ‘Research Division’, ‘Trading Desk’). This name must be unique within the barrier and identifies the group of users for compliance isolation.
string
Optional description explaining the segment’s purpose and scope (e.g., ‘Corporate division handling M&A advisory services and IPO underwriting’). Helps administrators understand the segment’s business context.
string
required
Required. The unique ID of the shield information barrier to create the segment under. Obtain this from list_shield_information_barriers or create_shield_information_barrier actions. The barrier must be in ‘draft’ or ‘pending’ status to add segments.
string ("shield_information_barrier")
The type of the shield information barrier object. Must be ‘shield_information_barrier’. This field has a sensible default and typically doesn’t need to be explicitly provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERAdds a Box user to a shield information barrier segment for compliance and information security. This assigns users to segments that restrict collaboration between departments (e.g., Investment Banking vs Research in financial institutions). Users can only belong to ONE segment at a time. Prerequisites: Box Shield license, existing barrier and segment, valid user ID. Returns 404 if Shield not enabled or resources don’t exist. Related: create_shield_information_barrier_segment, list_shield_information_barrier_segment_members

Input Parameters

string ("shield_information_barrier_segment_member")
The type of the object. Must be ‘shield_information_barrier_segment_member’ if provided. This is an optional field that defaults to the correct value.
string
required
Required. The ID of the Box user to add as a member of the segment. Obtain this from get_current_user, list_enterprise_users, or other user-related actions. The user must exist in the same enterprise.
string ("user")
The type of the user object. Must be ‘user’. This field has a sensible default value and typically doesn’t need to be explicitly provided.
string
(Optional) The unique identifier for the shield information barrier. If not provided, the system will infer it from the segment.
string ("shield_information_barrier")
(Optional) The type of the shield information barrier object. Must be ‘shield_information_barrier’ if provided.
string
required
Required. The unique ID of the shield information barrier segment to which the user will be added. Obtain this from list_shield_information_barrier_segments or create_shield_information_barrier_segment actions. A user can only belong to one segment.
string ("shield_information_barrier_segment")
The type of the shield barrier segment object. Must be ‘shield_information_barrier_segment’. This field has a sensible default and typically doesn’t need to be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONCreates a ONE-WAY shield information barrier segment restriction preventing collaboration between members of two segments (e.g., Investment Banking cannot collaborate with Research). Prerequisites: - Box Shield add-on enabled (returns 404 if not available) - Admin privileges required - Both segments must exist in the same barrier Key details: - Creates ONE-WAY restriction. For bidirectional, call twice with swapped segment IDs - shield_information_barrier parameter is optional (inferred from segments) - Use create_shield_information_barrier_segment to create segments first - Common for regulatory compliance and ethical walls Workflow: 1) Create barrier 2) Create segments 3) Create restrictions 4) Add members to segments

Input Parameters

string
The type of the restriction object. Must be ‘shield_information_barrier_segment_restriction’.
string
required
The ID of the segment to be restricted. Members of the requesting segment cannot collaborate with members of this restricted segment.
string
The type of the restricted segment. Must be ‘shield_information_barrier_segment’.
string
Optional: The unique identifier (ID) of the parent shield information barrier. If not provided, Box will infer it from the segment IDs. Obtain this from the list or create shield information barrier endpoints.
string
The type of the shield information barrier. Must be ‘shield_information_barrier’.
string
required
The ID of the requesting segment that initiates the restriction. This segment’s members will be restricted from collaborating with the restricted segment.
string
The type of the requesting segment. Must be ‘shield_information_barrier_segment’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_SLACK_INTEGRATION_MAPPINGCreates a Slack integration mapping by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this endpoint.

Input Parameters

object
Configuration options for the integration mapping.
object
required
The Box folder to map to a Slack channel. The service account must be an owner or co-owner of this folder.
object
required
The Slack channel information to map to a Box folder. Requires either slack_workspace_id or slack_org_id depending on how Box for Slack is installed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_TASKCreates a single task on a file. This task is not assigned to any user and will need to be assigned separately.

Input Parameters

string ("complete" | "review")
The type of task to create: ‘review’ creates an approval task that can be approved or rejected, ‘complete’ creates a general task that can be marked as complete. Default: ‘review’
string
The date and time when the task is due in ISO 8601 format (e.g., ‘2026-12-31T23:59:59Z’). If not provided, the task has no due date.
string
Optional message or instructions for the task assignee
string
The unique identifier of the file to create the task on
string ("file")
The type of the item, must be ‘file’
string ("all_assignees" | "any_assignee")
Determines how many assignees must complete the task: ‘all_assignees’ (default) requires all assignees to complete it, ‘any_assignee’ requires only one assignee to complete it

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_TEAMS_INTEGRATION_MAPPINGCreates a Microsoft Teams integration mapping that links a Teams channel or team to a Box folder. Once mapped, files shared in the Teams channel are automatically stored in the linked Box folder. Requires Admin/Co-Admin role and the manage_enterprise_properties scope. Prerequisites: - Box for Teams must be installed in the Microsoft Teams workspace - The Box folder must be owned by the enterprise and not already mapped See: https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams

Input Parameters

object
required
The Box folder to link with the Microsoft Teams channel/team. Files shared in the mapped Teams location will be stored in this Box folder.
object
required
The Microsoft Teams channel or team information to create a mapping for. Requires the channel/team ID, team ID, and tenant ID from your Microsoft 365 environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_TERMS_OF_SERVICECreates enterprise terms of service for managed users or external collaborators, with a status and text. The action declares both manage_enterprise_properties and manage_users scopes.

Input Parameters

string
required
The terms of service text to display to users. The text can be set to empty if the status is set to disabled.
string ("disabled" | "enabled")
required
Whether this terms of service is active. Use ‘enabled’ to activate or ‘disabled’ to deactivate.
string ("external" | "managed")
required
The type of user to set the terms of service for. Use ‘managed’ for the enterprise’s own users, or ‘external’ for users from other enterprises that collaborate on the enterprise’s data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_TERMS_OF_SERVICE_STATUS_FOR_NEW_USERCreates a terms of service status record for a user who has not previously accepted or rejected the terms. This action records whether a user has accepted or rejected a specific terms of service. Use this for users who are encountering the terms of service for the first time. For users who have previously accepted or rejected terms, use update_terms_of_service_status_for_existing_user instead. Prerequisites: - The Terms of Service feature must be enabled for the enterprise in the Box Admin Console - A terms of service must exist (created via create_terms_of_service) - The user must not already have a status record for this terms of service Note: If a status already exists for the user and terms of service combination, the API will return an error.

Input Parameters

string
required
The unique identifier (ID) of the terms of service to set the user’s status for. Obtain this ID from the list_terms_of_services action.
string
required
The unique identifier (ID) of the user to set the terms of service status for. Obtain this ID from list_enterprise_users or get_current_user actions.
string ("terms_of_service")
The type of the terms of service object. Must be ‘terms_of_service’.
string ("user")
The type of the user object. Must be ‘user’.
boolean
required
Whether the user has accepted the terms of service. Set to true if the user has accepted, false if they have rejected or not yet accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_UPLOAD_SESSIONCreates an upload session for chunked upload of large files (20MB+). This is the first step in Box’s chunked upload process. After creating the session, you must: (1) upload file chunks using the upload_part endpoint, (2) commit the session using the commit endpoint to finalize the file. The session expires after 7 days. Use this for files 20MB or larger. For smaller files, use the regular upload endpoint instead.

Input Parameters

string
required
The name for the new file including extension. Must not contain forward or backward slashes, non-printable ASCII characters, or trailing spaces. Cannot be ’.’ or ’..’. Example: ‘large_video.mp4’ or ‘presentation.pptx’
integer
required
The total size of the file in bytes. Must be at least 20MB (20971520 bytes) since chunked uploads are only for large files. Maximum depends on account storage limits. Example: 104857600 (100MB)
string
required
The ID of the folder where the file will be uploaded. Use ‘0’ for the root folder (All Files), or provide a specific folder ID. Example: ‘123456789’ or ‘0’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_UPLOAD_SESSION_FOR_EXISTING_FILECreates an upload session for uploading a new version of an existing file using chunked upload. Use this for files larger than 20MB. The session provides endpoints for uploading file parts, committing the upload, and checking status. Returns session info including part_size, total_parts, and session_endpoints for managing the chunked upload process.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
The optional new name for the uploaded file version. If not provided, the original file name is retained.
integer
required
The total number of bytes of the file to be uploaded. Must be at least 20000000 bytes (20 MB) for chunked upload sessions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_USERCreates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Input Parameters

string
required
The name of the user
string ("coadmin" | "user")
The user’s enterprise role
string
The email address the user uses to log in. Required for standard users, but optional when is_platform_access_only is set to true.
string
The user’s phone number
array
List of attributes to include in the response (e.g., [‘id’, ‘name’, ‘login’, ‘role’]). This can be used to request fields that are not normally returned in a standard response. Note: Specifying this parameter will return only the mini representation fields plus the explicitly requested fields, not the standard full response.
string ("active" | "cannot_delete_edit" | "cannot_delete_edit_upload" | "inactive")
The user’s account status (active, inactive, cannot_delete_edit, or cannot_delete_edit_upload)
string
The user’s address
string
The language of the user, formatted in modified version of the ISO 639-1 format.
string
The user’s timezone (e.g., ‘America/Los_Angeles’, ‘America/New_York’)
string
The user’s job title
integer
The user’s total available space in bytes. Set this to -1 to indicate unlimited storage.
array
Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
boolean
Whether the user can use Box Sync
string
An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.
boolean
Whether the user can see other enterprise users in their contact list
boolean
Specifies that the user is an app user.
boolean
Whether to exempt the user from enterprise device limits
boolean
Whether the user is allowed to collaborate with users outside their enterprise
boolean
Whether the user must use two-factor authentication

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_USER_INVITEInvites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application. This method requires the “Manage An Enterprise” scope enabled for the application, which can be enabled within the developer console.

Input Parameters

array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier (ID) of the enterprise to invite the user to. You can obtain this ID by querying the current user’s profile with the ‘enterprise’ field requested (e.g., GET /users/me?fields=enterprise).
string
required
The email address (login) of the external user to invite. The user must already have an existing Box account and cannot be part of another enterprise. Example: ‘john@example.com’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_WEBHOOKCreates a webhook to monitor a file or folder for specific events. Webhooks allow you to receive notifications at a specified URL when events occur on Box content. When an event triggers, Box sends an HTTP POST request to your specified address with details about the event. Requirements: - The notification URL must use HTTPS on port 443 - The URL must respond with HTTP 200-299 within 30 seconds - Requires ‘Manage Webhooks’ scope enabled for the application Note: Folder webhooks cascade to sub-folders automatically.

Input Parameters

string
required
The HTTPS URL that will receive webhook notifications. Must use port 443 and return HTTP 200-299 within 30 seconds.
array
required
List of event triggers that will fire the webhook (e.g., FILE.UPLOADED, FOLDER.CREATED). See TriggersEnm0 for all options.
string
required
The ID of the file or folder to monitor for events. Required.
string ("file" | "folder")
required
The type of item to monitor: ‘file’ or ‘folder’. Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_CREATE_ZIP_DOWNLOADCreates a request to download multiple files and folders as a single zip archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a download_url and a status_url that can be used to download the archive. The limit for an archive is either the Account’s upload limit or 10,000 files, whichever is met first. Note: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.

Input Parameters

array
required
A list of items to add to the zip archive. These can be folders or files.
string
The optional name of the zip archive. This name will be appended by the .zip file extension, for example January Financials.zip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_AI_AGENTPermanently deletes a custom AI agent from Box AI Studio. This action removes the specified AI agent and all its configuration, including any custom instructions and capability settings. This operation cannot be undone. Note: This action requires the ‘Manage AI’ scope to be enabled for the Box application. The authenticated user must have appropriate permissions to delete AI agents. Common error responses: - 403 Forbidden: Insufficient permissions or ‘Manage AI’ scope not enabled - 404 Not Found: The specified agent_id does not exist

Input Parameters

string
required
The unique identifier of the AI agent to delete. This ID is returned when creating an AI agent or can be retrieved by listing AI agents. Example: ‘1234567890’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_ALLOWED_COLLABORATION_DOMAINRemoves a domain from the list of allowed collaboration domains (whitelist) within your enterprise. This action deletes a specific collaboration whitelist entry, preventing users from that domain from collaborating on your enterprise’s content (or vice versa, depending on the original direction). Requirements: - Enterprise admin privileges - The ‘manage_enterprise_properties’ scope - External collaboration allowlisting must be enabled for your enterprise (part of the Governance package) Usage: Provide the collaboration_whitelist_entry_id of the domain entry you want to remove. You can obtain this ID from the ‘Add domain’ or ‘List allowed collaboration domains’ actions. Response: Returns 204 No Content on successful deletion. This operation is idempotent - deleting an already deleted entry will still return success.

Input Parameters

string
required
The unique identifier (ID) of the collaboration whitelist entry to remove. This ID can be obtained from the ‘Add domain to list of allowed collaboration domains’ or ‘List allowed collaboration domains’ actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_BARRIER_RESTRICTIONDeletes a shield information barrier segment restriction by its unique ID. Shield information barrier segment restrictions define which segments cannot communicate with each other. When a restriction is deleted, users in the previously restricted segments will be able to collaborate again. Important Notes: - This operation is destructive and cannot be undone - Returns HTTP 204 (No Content) with empty response body on success - Requires Box Shield add-on with information barriers enabled - Idempotent: Deleting a non-existent restriction returns 404 (not an error state) - Requires admin privileges Prerequisites: - Box Shield add-on enabled (returns 404 if not available) - Valid segment restriction ID from create or list operations

Input Parameters

string
required
The unique identifier of the shield information barrier segment restriction to delete. Obtain this ID from BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION or BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONS actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_BOX_SKILL_CARDS_FROM_FILERemoves any Box Skills cards metadata from a file.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_COLLABORATIONRemoves a collaboration from a file or folder, revoking the collaborator’s access. A collaboration in Box represents shared access granted to a user or group on a file or folder. Removing a collaboration will: - Revoke the collaborator’s access to the item immediately - Remove the item from the collaborator’s “Shared with Me” view - Cancel any pending invitations if the collaboration was not yet accepted This action is permanent and cannot be undone. To restore access, you would need to create a new collaboration. Returns HTTP 204 (No Content) on successful deletion.

Input Parameters

string
required
The unique identifier of the collaboration to remove. A collaboration represents shared access granted to a user or group on a file or folder. You can obtain collaboration IDs by listing collaborations on a folder (using list_folder_collaborations) or file (using list_file_collaborations), or from the response when creating a collaboration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_COMMENTPermanently deletes a comment from a file or folder in Box. This action removes a comment that was previously added to a Box item. Once deleted, the comment cannot be recovered. The operation returns HTTP 204 (No Content) on success. If the comment does not exist or has already been deleted, a 404 error is returned. Note: Only the user who created the comment or an admin can delete it.

Input Parameters

string
required
The unique identifier of the comment to delete. This can be obtained from the response when creating a comment (BOX_CREATE_COMMENT) or by listing comments on a file (BOX_LIST_FILE_COMMENTS). Example: ‘695212827’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_DEVICE_PINDeletes an individual device pin from the enterprise. Device pins are created when users access Box from mobile or desktop devices that support device pinning. Removing a device pin will require the user to re-authenticate on that device. This endpoint requires admin privileges and the ‘manage_enterprise_properties’ scope. On successful deletion, returns HTTP 204 No Content.

Input Parameters

string
required
The unique identifier of the device pin to remove. Device pin IDs can be obtained from the ‘List enterprise device pins’ endpoint. Example: ‘2324234’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_EMAIL_ALIASRemoves an email alias from a user. This endpoint permanently deletes an email alias associated with a user account. Note: You cannot remove a user’s primary email address. To change the primary email, you must first create a new alias, set it as primary, then remove the old one. Returns HTTP 204 (No Content) on success with an empty response body. Returns HTTP 404 if the user or email alias is not found.

Input Parameters

string
required
The ID of the user whose email alias will be removed. Can be obtained from BOX_GET_CURRENT_USER or BOX_LIST_ENTERPRISE_USERS.
string
required
The ID of the email alias to remove. Can be obtained from BOX_LIST_USER_S_EMAIL_ALIASES or BOX_CREATE_EMAIL_ALIAS response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_FILEDeletes a file from Box by moving it to trash or permanently (based on enterprise settings). Use the if_match parameter with the file’s ETag for safe concurrent operations. To permanently delete a trashed file, use the ‘Permanently remove file’ action instead.

Input Parameters

string
required
The unique identifier of the file to delete. You can find the file ID by viewing the file in Box web app and copying from the URL (e.g., for https://*.app.box.com/files/123 the file_id is 123).
string
Optional ETag value for optimistic concurrency control. Pass the file’s last observed etag value to ensure the file hasn’t been modified since you last retrieved it. If the file has changed, the request fails with HTTP 412 Precondition Failed. You can get the etag from the file’s metadata or from a previous API response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_FILE_PERMANENTLYPermanently deletes a file from the trash. This action is irreversible and cannot be undone. The file must already be in the trash before it can be permanently removed. To move a file to trash first, use the ‘Delete file’ action.

Input Parameters

string
required
The unique identifier of the trashed file to permanently delete. The file must already be in the trash (deleted via ‘Delete file’ action). You can find the file ID by listing trashed items or from the Box web app URL (e.g., for https://*.app.box.com/files/123 the file_id is 123).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_FILE_REQUESTDeletes a file request permanently. File requests allow external users to upload files to a specific folder without needing a Box account. This action permanently deletes a file request. IMPORTANT LIMITATION: File request IDs cannot be discovered via API - they can only be obtained from the Box web application. To find a file_request_id: 1. Navigate to Box web UI (https://app.box.com) 2. Go to the folder containing the file request 3. Open the file request settings 4. Copy the ID from the URL (e.g., https://*.app.box.com/filerequest/123 → ID is “123”) Response: Returns HTTP 204 No Content on success (empty response body). Common Use Cases: - Removing file requests that are no longer needed - Cleaning up expired or inactive file requests - Managing file request lifecycle programmatically Note: This operation is permanent and cannot be undone. The file request will be deleted immediately, but any files that were already uploaded through the file request will remain in the destination folder.

Input Parameters

string
required
The unique identifier of the file request to delete. IMPORTANT: File request IDs can ONLY be obtained from the Box web application URL - there is no API to list file requests. To find a file_request_id: 1. Navigate to Box web UI (https://app.box.com) 2. Go to the folder containing the file request 3. Open the file request settings 4. Copy the ID from the URL (e.g., https://*.app.box.com/filerequest/123 → ID is ‘123’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_FILE_VERSIONMove a file version to the trash. Versions are only tracked for Box users with premium accounts.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
required
The unique identifier of the file version to remove. Version IDs can be obtained by using the ‘List all file versions’ action with the file_id. Note: The current file version cannot be deleted - only previous versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_FOLDERDeletes a folder, either permanently or by moving it to the trash. It can recursively delete a non-empty folder and all its contents.

Input Parameters

string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
boolean
Delete a folder that is not empty by recursively deleting the folder and all of its content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_FOLDER_LOCKDeletes a folder lock on a given folder, removing restrictions on move and delete operations. You must be authenticated as the owner or co-owner of the folder to use this endpoint. This action removes a lock that was previously applied to prevent a folder from being moved or deleted. Once the lock is removed, the folder can be moved, transferred to another owner, or deleted normally.

Input Parameters

string
required
The unique identifier of the folder lock to delete. You can obtain this ID by calling the ‘list_folder_locks’ action with a folder_id, or from the response when creating a folder lock.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_FOLDER_PERMANENTLYPermanently deletes a folder that is in the trash. This action cannot be undone.

Input Parameters

string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_GROUPPermanently deletes a group. Only users with admin-level permissions will be able to use this API.

Input Parameters

string
required
The unique identifier of the group to delete. This is a numeric ID string (e.g., ‘57645’) that can be obtained from BOX_LIST_GROUPS_FOR_ENTERPRISE or BOX_CREATE_GROUP responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_METADATA_CASCADE_POLICYPermanently deletes a metadata cascade policy from a folder. When deleted, existing metadata on files/subfolders remains, but new items will no longer automatically inherit the template. Prerequisites: Requires ‘manage_managed_metadata’ scope and admin permissions. Returns: HTTP 204 No Content on success (empty response body). Operation is idempotent. Error codes: - 400: Invalid policy ID format - 404: Policy not found or folder inaccessible - 403: Insufficient permissions Related: BOX_CREATE_METADATA_CASCADE_POLICY, BOX_LIST_METADATA_CASCADE_POLICIES

Input Parameters

string
required
The unique identifier of the metadata cascade policy to delete. This ID can be obtained from the response of BOX_CREATE_METADATA_CASCADE_POLICY or BOX_LIST_METADATA_CASCADE_POLICIES actions. Example format: ‘MzYzNTE5MTQzNDQwI2UxMzUxMDA3MzA0I3Rlc3RDYXNjYWRlUG9saWN5VGVtcGxhdGUtMzYxZWFmOTYtYmJlMy00YjhlLWEwNTctMmY2NjM5MTU1Yjlj’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_METADATA_INSTANCE_FROM_FILERemoves a metadata instance from a file. Deletes all metadata associated with a specific template from a file. This operation cannot be undone. The metadata template itself is not deleted, only the instance of metadata applied to this specific file. Returns a 204 No Content response on success. Returns 404 if the metadata instance doesn’t exist on the file or if the file is not found.

Input Parameters

string ("enterprise" | "global")
required
The scope of the metadata template. Use ‘global’ for Box-provided templates available to all enterprises, or ‘enterprise’ for templates created within your enterprise.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
required
The key (identifier) of the metadata template to remove from the file. For example, ‘properties’ for the standard Box properties template, or a custom template key for enterprise templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_METADATA_INSTANCE_FROM_FOLDERRemove a metadata instance from a folder. Deletes a specific metadata template instance that has been applied to a folder. This operation is idempotent and will return a 404 error if the metadata instance doesn’t exist. Returns HTTP 204 No Content on successful deletion. Note: This only removes the metadata instance, not the folder itself. To remove a folder, use the delete folder action instead.

Input Parameters

string
required
The scope of the metadata template. Must be one of: ‘global’ (for Box’s built-in templates like ‘properties’), ‘enterprise’ (for company-wide templates), or ‘enterprise_{id}’ format (e.g., ‘enterprise_1351007304’). You can obtain the scope by listing metadata instances on the folder first.
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string
required
The key/name of the metadata template to remove (e.g., ‘properties’, ‘marketingCollateral’). This identifies which metadata instance to delete from the folder. You can obtain the template key by listing metadata instances on the folder first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_METADATA_TAXONOMYPermanently deletes a metadata taxonomy from the enterprise. This deletion is permanent and cannot be reverted. Once deleted, the taxonomy and all associated metadata will be removed from files and folders. Use with caution.

Input Parameters

string
required
The namespace of the metadata taxonomy to delete. For enterprise taxonomies, this typically follows the format ‘enterprise_{id}’. Example: ‘enterprise_123456’.
string
required
The key of the metadata taxonomy to delete. This is the unique identifier for the taxonomy within the namespace. Example: ‘geography’ or ‘test_taxonomy_delete_12345’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_METADATA_TAXONOMY_NODEPermanently deletes a metadata taxonomy node from Box. Metadata taxonomies in Box allow you to organize and classify content using hierarchical structures. This action removes a specific node from a taxonomy. Important constraints: - Only nodes without any children can be deleted - This deletion is permanent and cannot be reverted - Requires admin or co-admin permissions - The user must have access to the metadata taxonomies feature Returns HTTP 204 No Content on successful deletion. Returns HTTP 400 Bad Request if the node has children or request is invalid. Returns HTTP 403 Forbidden if the user lacks necessary permissions. Returns HTTP 404 Not Found if the taxonomy or node does not exist.

Input Parameters

string
required
The unique identifier of the metadata taxonomy node to delete. This is a UUID that identifies the specific node within the taxonomy tree (e.g., ‘14d3d433-c77f-49c5-b146-9dea370f6e32’). Only nodes without any children can be deleted.
string
required
The namespace of the metadata taxonomy. This is typically the enterprise ID prefixed with ‘enterprise_’ (e.g., ‘enterprise_123456’). You can get this from the taxonomy configuration or by listing metadata taxonomies.
string
required
The key that identifies the metadata taxonomy. This is a unique identifier for the taxonomy within the namespace (e.g., ‘geography’, ‘departments’). You can obtain this from the taxonomy configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_METADATA_TEMPLATEPermanently delete a metadata template and all its instances from files and folders. WARNING: This operation is destructive and cannot be undone. Once deleted: - The template definition is permanently removed - All metadata instances using this template on files/folders are also deleted - Any cascade policies using this template will stop working Scope: Use ‘enterprise’ for custom templates created within your organization. Global templates (scope=‘global’) cannot be deleted. Required Permission: Requires ‘manage enterprise properties’ scope. Only enterprise admins can delete metadata templates.

Input Parameters

string
required
The scope of the metadata template. Use ‘enterprise’ for custom templates created within your enterprise, or ‘global’ for Box’s built-in templates. Note: You cannot delete global templates - only enterprise templates can be removed.
string
required
The unique identifier (key) of the metadata template to delete. This is the templateKey value that was specified or auto-generated when the template was created (e.g., ‘myCustomTemplate’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_RETENTION_POLICYPermanently deletes a modifiable retention policy from the Box enterprise; non-modifiable policies cannot be deleted. The action requires admin privileges and both manage_data_retention and enterprise_content scopes.

Input Parameters

string
required
The unique identifier (ID) of the retention policy to permanently delete. This can be obtained from the response when creating a retention policy or by listing retention policies. Example: ‘12345678’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_RETENTION_POLICY_ASSIGNMENTRemoves a retention policy assignment from a folder, enterprise, or metadata template and returns a success indicator and message. Only assignments for modifiable policies can be removed; Box Governance and admin permissions are required.

Input Parameters

string
required
The unique identifier of the retention policy assignment to remove. This ID can be obtained from the ‘List retention policy assignments’ action or from the response when assigning a retention policy. Example: ‘12345678’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENTPermanently deletes a shield information barrier segment by its ID. Shield information barriers help prevent conflicts of interest by restricting collaboration between user segments within an organization. This action removes a specific segment from the barrier configuration. Requirements: - Box Shield add-on must be enabled for the enterprise - Admin privileges are required to delete segments - The segment must not have any active restrictions referencing it Returns HTTP 204 No Content on successful deletion. Returns HTTP 404 Not Found if the segment ID does not exist.

Input Parameters

string
required
The unique identifier of the shield information barrier segment to delete. This ID is returned when creating a segment or can be retrieved by listing segments for a specific shield information barrier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_IDRemoves a user from a shield information barrier segment by deleting their membership. Shield information barriers are used to prevent conflicts of interest by restricting communication and collaboration between specific groups of users within an enterprise. This action removes a user’s membership from a specific barrier segment. Note: This feature requires Box Shield and is only available for enterprise accounts with the appropriate licensing. Returns 204 No Content on successful deletion.

Input Parameters

string
required
The unique identifier of the shield information barrier segment member to delete. This ID can be obtained from the ‘list_shield_information_barrier_segment_members’ action or from the response when creating a segment member with ‘create_shield_information_barrier_segment_member’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_SLACK_INTEGRATION_MAPPINGDeletes a Slack integration mapping that links a Box folder to a Slack channel. This endpoint removes an existing mapping between a Slack channel and a Box folder created through the Box for Slack integration. After deletion, any new files shared in the Slack channel will be stored in the default location rather than the previously mapped Box folder. Requirements: - Admin or Co-Admin role in the Box enterprise - Box for Slack must be installed in the relevant Slack workspace - Box as the Content Layer for Slack must be enabled Note: This action is irreversible. Once deleted, a new mapping must be created to restore the integration between the Slack channel and Box folder. For more information, see: https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack

Input Parameters

string
required
The unique identifier of the Slack integration mapping to delete. This ID can be obtained from the ‘list_slack_integration_mappings’ action. Example: ‘512521’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_STORAGE_POLICY_ASSIGNMENTDeletes a storage policy assignment, causing the assigned user to inherit the enterprise’s default storage policy (Box Zone). Use this action when you want to reset a user’s storage policy back to the enterprise default. This is useful when: - A user moves to a different region and should use the default zone - Cleaning up custom storage assignments - Reverting a user’s data residency settings Prerequisites: Requires Box Zones feature to be enabled for the enterprise. Rate Limit: Only twice per user in a 24-hour period. Response: Returns 204 No Content on success (empty data object).

Input Parameters

string
required
The unique ID of the storage policy assignment to delete. Get this ID from ‘list_storage_policy_assignments’ or ‘assign_storage_policy’ response. Format is typically a numeric string like ‘12345678’. Note: This requires Box Zones feature to be enabled for the enterprise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_TASKPermanently deletes a task from Box. Tasks are work assignments on files that can be assigned to collaborators for review or completion. Once deleted, the task and its assignments are permanently removed and cannot be recovered. Returns HTTP 204 (No Content) on successful deletion. Returns HTTP 404 if the task does not exist or has already been deleted. Use cases: - Remove completed tasks to clean up a file’s task list - Cancel tasks that are no longer needed - Delete tasks created in error

Input Parameters

string
required
The unique identifier (ID) of the task to permanently delete. You can get task IDs from BOX_CREATE_TASK, BOX_LIST_TASKS_ON_FILE, or BOX_GET_TASK actions. Example: ‘12345’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_TASK_ASSIGNMENTDeletes a specific task assignment, removing the task from the assigned user. This action unassigns a user from a task without deleting the task itself. The task remains on the file and can be reassigned to other users. To delete the task entirely, use the ‘remove_task’ action instead. The authenticated user must have permission to modify task assignments on the file. Typically, this means being the user who created the assignment, the assigned user themselves, or having appropriate file access permissions.

Input Parameters

string
required
The ID of the task assignment to delete. You can obtain this ID from the ‘assign_task’ action response, or by calling ‘list_task_assignments’ with a task_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_TEAMS_INTEGRATION_MAPPINGDeletes a Microsoft Teams integration mapping that links a Box folder to a Teams channel. This endpoint removes an existing mapping between a Microsoft Teams channel or team and a Box folder created through the Box for Teams integration. After deletion, any new files shared in the Teams channel will be stored in the default location rather than the previously mapped Box folder. Requirements: - Admin or Co-Admin role in the Box enterprise - Box for Teams must be installed in the relevant Microsoft Teams workspace Note: This action is irreversible. Once deleted, a new mapping must be created to restore the integration between the Teams channel and Box folder. For more information, see: https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams

Input Parameters

string
required
The unique identifier of the Teams integration mapping to delete. This ID can be obtained from the ‘list_teams_integration_mappings’ action. Example: ‘12345678’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_UPLOAD_SESSIONAbort and permanently remove a chunked upload session, discarding all uploaded data. This action is irreversible - once removed, all uploaded file parts are permanently deleted and the upload session cannot be recovered. Use this to cancel an in-progress chunked upload or clean up abandoned upload sessions. Returns HTTP 204 (No Content) on success. The upload_session_id can be obtained from the response of the ‘Create upload session’ or ‘Get upload session’ endpoints.

Input Parameters

string
required
The unique identifier of the upload session to abort and remove. This ID is returned when creating an upload session via the ‘Create upload session’ endpoint (e.g., ‘505380CEE884F26376849C43C4275690’). This operation is irreversible - all uploaded parts will be discarded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_USERPermanently deletes a user from the enterprise. By default, deletion fails if the user still owns content, was recently active, or recently joined from a free account. Use the force parameter to bypass these restrictions and delete the user along with all their content. Returns an empty response (HTTP 204) on success.

Input Parameters

boolean
Whether the user should be deleted even if they still own files, were recently active, or recently joined from a free account. When true, deletes the user and all their content.
boolean
Whether the user will receive email notification of the deletion. Defaults to true if not specified.
string
required
The unique identifier (ID) of the user to delete. Example: ‘12345’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_USER_AVATARDeletes a Box user’s custom avatar so the user displays the default Box avatar. A 404 is reported as success with no custom avatar found; this result does not distinguish a missing avatar from other causes of a 404.

Input Parameters

string
required
The unique identifier (ID) of the Box user whose custom avatar should be deleted. This can be obtained from the user object or by listing enterprise users. Example: ‘12345678901’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_USER_DOMAIN_EXEMPTIONRemoves a user’s exemption from the enterprise’s collaboration domain restrictions. After removal, the user will be subject to the allowed collaboration domain list configured for the enterprise and can no longer collaborate with users from domains outside of that list. PREREQUISITES: - The exemption must exist (obtain ID from ‘List users exempt from collaboration domain restrictions’ or when creating an exemption). - Requires enterprise admin privileges. - The enterprise must have collaboration domain restrictions enabled. COMMON ERRORS: - 204 No Content: Successful deletion (empty response body). - 403 Forbidden: Insufficient permissions or collaboration domain restrictions feature not enabled for the enterprise. - 404 Not Found: The specified exemption ID does not exist. NOTE: This is a destructive action. Once removed, the exemption cannot be recovered and the user will immediately be subject to domain restrictions.

Input Parameters

string
required
The unique identifier of the user exemption record to remove. This ID is obtained from the ‘List users exempt from collaboration domain restrictions’ or ‘Create user exemption from collaboration domain restrictions’ actions. Example: ‘984923’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_USER_FROM_GROUPDeletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Input Parameters

string
required
The unique identifier of the group membership to remove. This ID can be obtained from the BOX_ADD_USER_TO_GROUP action or by listing group members with BOX_LIST_MEMBERS_OF_GROUP.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_WATERMARK_FROM_FILERemoves the watermark from a file. This action deletes the watermark that was previously applied to the specified file. After removal, the file will no longer display watermark overlays when viewed or downloaded. Returns: - 204 No Content: Watermark successfully removed (empty response body) - 404 Not Found: File does not exist or has no watermark applied Note: This operation is idempotent. If the file doesn’t have a watermark, the API will return a 404 error.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_WATERMARK_FROM_FOLDERRemoves the watermark from a folder. This action deletes the watermark applied to a specified folder. The folder must have a watermark applied to it, otherwise the API will return a 404 error. Only users with Owner, Co-owner, or Editor permissions on the folder can remove watermarks. This feature is available for Box Enterprise plans and above.

Input Parameters

string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DELETE_WEBHOOKDeletes a webhook by ID, stopping notifications for its configured triggers; the application requires the Manage Webhooks scope. On a 204 response, the tool returns a success indicator and confirmation message.

Input Parameters

string
required
The unique identifier of the webhook to delete. This ID is returned when creating a webhook or can be found by listing all webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DOWNLOAD_FILEReturns the contents of a file in binary format.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
The file version ID to download. If not specified, the current (latest) version is downloaded. File versions can be obtained via the ‘List all file versions’ action. The version ID is the numeric identifier of the specific file version.
string
An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication. When using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_DOWNLOAD_ZIP_ARCHIVEDownloads a zip archive containing files and/or folders from Box. Prerequisites: You must first call ‘BOX_CREATE_ZIP_DOWNLOAD’ to create a zip download request. The response from that action contains a ‘download_url’ field, from which you should extract the ‘zip_download_id’. Important Notes: - The download URL is only valid for a limited time (typically a few seconds after creation, or 12 hours once the download starts). - Once a download has started, it cannot be stopped and resumed. - If the download fails or times out, create a new zip download request. Returns the zip archive in binary format as a downloadable file.

Input Parameters

string
required
The unique identifier for the zip archive to download. This ID is obtained from the ‘download_url’ field returned by the ‘BOX_CREATE_ZIP_DOWNLOAD’ action. Extract the ID from the URL path, e.g., from ‘https://dl.boxcloud.com/2.0/zip_downloads/&lt;ID&gt;/content’, use the <ID> portion.
string
The name to use for the downloaded zip file. Defaults to ‘download.zip’. If you specified a ‘download_file_name’ when creating the zip download, you can use the same name here for consistency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_EXTRACT_METADATA_FREEFORMExtract metadata from Box files using AI with freeform prompts. Use this action to extract custom metadata from files without needing a predefined metadata template. Box AI will analyze the file contents and extract information based on your prompt instructions. Features: - Freeform prompts: Specify exactly what metadata to extract using natural language - Flexible output: Response format adapts to your prompt (can be JSON, key-value pairs, etc.) - No template required: Unlike structured extraction, no metadata template setup needed Limitations: - Text documents: Up to 1MB per file - Maximum 25 files per request - Prompts: Maximum 10,000 characters Requires ‘ai.readwrite’ or ‘manage_ai’ scope in the access token.

Input Parameters

array
required
List of files to extract metadata from. Provide 1-25 files. Each item requires ‘id’ (the file ID) and ‘type’ (must be ‘file’).
string
required
The prompt instructing Box AI what metadata to extract from the file(s). Maximum 10,000 characters. Can be formatted as plain text, XML, or JSON schema. Example: ‘Extract the document title, author, creation date, and main topics.’
object
Optional AI agent configuration. Can specify which LLM model to use for extraction. Provide either a reference to an existing agent (e.g., {‘type’: ‘ai_agent_extract’, ‘id’: ‘14031’}) or custom agent configuration. If not provided, Box will use the default AI agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_EXTRACT_METADATA_STRUCTUREDExtract structured metadata from files using Box AI. Uses Large Language Models (LLMs) to extract metadata as key-value pairs from files. Requires Box AI access (ai.readwrite scope). Supports two extraction approaches: 1. Using fields: Define custom fields with ‘key’, optional ‘description’, ‘type’, ‘prompt’, and ‘options’. 2. Using metadata_template: Reference an existing Box metadata template by its template_key, type, and scope. You must use EITHER ‘fields’ OR ‘metadata_template’, but NOT both. Supports OCR for images (TIFF, PNG, JPEG) and scanned documents automatically.

Input Parameters

array
required
The files to extract metadata from. Provide 1-25 file items. Each item must have ‘id’ (Box file ID) and ‘type’ set to ‘file’.
array
Custom field definitions for extraction. Each field needs at least a ‘key’. Optional: ‘description’, ‘displayName’, ‘prompt’, ‘type’, ‘options’. Use EITHER ‘fields’ OR ‘metadata_template’ parameters, but NOT both.
string ("metadata_template")
Must be set to ‘metadata_template’ when using a metadata template. Required if metadata_template_template_key is provided.
string
The scope of the metadata template. Use ‘global’ for Box-provided templates or ‘enterprise_{enterprise_id}’ for custom enterprise templates. Required if metadata_template_template_key is provided.
string
The template_key of the metadata template to use for extraction. Required if using metadata_template approach instead of fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_FIND_METADATA_TEMPLATE_BY_INSTANCE_IDFinds a metadata template by searching for the ID of an instance of the template. This action is useful when you have a metadata instance ID (the ‘$id’ field from a metadata instance on a file or folder) and need to retrieve the full template definition including all field configurations. Common use case: After listing metadata instances on a file/folder, use this action to get the complete template schema to understand what fields are available.

Input Parameters

integer
The maximum number of metadata templates to return per page. Defaults to API default if not specified.
string
Pagination marker from a previous response’s ‘next_marker’ field. Used to retrieve the next page of results when paginating through metadata templates.
string
required
The unique UUID identifier of a metadata instance. This is the ‘$id’ field returned when listing metadata instances on a file or folder (e.g., ‘17288cf2-6342-4f6a-bce1-bed1d8209524’). Use BOX_LIST_METADATA_INSTANCES_ON_FILE or BOX_LIST_METADATA_INSTANCES_ON_FOLDER to obtain this ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_FORCE_APPLY_METADATA_CASCADE_POLICY_TO_FOLDERForces a metadata cascade policy to immediately apply the folder’s metadata template to all existing child files and subfolders. This operation is asynchronous and returns immediately with HTTP 202 Accepted. Use cases: - After creating a new cascade policy to back-fill metadata on existing content - To retroactively apply metadata changes to all items in a folder hierarchy - When you need to enforce consistent metadata across all folder contents Important notes: - The cascade operation runs asynchronously in the background after the API returns - There is currently no API to check the status of this operation - Use the conflict_resolution parameter carefully to avoid unintended data overwrites - Only works with enterprise-scoped metadata templates (not global templates) - Newly added files/folders will automatically inherit metadata via the existing cascade policy Returns: HTTP 202 Accepted with an empty response body when the cascade operation is queued successfully.

Input Parameters

string ("none" | "overwrite")
required
Specifies how to handle conflicts when a child file/folder already has a metadata instance of the same template applied: - ‘none’: Preserve existing metadata values on child items (no overwrite) - ‘overwrite’: Force-apply the folder’s metadata values, replacing existing values on children This is required to prevent accidental data loss during the cascade operation.
string
required
The ID of the metadata cascade policy to force-apply. You can obtain this ID by creating a policy with BOX_CREATE_METADATA_CASCADE_POLICY or by listing policies with BOX_LIST_METADATA_CASCADE_POLICIES. The ID is a base64-encoded string containing the folder ID, enterprise ID, and template information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GENERATE_TEXTGenerate text using Box AI based on a prompt and file context. This action sends a request to Box AI’s text generation endpoint, which uses Large Language Models (LLMs) to generate text based on your prompt and the content of a specified file. Use cases include: - Summarizing document content - Generating responses based on file content - Creating content drafts using file context - Answering questions about document content Note: Requires Box AI access (Business, Business Plus, Enterprise, or higher plans). Files up to 1MB of text content are supported.

Input Parameters

array
required
A list containing exactly ONE file item to provide context for text generation. The file’s text content (up to 1MB) will be used as context for the LLM. Each item must include ‘id’ (file ID) and ‘type’ (must be ‘file’).
string
required
The prompt or instruction for the LLM to respond to. Maximum length: 10,000 characters. Example: ‘Summarize the key points of this document’ or ‘Generate a response email based on this content’.
object
Optional configuration to specify which AI agent model to use for text generation. If not provided, the default Box AI agent will be used.
array
Optional conversation history to provide multi-turn context. Include previous prompts and their corresponding LLM answers to enable follow-up questions or continued conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_AI_AGENTRetrieves detailed information about a specific AI Agent by its unique identifier. Use Cases: - Get the current configuration and capabilities of an AI agent - Check the access state and allowed users/groups for an agent - Retrieve capability settings (ask, text_gen, extract) for an agent Requirements: - Box Enterprise Advanced account with Box AI Studio enabled - “Manage AI” scope must be enabled in the Box Developer Console Example: To get an agent with all capability details, use: agent_id=“1234567890”, fields=[“ask”, “text_gen”, “extract”]

Input Parameters

array
List of capability fields to include in the response. Specify which detailed capability configurations to return. Valid values: ‘ask’ (Q&A about documents), ‘text_gen’ (text generation), ‘extract’ (metadata extraction). Example: [‘ask’, ‘text_gen’] returns both ask and text_gen capability details. If omitted, only basic agent metadata (id, name, type, access_state, etc.) is returned without capability configs.
string
required
The unique identifier of the AI Agent to retrieve. This is a numeric string ID (e.g., ‘12345678’) obtained from creating an agent (BOX_CREATE_AI_AGENT) or listing agents (BOX_LIST_AI_AGENTS).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_AI_AGENT_DEFAULT_CONFIGURATIONRetrieve the default AI agent configuration for a specific mode. Returns the default AI agent settings used by Box AI features. The configuration includes model settings, token limits, LLM endpoint parameters, and tool configurations for text processing, image handling, and spreadsheet operations. Use this to understand or customize the AI agent behavior for ask, text generation, or metadata extraction operations.

Input Parameters

string ("ask" | "extract" | "extract_structured" | "text_gen")
required
The AI operation mode to get the default configuration for. Options: ‘ask’ (Q&A about documents), ‘text_gen’ (generate text content), ‘extract’ (freeform metadata extraction), ‘extract_structured’ (structured metadata extraction).
string
The AI model to return the default agent config for. Example models: ‘openai__gpt_3_5_turbo’, ‘openai__gpt_4o_mini’, ‘google__gemini_1_5_flash_001’. If not specified, returns config for the default model.
string
The ISO 639-1 language code to return the agent config for (e.g., ‘en’, ‘ja’, ‘fr’). If the language is not supported, the default agent config is returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_ALLOWED_COLLABORATION_DOMAINRetrieves details of a specific allowed collaboration domain entry within your enterprise. This endpoint returns information about a domain that has been whitelisted for collaboration, including the domain name, the direction of allowed collaborations (inbound, outbound, or both), and the enterprise that owns the entry. Use ‘list_allowed_collaboration_domains’ to get a list of all whitelist entry IDs, or use the ID returned when adding a new domain via ‘add_domain_to_list_of_allowed_collaboration_domains’. Note: This endpoint requires enterprise admin privileges and the ‘manage_enterprise_properties’ scope.

Input Parameters

string
required
The unique identifier of the collaboration whitelist entry to retrieve. This ID can be obtained from the response of ‘list_allowed_collaboration_domains’ or ‘add_domain_to_list_of_allowed_collaboration_domains’ actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_BOX_SIGN_REQUESTRetrieves the details of a specific Box Sign request by its unique ID. Returns comprehensive information about the signature request including: - Request status (e.g., ‘converting’, ‘created’, ‘sent’, ‘viewed’, ‘signed’, ‘declined’, ‘cancelled’, ‘expired’, ‘error_converting’, ‘error_sending’) - Signers information with their email, role, decision status, and embed URLs - Source files included in the request - Signed document copies available for download (when completed) - Signing log reference - Request timestamps and sender information Note: Requires Box Sign to be enabled for the enterprise account.

Input Parameters

string
required
The unique identifier (UUID) of the Box Sign request to retrieve. This ID can be obtained from the response when creating a sign request or by listing all sign requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_BOX_SIGN_TEMPLATERetrieves details of a specific Box Sign template by its unique ID. Returns template configuration including name, email subject/message, signers, source files, destination folder, and various lock settings that control what can be modified when creating signature requests. Note: Templates can only be created and edited via the Box web application. This API is read-only for template data. Required scope: sign_requests.readwrite

Input Parameters

string
required
The unique identifier (ID) of the Box Sign template to retrieve. You can obtain template IDs by listing all templates using the List Box Sign Templates action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_COLLABORATIONRetrieves details of a single collaboration by its ID. A collaboration represents shared access between a user/group and a file or folder in Box. This action returns information about who has access, what role they have, and which item the collaboration grants access to.

Input Parameters

array
A list of specific attributes to include in the response. Use this to request fields that are not normally returned in a standard response. When specified, only the mini representation fields plus the requested fields are returned. Example values: [‘id’, ‘role’, ‘status’, ‘accessible_by’, ‘item’, ‘created_at’, ‘expires_at’].
string
required
The unique identifier of the collaboration to retrieve. This is a numeric string ID returned when creating or listing collaborations (e.g., ‘69886391395’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_COLLECTIONRetrieves details of a specific collection by its unique identifier. Collections in Box are used to organize items (files and folders). Currently, Box only supports the ‘favorites’ collection, which contains items that the user has marked as favorites. Use ‘list_all_collections’ to discover available collection IDs. Returns the collection’s id, type, name, and collection_type.

Input Parameters

string
required
The unique identifier of the collection to retrieve. Collection IDs can be obtained from the ‘list_all_collections’ action. Note: Box currently only supports the ‘favorites’ collection type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_COMMENTRetrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

Input Parameters

array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The ID of the comment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_CURRENT_USERRetrieves information about the currently authenticated user. For OAuth 2.0 this is normally the user who authorized the app; for JWT authentication it is normally the application’s service account.

Input Parameters

array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_DEVICE_PINRetrieves information about an individual device pin in the enterprise. Device pins are created when users access Box from mobile or desktop devices that support device pinning. This endpoint returns details about a specific device pin including the device type and the user who owns it. The user must have admin privileges and the application needs the ‘manage_enterprise_properties’ scope to make this call.

Input Parameters

string
required
The unique identifier of the device pin to retrieve. Device pin IDs can be obtained from the ‘List enterprise device pins’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_EVENTS_LONG_POLL_ENDPOINTReturns a list of real-time servers that can be used for long-polling user events. Long-polling allows applications to listen for events in real-time without repeatedly polling the /events endpoint. After calling this endpoint, make a GET request to the returned url to start listening for events. When events occur, the server responds with ‘new_change’ to signal that you should fetch events from GET /events. If no events occur within retry_timeout seconds, you’ll receive ‘reconnect’ and should call this endpoint again to get a fresh URL. Note: Long-polling is only available for user events, not enterprise events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_FILE_INFORMATIONRetrieves the details about a file.

Input Parameters

string
A comma-separated list of attributes to include in the response (e.g., ‘name,size,created_at,modified_at’). This can be used to request fields that are not normally returned in a standard response. When specified, only the requested fields plus the base fields (id, type, etag) are returned. Common fields include: name, size, description, created_at, modified_at, path_collection, parent, sha1, shared_link, item_status, file_version. For metadata, use format: ‘metadata.enterprise_12345.templateKey’.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_FILE_REQUESTRetrieves detailed information about a file request in Box. File requests are forms that allow external users to upload files to a specific folder without needing a Box account. This action returns the file request’s configuration including its title, description, status, associated folder, and the shareable URL. Note: File request IDs can only be obtained from the Box web application URL (e.g., https://*.app.box.com/filerequest/123). There is no API endpoint to list all file requests.

Input Parameters

string
required
The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_FILES_UNDER_RETENTIONReturns a paginated list of files under retention for a specific retention policy assignment. This endpoint is part of Box Governance and requires: - ‘manage_retention_policies’ scope enabled for the application - Global Content Manager (GCM) permissions, which must be enabled by Box support The response includes file metadata (id, name, sha1, etag) and file version information. Results are paginated using marker-based pagination.

Input Parameters

integer
The maximum number of items to return per page. Maximum value is 1000.
string
Cursor for marker-based pagination. Use the next_marker value from a previous response to retrieve the next page of results.
string
required
The unique identifier (ID) of the retention policy assignment. Use the List retention policy assignments API to obtain valid assignment IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_FILE_THUMBNAILRetrieves a thumbnail, or smaller image representation, of a file. Sizes of 32x32,64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 160x160, and 320x320 can be returned in the .jpg format. Thumbnails can be generated for the image and video file formats listed [found on our community site][1]. [1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string ("jpg" | "png")
required
The file format for the thumbnail. ‘png’ supports sizes 32x32, 64x64, 128x128, and 256x256. ‘jpg’ supports sizes 32x32, 160x160, and 320x320.
integer
The maximum width of the thumbnail in pixels (range: 32-320). Box will return a thumbnail no wider than this.
integer
The minimum width of the thumbnail in pixels (range: 32-320). Box will return a thumbnail at least this wide.
integer
The maximum height of the thumbnail in pixels (range: 32-320). Box will return a thumbnail no taller than this.
integer
The minimum height of the thumbnail in pixels (range: 32-320). Box will return a thumbnail at least this tall.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_FILE_VERSIONRetrieve detailed information about a specific version of a file. This action returns metadata about a file version including its SHA1 hash, size, creation date, and who modified it. Versions are only tracked for Box users with premium accounts. Use BOX_LIST_ALL_FILE_VERSIONS to get a list of all available versions for a file.

Input Parameters

array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
required
The ID of the file version to retrieve. Version IDs can be obtained from the BOX_LIST_ALL_FILE_VERSIONS action or from the file_version.id field returned when uploading or updating files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_FILE_VERSIONS_UNDER_RETENTIONReturns a list of file versions under retention for a specified retention policy assignment. A retention policy assignment links a retention policy to content (enterprise, folder, or metadata template). This endpoint retrieves all file versions that are currently being retained under the specified assignment. Use cases: - Audit which file versions are being retained under a specific policy assignment - Monitor retention compliance for specific folders or metadata templates - Track file versions before their disposition date Prerequisites: - Requires a valid retention_policy_assignment_id (obtain from ‘List retention policy assignments’ endpoint) - Requires the ‘manage_data_retention’ scope enabled for the application Note: Retention policies are an enterprise feature and require Box Governance or similar Box product.

Input Parameters

integer
The maximum number of items to return per page. Maximum value is 1000.
string
Defines the position marker at which to begin returning results for pagination. Use the ‘next_marker’ value from a previous response to fetch the next page of results.
string
required
The unique identifier of the retention policy assignment. Can be obtained from the ‘List retention policy assignments’ endpoint using a retention_policy_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_FOLDERRetrieves details for a folder, including the first 100 entries in the folder. Passing sort, direction, offset, and limit parameters in query allows you to manage the list of returned folder items. To fetch more items within the folder, use the Get items in a folder endpoint.

Input Parameters

string ("date" | "id" | "name" | "size")
Defines the second attribute by which items are sorted. The folder type affects the way the items are sorted: * Standard folder: Items are always sorted by their type first, with folders listed before files, and files listed before web links. * Root folder: This parameter is not supported for marker-based pagination on the root folder (the folder with an id of 0). * Shared folder with parent path to the associated folder visible to the collaborator: Items are always sorted by their type first, with folders listed before files, and files listed before web links.
integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the metadata field as well as the scope and key of the template to retrieve, for example ?fields=metadata.enterprise_12345.contractTemplate.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string ("ASC" | "DESC")
The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_GROUPRetrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

Input Parameters

string
A comma-separated list of attributes to include in the response. Available fields: id, type, name, group_type, created_at, modified_at, provenance, external_sync_identifier, description, invitability_level, member_viewability_level, permissions. Example: ‘name,description,created_at’. Note: When specified, only the requested fields plus base fields (type, id) are returned.
string
required
The unique identifier (ID) of the group to retrieve. Example: ‘12345678’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_GROUP_MEMBERSHIPRetrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Input Parameters

array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The ID of the group membership.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_METADATA_CASCADE_POLICYRetrieve a specific metadata cascade policy assigned to a folder.

Input Parameters

string
required
The ID of the metadata cascade policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_METADATA_INSTANCE_ON_FILERetrieves a specific metadata template instance that has been applied to a file. This action returns the metadata key-value pairs for a particular template on a file. Use BOX_LIST_METADATA_INSTANCES_ON_FILE first to discover which templates are applied to a file if you don’t know the scope and template_key. Common error codes: - 404 (instance_not_found): The metadata template has not been applied to this file. - 404 (not_found): The file was not found or the user does not have access. - 403 (forbidden): The user does not have permission to view this metadata. Example usage: - Get global properties: scope=‘global’, template_key=‘properties’ - Get enterprise classification: scope=‘enterprise’, template_key=‘classification’ - Get custom template: scope=‘enterprise’, template_key=‘yourCustomTemplate’

Input Parameters

string ("enterprise" | "global")
required
The scope of the metadata template. Use ‘global’ for Box’s built-in templates (e.g., ‘properties’, ‘boxSkillsCards’) or ‘enterprise’ for custom templates created by your organization. The API automatically resolves ‘enterprise’ to your enterprise ID (e.g., ‘enterprise_12345’).
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
required
The key of the metadata template to retrieve. Common templates include ‘properties’ (global template for arbitrary key-value pairs), ‘classification’ (enterprise security classification), and custom enterprise templates. Use BOX_LIST_METADATA_INSTANCES_ON_FILE to discover which templates are applied to a file, or BOX_LIST_ALL_METADATA_TEMPLATES_FOR_ENTERPRISE to see available enterprise templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_METADATA_INSTANCE_ON_FOLDERRetrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID 0.

Input Parameters

string
required
The scope of the metadata template. Use ‘global’ for global templates or ‘enterprise’ for enterprise templates (or ‘enterprise_NNNN’ for specific enterprise ID).
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string
required
The key/name of the metadata template. For global templates, use ‘properties’. For enterprise templates, use the template key defined when the template was created. Example: ‘properties’ for global.properties template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_METADATA_TAXONOMIES_FOR_NAMESPACELists metadata taxonomies in a specified namespace. Results are returned one page at a time, with marker and limit parameters available for pagination.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
string
required
The namespace of the metadata taxonomy. This is typically in the format ‘enterprise_{enterprise_id}’ where enterprise_id is your enterprise ID number. For example, ‘enterprise_123456’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_METADATA_TAXONOMY_BY_TAXONOMY_KEYRetrieves a metadata taxonomy by its namespace and taxonomy key. Use when you need to fetch detailed information about a specific taxonomy structure.

Input Parameters

string
required
The namespace of the metadata taxonomy. This is typically in the format ‘enterprise_{enterprise_id}’ where enterprise_id is your organization’s unique identifier. For example: ‘enterprise_123456’.
string
required
The key of the metadata taxonomy. This is a unique identifier for the specific taxonomy within the namespace. For example: ‘geography’ or ‘departments’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_METADATA_TAXONOMY_NODE_BY_IDRetrieves a specific node from a metadata taxonomy by its identifier. Use when you need to get details about a particular taxonomy node including its display name, level, and ancestor information.

Input Parameters

string
required
The unique identifier of the metadata taxonomy node to retrieve. This is a UUID that identifies a specific node within the taxonomy hierarchy.
string
required
The namespace of the metadata taxonomy. This typically follows the format ‘enterprise_{enterprise_id}’ where enterprise_id is your Box enterprise ID.
string
required
The key of the metadata taxonomy. This is the unique identifier for the specific taxonomy within the namespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_METADATA_TEMPLATE_BY_IDRetrieves a metadata template by its ID.

Input Parameters

string
required
The UUID of the metadata template (e.g., ‘f7a9891f-9b0c-4b2a-bc9a-123456789012’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_METADATA_TEMPLATE_BY_NAMERetrieves a metadata template by its scope and templateKey values. To find the scope and templateKey for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

Input Parameters

string
required
The scope of the metadata template. Must be ‘enterprise’ for custom templates created by your organization, or ‘global’ for Box-provided templates.
string
required
The unique identifier (templateKey) of the metadata template. For example: ‘FormsTemplatesInfo’, ‘MalwareDeepScan’, or custom template keys for enterprise templates. You can find template keys by listing all templates for the enterprise or globally.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_RETENTION_ON_FILEReturns information about a file version retention. Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

Input Parameters

string
required
The unique identifier of the file version retention record. Note: This API is deprecated. Use the ‘get file versions under retention’ endpoint (get-retention-policy-assignments-id-file-versions-under-retention) instead for current implementations. Example: ‘3424234’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_RETENTION_POLICYRetrieves a retention policy by its unique ID. Retention policies define how long content is retained before being automatically deleted or having the retention removed. This is an enterprise-level feature that requires the ‘manage_data_retention’ OAuth scope to be enabled. Returns details including policy name, retention length, disposition action, status, and assignment counts.

Input Parameters

string
Comma-separated list of attributes to include in the response. Example: ‘id,type,policy_name,retention_length’. Available fields: id, type, policy_name, retention_length, disposition_action, description, policy_type, retention_type, status, created_by, created_at, modified_at, can_owner_extend_retention, are_owners_notified, custom_notification_recipients, assignment_counts. If specified, only these fields plus mini representation fields are returned.
string
required
The unique identifier (ID) of the retention policy to retrieve. Example: ‘982312’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_RETENTION_POLICY_ASSIGNMENTRetrieves a retention policy assignment by its unique ID. A retention policy assignment represents a link between a retention policy and its target (a folder, the enterprise, or a metadata template). This action returns details about where and how the retention policy is applied. Requires Box Governance license and scopes: manage_data_retention, enterprise_content.

Input Parameters

array
A comma-separated list of attributes to include in the response. If not specified, standard fields are returned. Available fields include: ‘id’, ‘type’, ‘retention_policy’, ‘assigned_to’, ‘filter_fields’, ‘assigned_by’, ‘assigned_at’, ‘start_date_field’. When specified, only requested fields and mini representation fields are returned.
string
required
The unique identifier (ID) of the retention policy assignment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_SHIELD_INFORMATION_BARRIER_BY_IDRetrieves a shield information barrier by its unique ID. Shield information barriers are used to separate individuals/groups within the same enterprise and prevent confidential information from passing between them. Note: This feature requires Box Shield enterprise licensing. Returns 404 if the barrier ID doesn’t exist or if Shield is not enabled for the enterprise.

Input Parameters

string
required
The unique identifier of the shield information barrier to retrieve. This ID is returned when creating or listing shield information barriers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_SHIELD_INFORMATION_BARRIER_REPORT_BY_IDRetrieves a Shield information barrier report by its ID, including its status, associated barrier, creation details, and report folder ID when available. This feature requires Box Shield.

Input Parameters

string
required
The unique identifier of the shield information barrier report to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_BY_IDRetrieves a shield information barrier segment by its unique identifier. Shield information barriers are used to prevent conflicts of interest by restricting communication between specific groups of users. Segments define groups of users within a barrier. Note: This feature requires Box Shield, which is an enterprise-level add-on. The API will return 404 if Shield is not enabled for the enterprise.

Input Parameters

string
required
The unique identifier of the shield information barrier segment to retrieve. This ID is returned when creating or listing segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_IDRetrieves a shield information barrier segment member by its unique ID. Shield Information Barriers enforce compliance by restricting collaboration between departments (e.g., Investment Banking vs Research in financial institutions). Returns details about a user’s segment assignment including when added, by whom, and which barrier/segment. Prerequisites: Box Shield license, valid member ID from create/list operations. Returns 200 on success, 404 if not found or feature disabled. Related: create_shield_information_barrier_segment_member, list_shield_information_barrier_segment_members

Input Parameters

string
required
Required. The unique identifier of the shield information barrier segment member to retrieve. Obtain this ID from create_shield_information_barrier_segment_member or list_shield_information_barrier_segment_members actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_IDRetrieves a shield information barrier segment restriction by its unique ID. Shield information barrier segment restrictions define which segments cannot communicate or collaborate with each other. This action fetches the details of a specific restriction including the requesting segment, restricted segment, and the parent barrier information. Note: This feature requires Box Shield subscription and enterprise-level access.

Input Parameters

string
required
The unique identifier of the shield information barrier segment restriction to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_STORAGE_POLICYFetches a specific storage policy by its ID. Storage policies define the geographic location where content is stored (data residency). This is an enterprise feature that requires Box Zones or similar subscription. Use this action to get details about a storage policy, including its name and the geographic region(s) it covers. To find available storage policy IDs, first use the ‘list_storage_policies’ action.

Input Parameters

string
required
The unique numeric ID of the storage policy to retrieve. Storage policy IDs can be obtained using the ‘list_storage_policies’ action. Example: ‘12345’ or ‘1434325’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_STORAGE_POLICY_ASSIGNMENTRetrieves information about a specific storage policy assignment. Storage policies control where data is physically stored (data residency). This action requires the Box Zones add-on or equivalent enterprise feature. Use ‘list_storage_policy_assignments’ to find assignment IDs for users or the enterprise.

Input Parameters

string
required
The ID of the storage policy assignment to retrieve (e.g., ‘932483’ or ‘ZW50ZXJwcmlzZV8xMjM0NTY3ODkw’). Obtain this from the ‘list_storage_policy_assignments’ action or from a previous ‘assign_storage_policy’ response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_TASKRetrieves detailed information about a specific task in Box. A task is a to-do item that can be assigned to users for a specific file. Tasks can be of type ‘review’ (approval workflow) or ‘complete’ (general task). Use this action to get task details including the associated file, assignees, due date, message, and completion status.

Input Parameters

string
required
The unique identifier of the task to retrieve. Task IDs can be obtained from BOX_LIST_TASKS_ON_FILE or BOX_CREATE_TASK responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_TASK_ASSIGNMENTRetrieves detailed information about a specific task assignment in Box. A task assignment represents a task that has been assigned to a specific user. This endpoint returns information including: - The file associated with the task - The user the task is assigned to - The user who created the assignment - The assignment status (incomplete, completed, approved, or rejected) - Timestamps for assignment, completion, and reminders

Input Parameters

string
required
The unique identifier of the task assignment to retrieve. This ID can be obtained from BOX_ASSIGN_TASK or BOX_LIST_TASK_ASSIGNMENTS actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_TERMS_OF_SERVICERetrieves a specific terms of service by its unique identifier. Returns the full terms of service object including: - Status (enabled/disabled) - Terms text content - Type (managed users or external collaborators) - Associated enterprise information - Creation and modification timestamps Note: This endpoint requires the Terms of Service feature to be enabled for the enterprise. Admin permissions may be required to access this data.

Input Parameters

string
required
The unique identifier of the terms of service to retrieve. Use ‘list_terms_of_services’ action to find available IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_TRASHED_FILERetrieves a file that has been moved to the trash. Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the GET /folders/:id/trash API. To list all items that have been moved to the trash, please use the GET /folders/trash/items API.

Input Parameters

string
A comma-separated list of specific attributes to include in the response. Common fields: ‘id’, ‘name’, ‘size’, ‘trashed_at’, ‘purged_at’, ‘created_by’, ‘modified_by’, ‘owned_by’, ‘parent’, ‘path_collection’. When specified, only the requested fields (plus mini representation fields like ‘type’, ‘id’, ‘etag’) are returned. Can be provided as a string (comma-separated) or as a list of strings.
string
required
The unique identifier of a trashed file to retrieve. The file must have been directly deleted (moved to trash), not deleted as part of a parent folder deletion. You can find the file ID from the URL in the Box web app (e.g., for https://*.app.box.com/files/123 the file_id is 123) or by listing trashed items. Returns 404 if the file is not found in the trash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_TRASHED_FOLDERRetrieves a folder that has been moved to the trash. Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the GET /folders/:id/trash API. To list all items that have been moved to the trash, please use the GET /folders/trash/items API.

Input Parameters

array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_UPLOAD_SESSIONRetrieves detailed information about an existing chunked upload session. Returns the session status including: - Total number of parts expected for the file upload - Size of each part in bytes - Number of parts already processed/uploaded - Session expiration timestamp - Available endpoints for uploading parts, committing, aborting, and checking status Use this action to monitor upload progress or retrieve session endpoints needed to continue a chunked file upload. The upload_session_id is obtained from the ‘Create upload session’ action.

Input Parameters

string
required
The unique identifier (ID) of the chunked upload session. This ID is returned by the ‘Create upload session’ action when initiating a new chunked file upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_USERRetrieves information about a user in the enterprise. The application and the authenticated user need to have the permission to look up users in the entire enterprise. This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.

Input Parameters

string
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Can be provided as a string (comma-separated) or as a list of strings.
string
required
The ID of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_USER_AVATARRetrieves the avatar image of a Box user. Returns 404 if the user has no avatar set.

Input Parameters

string
required
The unique identifier of the Box user whose avatar to retrieve (e.g., ‘12345678’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_USER_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONSRetrieves details of a specific user exemption from collaboration domain restrictions. This endpoint returns information about a user who has been granted an exemption from the enterprise’s collaboration domain allowlist, allowing them to collaborate with external parties from any domain. PREREQUISITES: - The enterprise MUST have collaboration domain restrictions enabled. - The authenticated user must have admin privileges. - The exemption ID must exist (obtained from creating an exemption or listing exempt users). COMMON ERRORS: - 403 Forbidden: Enterprise doesn’t have collaboration domain restrictions enabled, or the authenticated user lacks admin permissions. - 404 Not Found: The specified exemption ID does not exist. USE CASE: Use this to verify a specific user’s exemption status or retrieve exemption metadata after creating or discovering an exemption ID.

Input Parameters

string
required
The unique identifier of the collaboration domain exemption record. This ID is returned when creating a user exemption or when listing all exempt users. Example: ‘984923’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_USER_INVITE_STATUSReturns the status of a user invite. This endpoint retrieves detailed information about a specific invite, including: - The invited user’s details (email, name, ID) - The enterprise they were invited to - The user who created the invite - The invite status (e.g., ‘pending’, ‘accepted’) - Creation and modification timestamps Note: The invite_id must be obtained from creating an invite using the BOX_CREATE_USER_INVITE action. This endpoint requires the ‘manage_enterprise’ scope.

Input Parameters

string
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Can be provided as a string (comma-separated) or as a list of strings. Example: ‘id,type,status’ or [‘id’, ‘type’, ‘status’]
string
required
The unique identifier of the invite to retrieve. This ID is returned when creating an invite using the BOX_CREATE_USER_INVITE action. Example: ‘213723’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_WATERMARK_ON_FILERetrieve the watermark for a file. Returns the watermark information (created_at and modified_at timestamps) for a file that has a watermark applied. If the file does not have a watermark, a 404 Not Found error is returned. Prerequisites: - The file must exist in Box - A watermark must have been applied to the file using BOX_APPLY_WATERMARK_TO_FILE Use BOX_APPLY_WATERMARK_TO_FILE to apply a watermark to a file first if needed.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_WATERMARK_ON_FOLDERRetrieve the watermark for a folder.

Input Parameters

string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_WEBHOOKRetrieves detailed information about a specific webhook by its ID. Use this action to get the configuration of an existing webhook, including the target item being monitored (file or folder), the notification URL, the event triggers, and who created the webhook. Note: This action requires the ‘Manage Webhooks’ scope to be enabled for the application. The webhook must exist and be accessible to the authenticated user.

Input Parameters

string
required
The unique identifier of the webhook to retrieve. This ID is returned when creating a webhook or can be obtained from the list webhooks endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_GET_ZIP_DOWNLOAD_STATUSGet the download status of a zip archive, including progress, skipped items, and current state. Prerequisites: Call ‘BOX_CREATE_ZIP_DOWNLOAD’ first to get a zip_download_id, then initiate the download via ‘BOX_DOWNLOAD_ZIP_ARCHIVE’. The status endpoint is only accessible after the download starts and remains valid for 12 hours. Skipped files/folders indicate permission issues.

Input Parameters

string
required
The unique identifier for the zip archive. This ID is extracted from the ‘status_url’ field returned by ‘BOX_CREATE_ZIP_DOWNLOAD’. For example, from ‘https://api.box.com/2.0/zip_downloads/&#123;ID&#125;/status’, use the {ID} portion. NOTE: The status endpoint is only accessible after the download has been initiated and remains valid for 12 hours. The zip download expires quickly (typically within seconds) if not started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_AI_AGENTSLists AI agents using the supplied filters and pagination parameters. HTTP 404 responses are returned as an empty agent list.

Input Parameters

array
The mode to filter the agent config to return. Possible values are: ask, text_gen, and extract.
integer
The maximum number of items to return per page.
array
The fields to return in the response.
string
Defines the position marker at which to begin returning results.
array
The state of the agents to return. Possible values are: enabled, disabled and enabled_for_selected_users.
boolean
Whether to include the Box default agents in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ALL_CLASSIFICATIONSRetrieves the enterprise’s classification metadata template and the classifications available in it. If Box returns 404, the result is an empty classification template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ALL_COLLECTIONSRetrieves all collections for a given user. Currently, only the favorites collection is supported.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ALL_FILE_VERSIONSRetrieve a list of the past versions for a file. Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the GET /file/:id API.

Input Parameters

integer
The maximum number of items to return per page. Maximum allowed value is 1000.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ALL_GLOBAL_METADATA_TEMPLATESUsed to retrieve all generic, global metadata templates available to all enterprises using Box.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ALLOWED_COLLABORATION_DOMAINSReturns the list domains that have been deemed safe to create collaborations for within the current enterprise.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_BOX_SIGN_REQUESTSLists Box Sign requests created by the user or shared with them as a collaborator, with an optional sender filter for shared requests. Requests whose sign files or parent folder have been deleted do not appear in the list.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
array
A list of sender emails to filter the signature requests by sender. If provided, shared_requests must be set to true.
boolean
If set to true, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the user access level of the sign files of the request. Default is false. Must be set to true if senders are provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_BOX_SIGN_TEMPLATESGets Box Sign templates created by a user.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_BOX_SKILL_CARDS_ON_FILEList the Box Skills metadata cards that are attached to a file.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_COLLECTION_ITEMSRetrieves the files and/or folders contained within a Box collection. Collections in Box are used to organize content. Currently, Box supports one type of collection: ‘Favorites’, which allows users to mark files and folders for quick access. Use this action to: - List all files and folders in a user’s Favorites collection - Paginate through large collections using offset and limit parameters - Request specific fields to reduce response size Note: To get the collection_id, first use the ‘List all collections’ action (BOX_LIST_ALL_COLLECTIONS).

Input Parameters

integer
The maximum number of items to return per page. Default is 100 if not specified. The maximum allowed value is 1000.
array
A list of attribute names to include in the response (e.g., [‘name’, ‘id’, ‘created_at’, ‘modified_at’]). When specified, only the requested fields are returned along with the mini representation fields. If not specified, standard fields are returned. Available fields include: name, id, type, created_at, modified_at, description, size, path_collection, etc.
integer
The zero-based offset of the first item to return. Used for pagination. Maximum value is 10000; requests with offset > 10000 will be rejected with a 400 error. Default is 0.
string
required
The unique identifier of the collection. Use the ‘List all collections’ action (BOX_LIST_ALL_COLLECTIONS) to retrieve available collection IDs. Box currently supports one collection type: ‘Favorites’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ENTERPRISE_DEVICE_PINSLists a page of device pins within an enterprise, with marker-based pagination. The user must have admin privileges and the application needs the manage enterprise scope.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
string ("ASC" | "DESC")
The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
string
required
The ID of the enterprise

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ENTERPRISE_GROUPSRetrieves a page of groups for the enterprise, optionally filtered by name prefix. The user must have admin permissions to inspect enterprise groups.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string
Limits the results to only groups whose name starts with the search term.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ENTERPRISE_METADATA_TEMPLATESUsed to retrieve all metadata templates created to be used specifically within the user’s enterprise

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ENTERPRISE_USERSLists a page of enterprise users, including ID, name and login, optionally filtered by name or login, user type, or external app user ID. The application and authenticated user need permission to look up users across the enterprise.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
boolean
Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.
string ("all" | "external" | "managed")
Limits the results to the kind of user specified. * all returns every kind of user for whom the login or name partially matches the filter_term. It will only return an external user if the login matches the filter_term completely, and in that case it will only return that user. * managed returns all managed and app users for whom the login or name partially matches the filter_term. * external returns all external users for whom the login matches the filter_term exactly.
string
Limits the results to only users who”s name or login start with the search term. For externally managed users, the search term needs to completely match the in order to find the user, and it will only return one user at a time.
string
Limits the results to app users with the given external_app_user_id value. When creating an app user, an external_app_user_id value can be set. This value can then be used in this endpoint to find any users that match that external_app_user_id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_EVENTSReturns up to a year of past events for a given user or for the entire enterprise. By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the stream_type to admin_logs_streaming for live monitoring of new events, or admin_logs for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope manage enterprise properties checked.

Input Parameters

integer
Limits the number of events returned Note: Sometimes, the events less than the limit requested can be returned even when there may be more events remaining. This is primarily done in the case where a number of events have already been retrieved and these retrieved events are returned rather than delaying for an unknown amount of time to see if there are any more results.
array
A comma-separated list of events to filter by. This can only be used when requesting the events with a stream_type of admin_logs or adming_logs_streaming. For any other stream_type this value will be ignored.
string ("admin_logs" | "admin_logs_streaming" | "all" | "changes" | "sync")
Defines the type of events that are returned * all returns everything for a user and is the default * changes returns events that may cause file tree changes such as file updates or collaborations. * sync is similar to changes but only applies to synced folders * admin_logs returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for programmatically pulling from a 1 year history of events across all users within the enterprise and within a created_after and created_before time frame. The complete history of events will be returned in chronological order based on the event time, but latency will be much higher than admin_logs_streaming. * admin_logs_streaming returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for polling for recent events across all users within the enterprise. Latency will be much lower than admin_logs, but events will not be returned in chronological order and may contain duplicates.
string
The lower bound date and time to return events for. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored.
string
The upper bound date and time to return events for. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored.
string
The location in the event stream to start receiving events from. * now will return an empty list events and the latest stream position for initialization. * 0 or null will return all events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_FILE_APP_ITEM_ASSOCIATIONSLists a page of app items associated with a file, including associations inherited from its ancestors. This beta feature may have limited availability; users with access to the file can see app item types and IDs even without View permission on the app item.

Input Parameters

integer
The maximum number of items to return per page. Default is 10, maximum is 100.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. Use the next_marker value from a previous response to get the next page of results.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
If specified, only return app items for this application type. Example values include ‘hubs’ for Box Hubs associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_FILE_COLLABORATIONSRetrieves a page of pending and active collaborations for a file, representing users or groups granted or invited to access it.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. Use the ‘next_marker’ value from a previous response to retrieve the next page of results.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_FILE_COMMENTSRetrieves a list of comments for a file.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_FILE_VERSION_RETENTIONSRetrieves all file version retentions for the given enterprise. Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
string
Filters results by files with this ID.
string
Filters results by the retention policy with this ID.
string
Filters results by file versions with this ID.
string
Filters results by files that will have their disposition come into effect after this date.
string ("permanently_delete" | "remove_retention")
Filters results by the retention policy with this disposition action.
string
Filters results by files that will have their disposition come into effect before this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_FOLDER_APP_ITEM_ASSOCIATIONSThis is a beta feature, which means that its availability might be limited. Returns all app items the folder is associated with. This includes app items associated with ancestors of the folder. Assuming the context user has access to the folder, the type/ids are revealed even if the context user does not have View permission on the app item.

Input Parameters

integer
The maximum number of items to return per page. Maximum value is 1000.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. The value should be taken from the next_marker field returned in a previous response.
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string
If given, returns only app items for this application type. Example values include ‘hubs’ for Box Hubs associations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_FOLDER_COLLABORATIONSRetrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination to retrieve the next page of results.
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_FOLDER_LOCKSRetrieves folder lock details for a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Input Parameters

string
required
The unique identifier of the folder to list locks for. The ID for any folder can be determined by visiting the folder in the Box web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. Note: The root folder (ID 0) does not support folder locks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_GROUP_COLLABORATIONSRetrieves a page of collaborations for a group, including the files or folders the group can access and its role. The user must have admin permissions to inspect enterprise groups.

Input Parameters

integer
The maximum number of items to return per page. Default is 100, maximum is 1000.
integer
The offset of the item at which to begin the response. Use for pagination. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string
required
The unique identifier of the group. Use the ‘List groups for enterprise’ action to retrieve available group IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_GROUP_MEMBERSRetrieve a page of members for a group using offset-based pagination. Only members of the group or users with admin-level permissions can use this API.

Input Parameters

integer
The maximum number of items to return per page. Maximum value is 1000.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string
required
The ID of the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_HUBSLists a page of Box Hubs, with options to search, filter by scope, and sort results.

Input Parameters

string ("name" | "updated_at" | "last_accessed_at" | "view_count" | "relevance")
Field to sort results by
integer
The maximum number of items to return per page.
string
The query string to search for Box Hubs.
string ("editable" | "view_only" | "all")
Scope of Box Hubs to retrieve
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
string ("ASC" | "DESC")
Sort direction

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_ITEMS_IN_FOLDERRetrieves a page of items in a folder. These items can be files, folders, and web links. To request more information about the folder itself, like its size, use the Get a folder endpoint instead.

Input Parameters

string ("date" | "id" | "name" | "size")
Defines the second attribute by which items are sorted. The folder type affects the way the items are sorted: * Standard folder: Items are always sorted by their type first, with folders listed before files, and files listed before web links. * Root folder: This parameter is not supported for marker-based pagination on the root folder (the folder with an id of 0). * Shared folder with parent path to the associated folder visible to the collaborator: Items are always sorted by their type first, with folders listed before files, and files listed before web links.
integer
The maximum number of items to return per page.
string
Attributes to include in the response, as a list of strings or a comma-separated string. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the metadata field as well as the scope and key of the template to retrieve, for example ?fields=metadata.enterprise_12345.contractTemplate.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string ("ASC" | "DESC")
The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
boolean
Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_METADATA_CASCADE_POLICIESRetrieve a page of metadata cascade policies applied to a folder. This cannot be used on the root folder with ID 0.

Input Parameters

string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string
required
Specifies which folder to return policies for. This can not be used on the root folder with ID 0.
string
The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_METADATA_INSTANCES_ON_FILERetrieves all metadata instances applied to a file. Returns all metadata template instances that have been applied to the specified file, including both enterprise and global templates. The API does not support pagination and will return all metadata instances in a single response.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_METADATA_INSTANCES_ON_FOLDERRetrieves all metadata for a given folder. This can not be used on the root folder with ID 0.

Input Parameters

string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_METADATA_TAXONOMY_NODESRetrieves metadata taxonomy nodes based on the specified parameters. Use when you need to browse or search hierarchical metadata classifications in Box. Results are sorted in lexicographic order unless a query parameter is passed, in which case results are sorted by relevance.

Input Parameters

array
Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values.
integer
The maximum number of items to return per page.
string
Query text to search for the taxonomy nodes. When specified, results are sorted by relevance instead of lexicographic order.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
array
Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values.
array
Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values.
string
required
The namespace of the metadata taxonomy. Typically starts with ‘enterprise_’ followed by your enterprise ID.
string
required
The key of the metadata taxonomy. This is the unique identifier for the taxonomy template.
boolean
When set to true, provides the total number of nodes that matched the query. The response will compute counts of up to 10,000 elements. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_PENDING_COLLABORATIONSRetrieves a page of pending collaboration invites for the current user, with offset and limit pagination.

Input Parameters

integer
The maximum number of items to return per page. Maximum value is 1000.
array
A list of attributes to include in the response (e.g., [‘id’, ‘type’, ‘status’]). This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Common fields include: id, type, status, role, created_at, modified_at, expires_at, invite_email, accessible_by, item.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string ("pending")
The status of the collaborations to retrieve. Must be ‘pending’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_RECENTLY_ACCESSED_ITEMSReturns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_RETENTION_POLICIESLists retention policies for an enterprise, with optional filters. Results are paginated using a marker.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
string
Filters results by a case sensitive prefix of the name of retention policies.
string ("finite" | "indefinite")
Filters results by the type of retention policy.
string
Filters results by the ID of the user who created policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_RETENTION_POLICY_ASSIGNMENTSLists retention policy assignments for a specified policy, optionally filtered by enterprise, folder, or metadata-template assignment type. Results are paginated using a marker; the action requires the manage_retention_policies scope.

Input Parameters

string ("enterprise" | "folder" | "metadata_template")
The type of retention policy assignment to filter by.
integer
Maximum number of assignments to return per page. Maximum value is 1000.
array
A comma-separated list of additional fields to include in the response. Useful for requesting fields not returned by default. When specified, only mini representation fields plus the requested fields are returned.
string
Pagination marker from a previous response’s ‘next_marker’ field. Used to fetch the next page of results.
string
required
The unique identifier of the retention policy to list assignments for. This ID can be obtained from the list retention policies endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTSLists Shield information barrier reports for a specified barrier with marker-based pagination. Report objects can include status, creation timestamps, barrier references, and the folder ID for the report; this feature requires Box Shield.

Input Parameters

integer
The maximum number of items to return per page. Maximum value is 1000.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
string
required
The unique identifier of the shield information barrier. This ID can be obtained from the ‘List shield information barriers’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_SHIELD_INFORMATION_BARRIERSRetrieves a list of Shield information barrier objects for the authenticated user’s enterprise.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERSLists Shield information barrier segment members for a specified segment ID, with marker-based pagination.

Input Parameters

integer
The maximum number of items to return per page. Maximum value is 1000.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. Use the value from next_marker in the previous response to get the next page.
string
required
The ID of the shield information barrier segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONSLists all shield information barrier segment restrictions for a specific segment. Shield information barrier segment restrictions define which segments are prevented from collaborating with each other. This endpoint retrieves all restrictions where the specified segment is the requesting segment (the segment whose members are restricted from collaborating with other segments). Note: This feature requires Box Shield add-on and enterprise admin privileges. Returns 404 if Shield is not enabled for your enterprise or if the segment ID does not exist. Use Cases: - View all collaboration restrictions for a specific segment - Audit compliance boundaries between organizational divisions - Paginate through large sets of restrictions using marker-based pagination

Input Parameters

integer
Maximum number of restriction items to return per page. Valid range is 1-1000. If not specified, the API uses its default page size.
string
Pagination marker from a previous response’s ‘next_marker’ field. Used to retrieve the next page of results when paginating through large result sets.
string
required
The unique identifier of the shield information barrier segment to list restrictions for. Obtain this ID from the list_shield_information_barrier_segments or create_shield_information_barrier_segment actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENTSRetrieves a list of shield information barrier segment objects for the specified Information Barrier ID. Shield Information Barriers are used to separate individuals/groups within the same enterprise to prevent confidential information from passing between them. Segments define the groups of users that are separated by the barrier. Note: This is an enterprise-level feature that requires Box Shield to be enabled. Returns a 404 error if Shield Information Barriers is not available for the enterprise.

Input Parameters

integer
The maximum number of items to return per page. Maximum value is 1000.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. Use the next_marker value from a previous response to fetch the next page of results.
string
required
The ID of the shield information barrier to retrieve segments for. This is a required parameter obtained from list or create shield information barrier actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_SLACK_INTEGRATION_MAPPINGSLists Slack integration mappings in a users’ enterprise. You need Admin or Co-Admin role to use this endpoint.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
string
Box item ID, for which the mappings should be returned
string ("folder")
Box item type, for which the mappings should be returned
string
ID of the mapped item, for which the mapping should be returned
string ("channel")
Mapped item type, for which the mapping should be returned
boolean
Whether the mapping has been manually created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_STORAGE_POLICIESLists storage policies in the enterprise, returning a page of results with pagination markers.

Input Parameters

integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_STORAGE_POLICY_ASSIGNMENTSLists storage policy assignments for a specified enterprise or user, returning a page of results.

Input Parameters

string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
string
required
The ID of the user or enterprise to return assignments for
string ("enterprise" | "user")
required
The target type to return assignments for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_TASK_ASSIGNMENTSLists all of the assignments for a given task. Returns a collection of task assignment objects showing who has been assigned to complete or review a task. Each assignment includes the assigned user’s details, the assignment status, and the associated file information. This endpoint does not support pagination as tasks typically have a limited number of assignees.

Input Parameters

string
required
The unique identifier of the task to retrieve assignments for. Task IDs can be obtained from the ‘create_task’ or ‘list_tasks_on_file’ actions. Example: ‘39641675308’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_TASKS_ON_FILERetrieves a list of all the tasks for a file. This endpoint does not support pagination.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_TEAMS_INTEGRATION_MAPPINGSLists Teams integration mappings in a users’ enterprise. You need Admin or Co-Admin role to use this endpoint.

Input Parameters

string
Box item ID, for which the mappings should be returned
string ("folder")
Box item type, for which the mappings should be returned
string
ID of the mapped item, for which the mapping should be returned
string ("channel" | "team")
Mapped item type, for which the mapping should be returned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_TERMS_OF_SERVICESReturns the current terms of service text and settings for the enterprise.

Input Parameters

string ("external" | "managed")
Limits the results to the terms of service of the given type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_TERMS_OF_SERVICE_USER_STATUSESLists user acceptance statuses for a specific terms of service, optionally filtered by user. The action declares both manage enterprise properties and manage users scopes.

Input Parameters

string
required
The unique identifier of the terms of service to retrieve user statuses for. Use ‘list_terms_of_services’ action to find available terms of service IDs for your enterprise.
string
Optional. Filters results to show only the status for a specific user. If not provided, returns statuses for all users associated with the terms of service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_TRASHED_ITEMSRetrieves the files and folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the fields parameter to retrieve those specific attributes that are not returned by default. This endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the marker parameter.

Input Parameters

string ("date" | "name" | "size")
Defines the second attribute by which items are sorted. Items are always sorted by their type first, with folders listed before files, and files listed before web links. This parameter is not supported when using marker-based pagination.
integer
The maximum number of items to return per page.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string ("ASC" | "DESC")
The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
boolean
Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_UPLOAD_SESSION_PARTSList the parts (chunks) that have been uploaded to a chunked upload session. This is useful for tracking upload progress, verifying which parts have been successfully uploaded, and determining which parts still need to be uploaded. The upload_session_id is obtained from the ‘Create upload session’ action. Note: Chunked uploads are only for files larger than 20MB.

Input Parameters

integer
The maximum number of parts to return per page. Maximum allowed value is 1000. If not specified, the server default is used.
integer
The zero-based offset of the first part to return. Used for pagination. Default is 0. Note: Queries with offset exceeding 10000 will be rejected with a 400 response.
string
required
The unique identifier of the chunked upload session. This ID is returned when creating an upload session via the ‘Create upload session’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_USER_EMAIL_ALIASESRetrieves all email aliases for a user. The collection does not include the primary login for the user.

Input Parameters

string
required
The ID of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_USER_GROUPSRetrieves a page of a user’s group memberships, including the groups and roles. Only group members or users with admin-level permissions can use this API.

Input Parameters

integer
The maximum number of items to return per page.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string
required
The ID of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_USERS_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONSReturns a list of users who have been exempt from the collaboration domain restrictions. Note: This endpoint requires an enterprise account with collaboration domain restrictions enabled. A 403 Forbidden error will be returned if the feature is not available for the enterprise.

Input Parameters

integer
The maximum number of items to return per page.
string
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_WEBHOOKSReturns all defined webhooks for the requesting application. This API only returns webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.

Input Parameters

integer
Maximum number of webhooks to return per page. The Box API uses 100 as default if not specified. Must be a positive integer.
string
Pagination marker from a previous response’s ‘next_marker’ field. Use this to retrieve the next page of results when paginating through webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_LIST_WORKFLOWSLists Box Relay workflows configured for a specific folder. Use the ‘trigger_type’ parameter to filter workflows by trigger type (e.g., ‘WORKFLOW_MANUAL_START’ for workflows that can be manually started via API). Your application must be authorized to use the ‘Manage Box Relay’ application scope within the Box developer console. Returns a paginated list of workflow objects with their flows and outcomes.

Input Parameters

integer
The maximum number of workflows to return per page. If not specified, the API uses a default page size (typically 20). Maximum value varies by API.
string
Defines the position marker at which to begin returning results. Used for cursor-based pagination. Obtain this value from the ‘next_marker’ field in a previous response to fetch the next page of results.
string
required
The unique identifier of the folder to list workflows for. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string
Type of trigger to filter workflows by. Use ‘WORKFLOW_MANUAL_START’ to find workflows that can be manually triggered via the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_PREFLIGHT_CHECK_BEFORE_UPLOADPerforms a preflight check to verify that a file will be accepted by Box before uploading the entire file. This helps verify permissions, quota, and filename conflicts before starting the actual upload. A successful response (HTTP 200) indicates the upload can proceed. A 409 Conflict response indicates a file with the same name already exists.

Input Parameters

string
required
The name for the file to be uploaded. Must be unique within the target folder.
integer
The size of the file in bytes. Used to verify storage quota availability.
string
The ID of the parent folder where the file will be uploaded. Use ‘0’ for the root folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_PROMOTE_FILE_VERSIONPromote a specific version of a file. If previous versions exist, this method can be used to promote one of the older versions to the top of the version history. This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, etag, and name as the original. Other properties such as comments do not get updated to their former values. Don’t use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

Input Parameters

string
required
The ID of the file version to promote to the current version. You can get file version IDs by calling the ‘list_all_file_versions’ action with the file_id. This creates a new copy of the specified version at the top of the version history.
string ("file_version")
The type of item being promoted. Must be ‘file_version’. Defaults to ‘file_version’ if not specified.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_QUERY_FILES_FOLDERS_BY_METADATAQuery files and folders by metadata using SQL-like syntax. Returns items that have metadata instances matching the specified template and optional query conditions. Use this action when you need to find files/folders based on their metadata values rather than searching by file name or content. This is useful for locating documents based on custom attributes like status, category, department, dates, etc. Examples: - Find all files with a specific metadata template: set from_ to “enterprise_XXXXX.templateKey” - Find files in a specific folder: set ancestor_folder_id to the folder ID (use “0” for all folders) - Filter by metadata values: use query and query_params (e.g., query=“status = :val”, query_params={“val”: “approved”}) Note: Classification templates cannot be queried with this endpoint.

Input Parameters

string
required
The metadata template to query. Must be in the form ‘scope.templateKey’. For enterprise templates, use ‘enterprise_XXXXX.templateKey’ where XXXXX is your enterprise ID. For example: ‘enterprise_1351007304.contractTemplate’. Note: Box-provided classification templates cannot be used with this endpoint. Use BOX_LIST_ALL_METADATA_TEMPLATES_FOR_ENTERPRISE to find available templates.
integer
A value between 0 and 100 that indicates the maximum number of results to return for a single request. This only specifies a maximum boundary and will not guarantee the minimum number of results returned.
string
Optional SQL-like filter expression to match metadata field values. Use parameterized values with ’:’ prefix (e.g., ‘:value’) that map to query_params. Examples: ‘status = :val’, ‘amount >= :min AND amount <= :max’, ‘category LIKE :pattern’. Supported operators: =, <, >, <=, >=, <>, LIKE, NOT LIKE, ILIKE, NOT ILIKE, IS NULL, IS NOT NULL. If omitted, returns all items with the specified metadata template.
array
By default, this endpoint returns only the most basic info about the items for which the query matches. This attribute can be used to specify a list of additional attributes to return for any item, including its metadata. This attribute takes a list of item fields, metadata template identifiers, or metadata template field identifiers. For example: * created_by will add the details of the user who created the item to the response. * metadata.<scope>.<templateKey> will return the mini-representation of the metadata instance identified by the scope and templateKey. * metadata.<scope>.<templateKey>.<field> will return all the mini-representation of the metadata instance identified by the scope and templateKey plus the field specified by the field name. Multiple fields for the same scope and templateKey can be defined.
string
Pagination marker from a previous response’s ‘next_marker’ field. Use this to retrieve the next page of results when the previous response included a next_marker.
array
A list of template fields and directions to sort the metadata query results by. The ordering direction must be the same for each item in the array.
object
Key-value pairs for parameterized values used in the ‘query’ expression. Keys must match the parameter names in query (without ’:’). Example: if query=‘status = :val’, then query_params={‘val’: ‘approved’}. Value types must match the metadata template field types (string, float, date, etc.).
string
required
The folder ID to search within. Use ‘0’ to search all folders accessible to the user. Use a specific folder ID to limit results to that folder and its subfolders. Example: ‘0’ for root/all folders, or ‘12345’ for a specific folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_REFRESH_ACCESS_TOKENRefresh an Access Token using its client ID, secret, and refresh token. This endpoint exchanges a refresh token for a new access token. The refresh token must be valid (they expire after 60 days). Each time a refresh token is used, it is invalidated and a new one is returned along with the new access token. Access tokens expire after 1 hour and need to be refreshed periodically. Note: This action requires valid OAuth2 credentials (client_id, client_secret, and a valid refresh_token) that cannot be automatically generated.

Input Parameters

string
required
The client ID of the Box OAuth2 application requesting the token refresh.
string ("refresh_token")
The type of OAuth2 grant being requested. Must be ‘refresh_token’ for this endpoint.
string
required
The client secret of the Box OAuth2 application requesting the token refresh.
string
required
The refresh token to exchange for a new access token. Each refresh token can only be used once.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_REQUEST_ACCESS_TOKENRequests a Box access token using an authorization code, JWT assertion, client credentials, refresh token, or token exchange for downscoping. The returned token can be used for Box API calls within its permitted scope.

Input Parameters

string
The client-side authorization code passed to your application by Box in the browser redirect after the user has successfully granted your application permission to make API calls on their behalf. Used in combination with authorization_code as the grant_type.
string
The space-delimited list of scopes that you want apply to the new access token. The subject_token will need to have all of these scopes or the call will error with 401 Unauthorized.
string
Full URL for the file that the token should be generated for.
string
A JWT assertion for which to request a new access token. Used in combination with urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
string
The Client ID of the application requesting an access token. Used in combination with authorization_code, client_credentials, or urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
string ("authorization_code" | "client_credentials" | "refresh_token" | "urn:ietf:params:oauth:grant-type:jwt-bearer" | "urn:ietf:params:oauth:grant-type:token-exchange")
required
The type of request being made, either using a client-side obtained authorization code, a refresh token, a JWT assertion, client credentials grant or another access token for the purpose of downscoping a token.
string
The token used to create an annotator token. This is a JWT assertion. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.
string
The client secret of the application requesting an access token. Used in combination with authorization_code, client_credentials, or urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
string
A refresh token used to get a new access token with. Used in combination with refresh_token as the grant_type.
string
The token to exchange for a downscoped token. This can be a regular access token, a JWT assertion, or an app token. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.
string
Used in combination with client_credentials as the grant_type. Value is determined by box_subject_type. If user use user ID and if enterprise use enterprise ID.
Full URL of the shared link on the file or folder that the token should be generated for.
string ("urn:ietf:params:oauth:token-type:id_token")
The type of actor_token passed in. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.
string ("enterprise" | "user")
Used in combination with client_credentials as the grant_type.
string ("urn:ietf:params:oauth:token-type:access_token")
The type of subject_token passed in. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_RESEND_BOX_SIGN_REQUESTResends signature request emails to all outstanding signers. Use this when a signer did not receive the original email, the email was lost, or the signer accidentally deleted it. The email is sent asynchronously after the API call returns. Rate limit: Can only be called once every 10 minutes per sign request. Note: For automated reminders, consider setting ‘are_reminders_enabled’ to true when creating the sign request, which sends automatic reminder emails after 3, 8, 13, and 18 days. Requires Box Sign feature to be enabled and sign_requests.readwrite scope.

Input Parameters

string
required
The unique identifier (UUID) of the Box Sign request to resend. This ID can be obtained from the response when creating a sign request or by listing all sign requests using the list_box_sign_requests action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_RESTORE_FILERestores a file that has been moved to the trash. An optional new parent ID can be provided to restore the file to in case the original folder has been deleted.

Input Parameters

string
An optional new name for the file.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier of the trashed file to restore. The file must be in the trash (deleted but not yet purged). The ID can be found by listing trashed items or from the URL in the Box web app (e.g., for https://*.app.box.com/files/123 the file_id is 123). Returns 404 if the file is not found in the trash.
string
The ID of the parent folder to restore the file to. This is useful when the original folder has been deleted. Use ‘0’ for the root folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_RESTORE_FILE_VERSIONRestores a specific version of a file after it was deleted (trashed). This action restores a file version that was previously moved to the trash by setting its trashed_at field back to null. Do not use this endpoint to restore Box Notes - it only works with standard file formats such as PDF, DOC, PPTX, or similar. To restore a file version: 1. First use ‘List all file versions’ to find versions with trashed_at set 2. Then call this action with the file_id and file_version_id The restored version will have trashed_at=null and restored_at/restored_by fields populated.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
required
The ID of the file version to restore. Version IDs can be obtained by using the ‘List all file versions’ action with the file_id. Only versions that have been trashed (trashed_at is not null) can be restored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_RESTORE_FOLDERRestores a folder that has been moved to the trash. An optional new parent ID can be provided to restore the folder to in case the original folder has been deleted. During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder. For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.

Input Parameters

string
An optional new name for the folder.
string
A comma-separated list of attributes to include in the response (e.g., ‘id,name,size’). This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string
An optional ID of a folder to restore the folder to when the original folder no longer exists. This ID will only be used if the original folder no longer exists. Use this ID to provide a fallback location to restore the folder to if the original location has been deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_REVOKE_ACCESS_TOKENRevoke an active Access Token, effectively logging a user out that has been previously authenticated.

Input Parameters

string
The access token to revoke.
string
The Client ID of the application requesting to revoke the access token.
string
The client secret of the application requesting to revoke an access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_SEARCH_FOR_CONTENTSearches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Input Parameters

string ("modified_at" | "relevance")
Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified. * relevance (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurrence of the search term in the items name, description, content, and additional properties. * modified_at returns the results ordered in descending order by date at which the item was last modified.
string ("file" | "folder" | "web_link")
Limits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any of these types. * file - Limits the search results to files * folder - Limits the search results to folders * web_link - Limits the search results to web links, also known as bookmarks
integer
Defines the maximum number of items to return as part of a page of results.
string
The string to search for. REQUIRED unless ‘mdfilters’ is provided. Matched against item names, descriptions, text content, and other fields. Supports operators: "" (exact match), AND, OR, NOT (uppercase only).
string ("enterprise_content" | "user_content")
Limits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope defaults to user_content, which limits the search results to content that is available to the currently authenticated user. The enterprise_content can be requested by an admin through our support channels. Once this scope has been enabled for a user, it will allow that use to query for content across the entire enterprise and not only the content that they have access to.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
integer
The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
string ("ASC" | "DESC")
Defines the direction in which search results are ordered. This API defaults to returning items in descending (DESC) order unless this parameter is explicitly specified. When results are sorted by relevance the ordering is locked to returning items in descending order of relevance, and this parameter is ignored.
array
Metadata filters to limit search results. REQUIRED unless ‘query’ is provided. A list specifying exactly one metadata template to filter by.
array
Limits the search results to any items with a size within a given file size range. This applied to files and folders. Size ranges are defined as comma separated list of a lower and upper byte size limit (inclusive). The upper and lower bound can be omitted to create open ranges.
array
Limits the search results to any items that match the search query for a specific part of the file, for example the file description. Content types are defined as a comma separated lists of Box recognized content types. The allowed content types are as follows. * name - The name of the item, as defined by its name field. * description - The description of the item, as defined by its description field. * file_content - The actual content of the file. * comments - The content of any of the comments on a file or folder. * tags - Any tags that are applied to an item, as defined by its tags field.
string ("all_items" | "non_trashed_only" | "trashed_only")
Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in the trash (non_trashed_only). * trashed_only - Only searches for items currently in the trash * non_trashed_only - Only searches for items currently not in the trash * all_items - Searches for both trashed and non-trashed items.
array
Limits the search results to any items that are owned by the given list of owners, defined as a list of comma separated user IDs. The items still need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users an empty result set will be returned. To search across an entire enterprise, we recommend using the enterprise_content scope parameter which can be requested with our support team.
array
Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of file extensions without the dots.
array
Limits the search results to any items created within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the the start date is omitted (,2014-05-17T13:35:01-07:00) anything created before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00,) the current date will be used as the end date instead.
array
Limits the search results to any items deleted within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the the start date is omitted (2014-05-17T13:35:01-07:00), anything deleted before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00), the current date will be used as the end date instead. The trash_content parameter needs to be set to trashed_only. If searching in trash is not performed, then an empty result is returned. Data available from 2023-02-01 onwards.
array
Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs. The trash_content parameter needs to be set to trashed_only. If searching in trash is not performed, an empty result set is returned. The items need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users, an empty result set is returned. Data available from 2023-02-01 onwards.
array
Limits the search results to any items updated within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the start date is omitted (,2014-05-17T13:35:01-07:00) anything updated before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00,) the current date will be used as the end date instead.
array
Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs. Search results will also include items within any subfolders of those ancestor folders. The folders still need to be owned or shared with the currently authenticated user. If the folder is not accessible by this user, or it does not exist, a HTTP 404 error code will be returned instead. To search across an entire enterprise, we recommend using the enterprise_content scope parameter which can be requested with our support team.
array
Limits the search results to any items that have been updated by the given list of users, defined as a list of comma separated user IDs. The items still need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users an empty result set will be returned. This feature only searches back to the last 10 versions of an item.
Defines whether the search results should include any items that the user recently accessed through a shared link. When this parameter has been set to true, the format of the response of this API changes to return a list of Search Results with Shared Links

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_START_WORKFLOWStarts a Box Relay workflow with trigger type WORKFLOW_MANUAL_START. Prerequisites: - Your application must have the ‘Manage Box Relay’ scope enabled in the Box Developer Console. - Use the ‘List Workflows’ endpoint to get the workflow_id, flow.id, and folder.id. - All files specified must exist in the workflow’s configured folder. Workflow: 1. Call ‘List Workflows’ with the folder_id to get available workflows. 2. From the response, extract: workflow.id, flows[].id, and any outcome IDs if needed. 3. Call this endpoint with the extracted IDs and the file IDs to process. Returns HTTP 204 No Content on success.

Input Parameters

string ("workflow_parameters")
The type of the parameters object. Must be ‘workflow_parameters’.
array
required
Array of file objects to process with the workflow. Maximum 20 files per request. All files must be located in the workflow’s configured folder.
string
The unique identifier of the flow to trigger. Obtain this from the workflow’s ‘flows’ array in the List Workflows response.
array
Optional array of configurable outcomes for the workflow. Required if the workflow has runtime-configurable outcomes defined.
string
The type of the flow object. Must be ‘flow’.
string
The unique identifier of the folder where the workflow is configured. This must match the folder associated with the workflow.
string
required
The unique identifier of the workflow to start. Obtain this from the List Workflows endpoint.
string ("folder")
The type of the folder object. Must be ‘folder’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_TERMINATE_USER_GROUP_SESSIONSTerminates all active sessions for users belonging to the specified Box enterprise groups. This action validates the roles and permissions of each group, then creates asynchronous background jobs to terminate sessions for all users in those groups. The operation is processed asynchronously - check admin events to monitor job status. Requires admin privileges. Use this to enforce security policies or respond to security incidents affecting entire groups.

Input Parameters

array
required
A list of Box enterprise group IDs whose members’ sessions should be terminated. At least one group ID must be provided. Each group ID is a numeric string (e.g., ‘25521921228’). Use the list_groups_for_enterprise action to retrieve valid group IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_TERMINATE_USER_SESSIONSCreates asynchronous jobs to terminate active Box sessions for specified users. Use this when a user account may be compromised, a device is lost/stolen, or you need to force users to re-authenticate. This logs out users from all active sessions including web, desktop, and mobile apps. Both user_ids and user_logins parameters are required. Returns HTTP 202 on success with an async job created.

Input Parameters

array
required
A list of Box user IDs whose sessions should be terminated. Example: [‘48351505451’, ‘48351542393’]. Both user_ids and user_logins are required.
array
required
A list of user login email addresses corresponding to the user_ids. Example: [‘user@example.com’, ‘user2@example.com’]. Both user_ids and user_logins are required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_TRANSFER_OWNED_FOLDERSTransfers all files and folders owned by one user to another user’s account in Box. This creates a new folder in the destination user’s root directory containing all the source user’s content. The operation is commonly used for employee offboarding, role transitions, or account consolidation. Important: This operation is irreversible and requires enterprise admin permissions. All existing shared links and folder-level collaborations are preserved during transfer.

Input Parameters

array
List of field names to include in the response (e.g., [‘id’, ‘name’, ‘owned_by’]). When specified, only the requested fields plus mini representation fields are returned. If not specified, the standard folder object with all default fields is returned.
boolean
Determines if users should receive email notification for the action performed.
string
required
The ID of the source user whose content will be transferred. All files and folders owned by this user will be moved to the destination user’s account. Use BOX_LIST_ENTERPRISE_USERS to find valid user IDs. Requires enterprise admin permissions.
string
required
The ID of the destination user who will receive ownership of the transferred content. A new folder will be created in this user’s root directory containing all the source user’s files and folders. Use BOX_LIST_ENTERPRISE_USERS to find valid user IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_TRIM_METADATA_TAXONOMY_LEVELSDeletes the last level from a metadata taxonomy by trimming it. Use when you need to remove the deepest hierarchical level from a taxonomy structure.

Input Parameters

string
required
The namespace of the metadata taxonomy. For enterprise taxonomies, this is typically in the format ‘enterprise_123456’ where 123456 is your enterprise ID. You can find this by listing metadata templates or inspecting existing metadata instances.
string
required
The key of the metadata taxonomy to trim. This identifies the specific taxonomy whose last level will be removed. The taxonomy key is defined when the taxonomy is created and can be found by listing metadata templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_AI_AGENTUpdates an existing custom AI agent in Box AI Studio. You can modify the agent’s name, access settings, icon, and capability configurations (ask, text_gen, extract). Requirements: - Box Enterprise Advanced account with Box AI Studio enabled - “Manage AI” scope must be enabled in the Box Developer Console Usage Notes: - The type field must always be set to ‘ai_agent’ - Only custom agents (origin=‘CUSTOM’) can be updated; Box default agents cannot be modified - When updating capabilities, provide all required fields (type, access_state, description) - Use enabled_for_selected_users access_state with allowed_entities to restrict access Example: To update an agent’s name and enable the ask capability: agent_id=“1234567890”, name=“Updated Agent”, access_state=“enabled”, ask_type=“ai_agent_ask”, ask_access_state=“enabled”, ask_description=“Ask questions about documents”

Input Parameters

string
required
The display name of the AI Agent. This name will be visible to users in the Box interface.
string ("ai_agent")
The type of agent. Must be ‘ai_agent’ for all AI agents.
string
required
The unique identifier of the AI Agent to update. This is a numeric string ID returned when creating an agent or listing agents.
string ("ai_agent_ask")
Type for the ‘ask’ capability. Must be ‘ai_agent_ask’ when configuring this capability.
string
required
Controls who can access the AI Agent. Values: ‘enabled’ (all users), ‘disabled’ (no users), ‘enabled_for_selected_users’ (only users/groups in allowed_entities).
string ("ai_agent_extract")
Type for the ‘extract’ capability. Must be ‘ai_agent_extract’ when configuring this capability.
string
URL to the agent’s avatar icon. Must use format: https://cdn01.boxcdn.net/app-assets/aistudio/avatars/&lt;file_name> Valid file names (supports both .png and .svg): logo_boxAi, logo_stamp, logo_legal, logo_finance, logo_config, logo_handshake, logo_analytics, logo_classification. Example: https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg
string ("ai_agent_text_gen")
Type for the ‘text_gen’ capability. Must be ‘ai_agent_text_gen’ when configuring this capability.
array
List of users or groups allowed to access the agent (only used when access_state is ‘enabled_for_selected_users’). Each entity should have ‘type’ (‘user’ or ‘group’) and ‘id’ fields.
string
Description of the agent’s ‘ask’ capability shown to users. Explains what questions the agent can answer.
string
Whether the ‘ask’ capability is active. Values: ‘enabled’ or ‘disabled’.
string
Description of the agent’s metadata extraction capability shown to users. Explains what data the agent can extract from documents.
string
Whether the ‘extract’ capability is active. Values: ‘enabled’ or ‘disabled’.
string
Description of the agent’s text generation capability shown to users. Explains what content the agent can create.
string
Whether the ‘text_gen’ capability is active. Values: ‘enabled’ or ‘disabled’.
string
Custom system instructions for the ‘ask’ capability. Used to define the agent’s behavior, tone, and constraints when answering questions.
array
List of suggested questions displayed to users for the ‘ask’ capability (max 4 items). Example: [‘What is in this file?’, ‘Summarize the key points’].
string
Custom system instructions for metadata extraction. Used to define extraction rules, field mappings, and output formatting.
string
Custom system instructions for text generation. Used to define writing style, format preferences, and content guidelines.
array
List of suggested prompts displayed to users for text generation (max 4 items). Example: [‘Write a summary’, ‘Create a report’].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_ALL_BOX_SKILL_CARDS_ON_FILEAn alternative method to overwrite and update all Box Skill metadata cards on a file. IMPORTANT: This endpoint is designed for Box Skills applications. The skill_id parameter must be a valid Box-assigned skill invocation ID that is received in the webhook payload when Box triggers a skill on a file. This ID is NOT a user-created identifier. Use Cases: - Update skill card metadata after processing a file with a custom Box Skill - Report processing status (success, failure, in-progress) back to Box - Overwrite existing skill cards with new results from ML/AI processing For creating skill cards on files without a skill invocation ID, use: - ‘create_box_skill_cards_on_file’ to add new skill cards - ‘list_box_skill_cards_on_file’ to view existing skill cards - ‘remove_box_skill_cards_from_file’ to delete skill cards

Input Parameters

string ("invoked" | "permanent_failure" | "processing" | "success" | "transient_failure")
required
Defines the status of this skill invocation. Set to ‘success’ when applying completed skill cards. Use ‘processing’ to indicate ongoing processing, ‘invoked’ when the skill has been triggered, ‘transient_failure’ for recoverable errors, or ‘permanent_failure’ for unrecoverable errors.
string
The ID of the file to assign the skill cards to. Required when specifying file. The file ID can be found in the Box URL: https://*.app.box.com/files/{file_id}
string
required
The Box-assigned skill invocation ID. This ID is received in the webhook payload sent by Box when a skill is triggered on a file. It is NOT the same as the skill service ID or invocation ID you specify in skill cards. Example format: a numeric string like ‘33243242’.
string ("file")
The type of the item, always ‘file’. Required when specifying file.
string
The unit of usage for the skill invocation, typically ‘file’. This is usually omitted unless tracking skill usage metrics.
integer
The value of usage for the skill invocation, typically 1. This is usually omitted unless tracking skill usage metrics.
array
A list of Box Skill cards to apply to this file. These cards will overwrite any existing skill cards on the file. Each card must include: ‘type’ (always ‘skill_card’), ‘skill_card_type’ (one of: ‘keyword’, ‘transcript’, ‘timeline’, ‘status’), ‘skill’ (object with ‘type’: ‘service’ and ‘id’), ‘invocation’ (object with ‘type’: ‘skill_invocation’ and ‘id’), and ‘skill_card_title’ (object with ‘code’ and ‘message’). Additional fields depend on card type.
string
The ID of the specific file version to assign the cards to. Optional - if not provided, the cards are applied to the current file version.
string ("file_version")
The type of the file version, always ‘file_version’. Only required when targeting a specific file version instead of the current version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_BARRIER_SEGMENTUpdates a shield information barrier segment’s name and/or description. Shield Information Barrier segments represent organizational divisions (e.g., ‘Investment Banking’, ‘Research’, ‘Trading’) that need to be isolated from each other for regulatory compliance or information security purposes. Use this action to modify a segment’s identifying information after creation. At least one of ‘name’ or ‘description’ should be provided. Requirements: - Box Shield license is required to use this feature - The segment must exist (obtained from list_shield_information_barrier_segments) - Admin permissions are required to update segments Returns 404 if segment not found, 409 if name conflicts with an existing segment.

Input Parameters

string
The new name for the shield information barrier segment (e.g., ‘Investment Banking’, ‘Research Division’). Must be unique within the barrier. Cannot be empty or whitespace-only.
string
The new description for the shield information barrier segment explaining its purpose (e.g., ‘Corporate division that handles M&A advisory services’). Can be set to null to clear the existing description.
string
required
The unique identifier of the shield information barrier segment to update. Obtain this ID from list_shield_information_barrier_segments or create_shield_information_barrier_segment actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_BOX_SKILL_CARDS_ON_FILEUpdates one or more Box Skills metadata cards on a file using JSON-Patch format. This action allows you to selectively update specific skill cards by their index position without affecting other cards. Use the ‘replace’ operation to modify existing cards at specified positions (e.g., /cards/0 for the first card). NOTE: This updates existing cards in place. To view existing cards first, use ‘list_box_skill_cards_on_file’. To add new cards, use ‘create_box_skill_cards_on_file’. To remove all cards, use ‘remove_box_skill_cards_from_file’.

Input Parameters

string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
array
required
A JSON-Patch array of operations to update Box Skill cards. Each operation should have ‘op’ set to ‘replace’, ‘path’ pointing to the card index (e.g., ‘/cards/0’), and ‘value’ containing the complete updated skill card object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_COLLABORATIONUpdates a collaboration, including its role and optionally its invitation status, expiration, or path visibility. A role is required even when accepting an invitation or changing another setting.

Input Parameters

string ("co-owner" | "editor" | "owner" | "previewer" | "previewer uploader" | "uploader" | "viewer" | "viewer uploader")
required
The level of access granted.
string ("accepted" | "pending" | "rejected")
{/* alex ignore reject */} Set the status of a pending collaboration invitation, effectively accepting, or rejecting the invite.
string
Update the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the Automatically remove invited collaborators: Allow folder owners to extend the expiry date setting has been enabled in the Enterprise Settings of the Admin Console. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error. Additionally, a collaboration can only be given an expiration if it was created after the Automatically remove invited collaborator setting was enabled.
boolean
Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee”s All Files page. We recommend you limit the number of collaborations with can_view_path enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a can_view_path of true. can_view_path can only be used for folder collaborations.
string
required
The ID of the collaboration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_COMMENTUpdate the message of a comment.

Input Parameters

array
A comma-separated list of attributes to include in the response. Available fields include: id, type, is_reply_comment, message, tagged_message, created_by, created_at, modified_at, item. If not specified, a standard set of fields is returned. Specifying this parameter returns only the requested fields plus the mini representation fields.
string
The new text content for the comment. This replaces the existing message. Supports plain text and Unicode characters including emojis.
string
required
The unique identifier of the comment to update. You can obtain this ID from the ‘list_file_comments’ action or from the response when creating a comment with ‘create_comment’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_FILEUpdates a file, including renaming or moving it, changing its description or tags, and creating a lock.

Input Parameters

string
An optional different name for the file. This can be used to rename the file.
array
The tags for this item. These tags are shown in the Box web app and mobile apps next to an item. To add or remove a tag, retrieve the item”s current tags, modify them, and then update this field. There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
string
The ID of a folder to move the file to. This can be used to move a file to a different location. For example, to move a file to the root folder, set this to ‘0’. Note: When passing parameters as JSON, use ‘parent__id’ (with double underscores).
array
An array of collections to make this file a member of. Currently we only support the favorites collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array [] or null will remove the file from all collections. [1]: e://get-collections
string
The description for a file. This can be seen in the right-hand sidebar panel when viewing a file in the Box web app. Additionally, this index is used in the search index of the file, allowing users to find the file by the content in the description.
string ("lock")
Set to ‘lock’ to create a lock on the file, preventing others from modifying it. To remove a lock, use an API call with lock set to null in the raw request. The only accepted value is ‘lock’. Note: When passing parameters as JSON, use ‘lock__access’ (with double underscores).
string
The retention expiration timestamp for the given file. This date cannot be shortened once set on a file.
string
Defines the time at which the lock expires. Note: When passing parameters as JSON, use ‘lock__expires__at’ (with double underscores).
string ("company" | "open")
Defines who is allowed to download this file. The possible values are either open for everyone or company for the other members of the user”s enterprise. This setting overrides the download permissions that are normally part of the role of a collaboration. When set to company, this essentially removes the download option for external users with viewer or editor a roles. Note: When passing parameters as JSON, use ‘permissions__can__download’ (with double underscores).
boolean
Defines if the file can be downloaded while it is locked. Note: When passing parameters as JSON, use ‘lock__is__download__prevented’ (with double underscores).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_FILE_REQUESTUpdates a file request in Box. File requests allow external users to upload files to a specific folder without needing a Box account. Use this action to modify file request settings such as title, description, status, and form requirements. Common use cases: - Activate or deactivate a file request by changing its status - Update the title or description shown to uploaders - Set or change form requirements (email, description) - Set an expiration date for the file request Note: File request IDs can only be obtained from the Box web application URL. There is no API endpoint to list all file requests. To find a file_request_id, navigate to the file request in Box web UI and copy the ID from the URL (e.g., https://*.app.box.com/filerequest/123).

Input Parameters

string
The new title for the file request. This is displayed to uploaders on the file request form. If not provided, the existing title is retained.
string ("active" | "inactive")
Status of the file request.
string
The etag of the file request. Pass this to ensure the file request hasn’t changed since you last retrieved it. If the etag doesn’t match, the update will fail with a 412 Precondition Failed error.
string
The date after which the file request will no longer accept submissions (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’). After this date, the status is automatically set to ‘inactive’. If not provided, the existing expiration is retained. Set to null to remove expiration.
string
The new description for the file request. This is displayed to uploaders on the file request form. If not provided, the existing description is retained.
string
required
The unique identifier of the file request to update. This ID can be found in the Box web application URL when viewing a file request (e.g., for URL ‘https://*.app.box.com/filerequest/123’, the file_request_id is ‘123’). Note: File request IDs cannot be listed via API and must be obtained from the Box web interface.
boolean
Whether uploaders must provide their email address when submitting files. When true, an email field is shown on the file request form. If not provided, the existing setting is retained.
boolean
Whether uploaders must provide a description when submitting files. When true, a description field is shown on the file request form. If not provided, the existing setting is retained.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_FOLDERUpdates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.

Input Parameters

string
The optional new name for this folder.
array
The tags for this item. These tags are shown in the Box web app and mobile apps next to an item. To add or remove a tag, retrieve the item”s current tags, modify them, and then update this field. There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
object
Request schema for moving a folder to a new parent folder.
string
required
The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
string ("synced" | "not_synced" | "partially_synced")
Specifies whether a folder should be synced to a user”s device or not. This is used by Box Sync (discontinued) and is not used by Box Drive.
array
An array of collections to make this folder a member of. Currently we only support the favorites collection. To get the ID for a collection, use the [List all collections][1] endpoint. Passing an empty array [] or null will remove the folder from all collections. [1]: e://get-collections
string
The optional description of this folder
Request schema for creating/updating a shared link on the folder.
object
Request schema for configuring folder upload email.
boolean
Specifies if users who are not the owner of the folder can invite new collaborators to the folder.
boolean
Restricts collaborators who are not the owner of this folder from viewing other collaborations on this folder. It also restricts non-owners from inviting new collaborators. When setting this field to false, it is required to also set can_non_owners_invite_collaborators to false if it has not already been set.
boolean
Specifies if new invites to this folder are restricted to users within the enterprise. This does not affect existing collaborations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_GROUPUpdates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.

Input Parameters

string
The new name for the group. Must be unique within the enterprise.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The ID of the group.
string
Keeps track of which external source this group is coming, for example Active Directory, or Okta. Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.
string
A human readable description of the group.
string ("admins_and_members" | "admins_only" | "all_managed_users")
Specifies who can invite the group to collaborate on folders. When set to admins_only the enterprise admin, co-admins, and the group”s admin can invite the group. When set to admins_and_members all the admins listed above and group members can invite the group. When set to all_managed_users all managed users in the enterprise can invite the group.
string
An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an Active Directory Object ID or a Google Group ID. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
string ("admins_and_members" | "admins_only" | "all_managed_users")
Specifies who can see the members of the group. * admins_only - the enterprise admin, co-admins, group”s group admin * admins_and_members - all admins and group members * all_managed_users - all managed users in the enterprise

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_GROUP_MEMBERSHIPUpdates a user’s group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Input Parameters

string ("admin" | "member")
The role of the user in the group. Valid values are ‘admin’ (group administrator with configurable permissions) or ‘member’ (regular group member).
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The ID of the group membership to update. You can obtain this ID from the ‘add_user_to_group’ action response or by listing group members with ‘list_members_of_group’.
object
Custom configuration for the permissions a group admin will receive. This option has no effect on members with a role of ‘member’. Available permission keys: ‘can_create_accounts’, ‘can_edit_accounts’, ‘can_instant_login’, ‘can_run_reports’. Setting these permissions overwrites the default access levels of an admin. Omitted permissions will be enabled by default. Example: {‘can_create_accounts’: false, ‘can_run_reports’: true}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_METADATA_INSTANCE_ON_FILEUpdates a metadata instance on a file using JSON-Patch operations. The metadata template must already be applied to the file before it can be updated. Only values that match the template schema are accepted. The update is atomic - if any operation fails, no changes are applied.

Input Parameters

string
required
The scope of the metadata template. Use ‘global’ for Box-provided templates available to all enterprises, or ‘enterprise’ for templates created within your enterprise. The ‘enterprise’ value will be automatically converted to the format ‘enterprise_{enterprise_id}’ if needed.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
array
required
A JSON-Patch array of operations to apply to the metadata instance. The update is atomic - if any operation fails, no changes are applied. Operations are executed in the order provided.
string
required
The name (key) of the metadata template. For example, ‘properties’ for the standard Box properties template, or a custom template key for enterprise templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_METADATA_INSTANCE_ON_FOLDERUpdates metadata on a folder using JSON-Patch operations (RFC 6902). The metadata template must already be applied to the folder. Only values matching the template schema are accepted (except global.properties which accepts any key-value pairs). All operations are applied atomically - if any fail, no changes are made.

Input Parameters

string
required
The scope of the metadata template. Use ‘global’ for global templates (like ‘properties’) or ‘enterprise’ for enterprise-specific templates. For enterprise templates, you can use either ‘enterprise’ or the full format ‘enterprise_{enterprise_id}’.
string
required
The unique identifier that represents a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
array
required
A list of JSON-Patch operations (RFC 6902) to apply to the metadata instance. The changes are applied atomically - if any operation fails, no changes are made. Common operations: use ‘replace’ to update existing fields, ‘add’ to create or overwrite fields, ‘remove’ to delete fields.
string
required
The name of the metadata template (templateKey). For example: ‘properties’ for the global.properties template, or a custom template key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_METADATA_TAXONOMYTool to update an existing metadata taxonomy’s display name. Use when you need to rename a taxonomy while keeping its structure and key intact.

Input Parameters

string
required
The namespace of the metadata taxonomy to update. For enterprise taxonomies, this typically follows the format ‘enterprise_{id}’. Example: ‘enterprise_123456’.
string
required
The new display name for the taxonomy. This is the human-readable name shown in the Box web app.
string
required
The key of the metadata taxonomy to update. This is the unique identifier for the taxonomy within the namespace. Example: ‘geography’ or ‘test_taxonomy’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_METADATA_TAXONOMY_NODETool to update an existing metadata taxonomy node’s display name. Use when you need to rename a taxonomy node in the Box metadata taxonomy hierarchy.

Input Parameters

string
required
The identifier of the metadata taxonomy node to update.
string
required
The namespace of the metadata taxonomy (e.g., ‘enterprise_123456’).
string
required
The new display name for the taxonomy node.
string
required
The key of the metadata taxonomy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_METADATA_TEMPLATEUpdates a metadata template by applying JSON-Patch operations. The template must already exist. The update is applied atomically - if any error occurs during the application of operations, the metadata template will not be changed. Use this to modify template properties, add/edit/remove fields, or manage enum/multiSelect options.

Input Parameters

string
required
The scope of the metadata template. Use ‘global’ for global templates or ‘enterprise’ for enterprise-specific templates. For enterprise templates, you can also use the full scope format like ‘enterprise_123456’.
array
required
A list of JSON-Patch operations to apply to the metadata template. The operations are applied atomically - if any operation fails, the entire update is rolled back. Each operation must specify an ‘op’ field and may include ‘data’, ‘fieldKey’, ‘fieldKeys’, ‘enumOptionKey’, ‘enumOptionKeys’, ‘multiSelectOptionKey’, or ‘multiSelectOptionKeys’ depending on the operation type.
string
required
The name of the metadata template (templateKey). For example: ‘properties’ for the global.properties template, or a custom template key. This identifier is unique within the scope of the template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_RETENTION_POLICYUpdates an existing Box retention policy. Use this action to modify retention policy settings such as name, description, retention duration, disposition action, and notification settings. Requires Box Governance add-on and ‘manage retention policies’ scope. Note: Non-modifiable policies have limited update options (can only extend duration, add folders, retire policy, or change notification settings).

Input Parameters

string ("active" | "retired")
Status of the retention policy.
string
A text description of the retention policy. Maximum 500 characters. Set to empty string to clear the existing description.
string
The new name for the retention policy. Must be unique within the enterprise.
string ("modifiable" | "non-modifiable")
Specifies whether the policy can be modified.
string
The retention duration in days as an integer (e.g., 30, 365) or the string ‘indefinite’ for indefinite policies. Non-modifiable policies can only have their duration extended, not shortened.
string ("permanently_delete" | "remove_retention")
Action to take when the retention policy expires.
boolean
Whether to notify owners and co-owners when retention is about to expire. Notifications are sent before the retention duration ends.
string
required
The unique identifier of the retention policy to update.
boolean
Whether content owners can extend the retention period before it expires. When true, owners see an option to extend retention on their files.
array
A list of additional users to notify when retention is about to expire. Each user should be specified with their ‘id’ field. Example: [{‘id’: ‘12345678’}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_SHIELD_INFORMATION_BARRIER_STATUSChange the status of a shield information barrier. Shield information barriers are ethical walls that prevent exchanges or communication between individuals/groups within the same enterprise to avoid conflicts of interest. This action allows you to: - Set status to ‘pending’: Transition a barrier from ‘draft’ status in preparation for enablement - Set status to ‘disabled’: Deactivate an enabled or pending barrier Note: Barriers cannot be directly enabled via this endpoint. The ‘enabled’ status is set automatically by Box after all required segments and restrictions are configured on a ‘pending’ barrier.

Input Parameters

string
required
The unique identifier of the shield information barrier to update. You can get this ID from BOX_LIST_SHIELD_INFORMATION_BARRIERS or BOX_CREATE_SHIELD_INFORMATION_BARRIER.
string ("disabled" | "pending")
required
The desired status for the shield information barrier. Use ‘pending’ to prepare the barrier for enablement (transition from draft), or ‘disabled’ to deactivate an active barrier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_SLACK_INTEGRATION_MAPPINGUpdates an existing Slack integration mapping. Use this to change which Box folder is mapped to a Slack channel, or to update configuration options like automatic access management. Requires Admin or Co-Admin role and the ‘manage_enterprise_properties’ scope. At least one of ‘box_item’ or ‘options’ must be provided.

Input Parameters

object
Configuration options for the integration mapping.
object
Box folder information for the integration mapping update.
string
required
The unique identifier of the Slack integration mapping to update. Obtain this ID from the ‘list_slack_integration_mappings’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_STORAGE_POLICY_ASSIGNMENTUpdates a storage policy assignment for an enterprise or user. Storage policies control where data is stored geographically (data residency). Use this action to change which storage policy is assigned to a user or enterprise. This action requires Box Zones or similar enterprise feature to be enabled and admin-level permissions with ‘manage_enterprise_properties’ scope. Use ‘list_storage_policies’ to get available policies and ‘list_storage_policy_assignments’ to find existing assignment IDs.

Input Parameters

string
required
The unique ID of the new storage policy to assign to the user or enterprise. Get available policies using the ‘list_storage_policies’ action.
string ("storage_policy")
The type of policy to assign. Must be ‘storage_policy’. This field is fixed and agents typically don’t need to specify it.
string
required
The unique identifier of the storage policy assignment to update. Obtain this ID from the ‘list_storage_policy_assignments’ action or from a previous ‘assign_storage_policy’ response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_TASKUpdates a task’s configuration, including its action, message, due date, or completion rule.

Input Parameters

string ("complete" | "review")
The type of task action. Use ‘review’ for approval tasks that can be approved or rejected, or ‘complete’ for general tasks that can be marked as done. This parameter is optional when updating.
string
The due date and time for the task in RFC3339 format (e.g., ‘2026-12-31T23:59:59+00:00’). Note: Updating this field may have API restrictions; if you encounter errors, try updating other fields separately.
string
Optional message or instructions for the task assignee. Can be updated to provide additional context or modify existing instructions.
string
required
The ID of the task.
string ("all_assignees" | "any_assignee")
Completion rule for the task. Use ‘all_assignees’ (default) to require all assignees to complete the task, or ‘any_assignee’ to require only one assignee to complete it. Note: Updating this field may have API restrictions; if you encounter errors, try updating other fields separately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_TASK_ASSIGNMENTUpdates a task assignment to change its resolution state or add a message. This endpoint allows updating the state of a task assigned to a user. Use this to mark tasks as completed, approved, rejected, or incomplete, and optionally add a message explaining the decision. Important notes: - Only the assignee can typically update their own task assignment - For ‘complete’ action tasks: use ‘completed’ or ‘incomplete’ - For ‘review’ action tasks: use ‘approved’, ‘rejected’, or ‘incomplete’ - At least one of ‘message’ or ‘resolution_state’ should be provided

Input Parameters

string
An optional message from the assignee about the task. Use this to provide context, notes, or feedback when updating the assignment status.
string ("approved" | "completed" | "incomplete" | "rejected")
The resolution state of the task assignment. Valid values depend on the task’s action type: For ‘complete’ tasks: ‘incomplete’ or ‘completed’. For ‘review’ tasks: ‘incomplete’, ‘approved’, or ‘rejected’. Note: Only the assigned user can typically update their own task assignment.
string
required
The unique identifier of the task assignment to update. Task assignment IDs can be obtained from the ‘assign_task’ action response or by listing task assignments via ‘list_task_assignments’. Example: ‘86294599054’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_TEAMS_INTEGRATION_MAPPINGUpdates a Microsoft Teams integration mapping that links a Box folder to a Teams channel. This endpoint allows you to change which Box folder is associated with a Microsoft Teams channel through the Box for Teams integration. After updating, any new files shared in the Teams channel will be stored in the newly mapped Box folder. Requirements: - Admin or Co-Admin role in the Box enterprise - The ‘manage_enterprise_properties’ scope - Box for Teams must be installed in the relevant Microsoft Teams workspace Use Cases: - Reorganize where Teams channel files are stored in Box - Move team collaboration content to a different department folder - Update mappings after folder restructuring For more information, see: https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams

Input Parameters

object
Box folder to which the Teams channel should be mapped.
string
required
The unique identifier of the Teams integration mapping to update. This ID can be obtained from the ‘list_teams_integration_mappings’ action. Example: ‘12345678’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_TERMS_OF_SERVICEUpdates an existing terms of service for the enterprise. This action allows you to modify the status (enabled/disabled) and text content of an existing terms of service. When enabled, users will be prompted to accept the terms before accessing Box content. Note: This endpoint requires enterprise admin permissions with ‘Edit settings for your company’ enabled. The Terms of Service feature must also be enabled for the enterprise in the Box Admin Console. Use ‘list_terms_of_services’ to find the terms_of_service_id to update.

Input Parameters

string
required
The terms of service text to display to users when they are prompted to accept. Can be empty only when status is ‘disabled’.
string ("enabled" | "disabled")
required
Whether to enable or disable this terms of service. Use ‘enabled’ to activate it so users must accept it, or ‘disabled’ to deactivate.
string
required
The unique identifier of the terms of service to update. Use ‘list_terms_of_services’ action to find available IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_TERMS_OF_SERVICE_STATUS_FOR_EXISTING_USERUpdates an existing user’s terms-of-service acceptance status by status record ID. The action declares the manage_enterprise scope.

Input Parameters

boolean
required
Whether the user has accepted the terms of service. Set to true to record acceptance, false to record rejection.
string
required
The unique identifier of the terms of service user status record to update. Obtain this ID from list_terms_of_service_user_statuses action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_USERUpdates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Input Parameters

string
The name of the user
string ("coadmin" | "user")
The user’s enterprise role
string
The email address the user uses to log in Note: If the target user”s email is not confirmed, then the primary login address cannot be changed.
string
The user’s phone number
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
boolean
Whether the user should receive an email when they are rolled out of an enterprise
string ("active" | "cannot_delete_edit" | "cannot_delete_edit_upload" | "inactive")
The user”s account status
string
The user’s address
string
required
The ID of the user.
string
The language of the user, formatted in modified version of the ISO 639-1 format.
string
The user’s timezone (e.g., ‘America/Los_Angeles’, ‘America/New_York’, ‘Europe/London’)
string
The user’s job title
string
Set this to null to roll the user out of the enterprise and make them a free user
integer
The user’s total available space in bytes. Set this to -1 to indicate unlimited storage.
array
Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
boolean
Whether the user can use Box Sync
string
An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users. Note: In order to update this field, you need to request a token using the application that created the app user.
boolean
Whether the user can see other enterprise users in their contact list
boolean
Whether the user is required to reset their password
string
The email address to send the notifications to.
boolean
Whether to exempt the user from enterprise device limits
boolean
Whether the user is allowed to collaborate with users outside their enterprise
boolean
Whether the user must use two-factor authentication

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPDATE_WEBHOOKUpdates an existing webhook’s configuration. Use this action to modify a webhook’s target item (file or folder), notification URL, or event triggers. Only the fields provided in the request will be updated; omitted fields remain unchanged. Requirements: - The notification URL must use HTTPS on port 443 - The URL must respond with HTTP 200-299 within 30 seconds - Requires ‘Manage Webhooks’ scope enabled for the application Note: When changing the target, both target_id and target_type must be provided together.

Input Parameters

string
The HTTPS URL that will receive webhook notifications. Must use port 443 and return HTTP 200-299 within 30 seconds.
array
List of event triggers that will fire the webhook (e.g., FILE.UPLOADED, FOLDER.CREATED). See TriggersEnm0 enum for all available options.
string
The ID of the file or folder to monitor for events. Use this to change the target item that triggers the webhook.
string
required
The unique identifier of the webhook to update. This ID is returned when creating a webhook or can be obtained from the list webhooks endpoint.
string ("file" | "folder")
The type of item to monitor: ‘file’ or ‘folder’. Must be provided together with target_id when changing the target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPLOAD_FILEUploads a small file to Box. For file sizes over 50MB we recommend using the Chunk Upload APIs. The attributes part of the body must come before the file part. Requests that do not follow this format when uploading the file will receive a HTTP 400 error with a metadata_after_file_contents error code.

Input Parameters

object
required
The file to upload.
array
List of field names to include in the response. When specified, only the requested fields plus mini representation fields (id, type, etag) are returned. Standard fields like created_at, modified_at, owned_by, modified_by, and item_status are omitted unless explicitly included in this list. Omit this parameter to receive the full standard response with all fields.
string
The ID of the parent folder to upload the file to. Use ‘0’ for root folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPLOAD_FILE_VERSIONUpdate a file’s content. For file sizes over 50MB we recommend using the Chunk Upload APIs. The attributes part of the body must come before the file part. Requests that do not follow this format when uploading the file will receive a HTTP 400 error with a metadata_after_file_contents error code.

Input Parameters

object
required
The file to upload as a new version.
array
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
string
required
The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOX_UPLOAD_PART_OF_FILEUploads a chunk of a file for an upload session. The actual endpoint URL is returned by the Create upload session and Get upload session endpoints. Requirements: - Chunked uploads require files with a minimum size of 20MB - Each part’s size must match the part_size from the upload session (except the last part) - The offset must be a multiple of the part_size - Parts cannot overlap with previously uploaded parts

Input Parameters

object
required
The file chunk to upload.
integer
required
The byte offset of the chunk within the file. Must be a multiple of the part size from the upload session.
integer
required
The total size of the file being uploaded in bytes.
string
required
The ID of the upload session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: BOX_COLLABORATION_DETAILS_CHANGED_TRIGGERType: pollTriggers when a collaboration’s details change (e.g., role, status, expiration).This trigger monitors a specific collaboration and detects when any meaningful field changes, such as role, status, expiration date, access type, or acknowledgment status.

Configuration

string
required
The unique identifier of the collaboration to monitor for changes. This is a numeric string ID returned when creating or listing collaborations (e.g., ‘69886391395’).
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

array
List of field names that changed (e.g., ‘role’, ‘status’, ‘expires_at’)
object
required
The collaboration with updated details
object
Current values of changed fields
string
Type of event that occurred
object
Previous values of changed fields
Slug: BOX_COMMENT_CHANGED_TRIGGERType: pollTriggers when a comment’s content or details change in Box.This trigger monitors a specific Box comment and detects when any meaningful field changes, such as message text edits, tagged message changes, or modification timestamp updates.

Configuration

string
required
The unique identifier of the comment to monitor for changes. Comment IDs can be obtained from the ‘list_file_comments’ action or when creating a comment. Example: ‘12345678’.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

array
List of field names that changed (e.g., ‘message’, ‘modified_at’)
object
required
The comment with updated content
object
Current values of changed fields
string
Type of event that occurred
object
Previous values of changed fields
Slug: BOX_FILE_COMMENT_ADDED_TRIGGERType: pollTriggers when a new comment is added to a file in Box.This trigger monitors a specific Box file and fires when new comments are detected.

Configuration

string
required
The unique identifier of the file to monitor for new comments. File IDs can be obtained from file URLs or from actions like ‘list_items_in_folder’. Example: ‘2090489102308’.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of comments to check in each poll (default: 100)

Payload

object
required
The newly added comment
string
Type of event that occurred
Slug: BOX_FILE_METADATA_CHANGED_TRIGGERType: pollTriggers when a file’s metadata or properties change in Box.This trigger monitors a specific Box file and fires when changes are detected in key fields like name, description, size, modification time, parent folder, or status.

Configuration

string
required
The unique identifier of the file to monitor for metadata or property changes. File IDs can be obtained from the ‘upload_file’, ‘list_items_in_folder’, or ‘search_for_content’ actions. Example: ‘2119320206124’.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

array
List of field names that changed in this update
string
Type of event that occurred
object
required
The file with updated metadata
Slug: BOX_FILE_VERSION_UPLOADED_TRIGGERType: pollTriggers when a new file version is uploaded to a file in Box.This trigger monitors a specific Box file and fires when new versions are detected.

Configuration

string
required
The unique identifier of the file to monitor for new versions. The ID for any file can be determined by visiting this file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of versions to check in each poll (1-1000)

Payload

string
Type of event that occurred
string
required
The ID of the file this version belongs to
object
required
The newly uploaded file version
Slug: BOX_FOLDER_ITEM_ADDED_TRIGGERType: pollTriggers when a new item (file, folder, or web link) is added to a folder in Box.This trigger monitors a specific Box folder and fires when new items are detected.

Configuration

string
required
The unique identifier of the folder to monitor for new items. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of items to check in each poll (1-1000)

Payload

string
Type of event that occurred
object
required
The newly added item
Slug: BOX_FOLDER_PROPERTIES_CHANGED_TRIGGERType: pollTriggers when a folder’s core properties change in Box.This trigger monitors a specific Box folder and fires when changes are detected in properties like name, description, modification time, parent folder, item status, or shared link settings.

Configuration

string
required
The unique identifier of the folder to monitor for property changes. Folder IDs can be obtained from actions like ‘create_folder’, ‘list_items_in_folder’, or ‘search_for_content’. The root folder is always represented by ID ‘0’. Example: ‘353353898191’.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

array
List of property field names that changed.
string
Current folder description.
string
Type of event that occurred.
string
required
The unique identifier of the folder.
string
required
The current name of the folder.
string
Current item status: ‘active’, ‘trashed’, or ‘deleted’.
string
Last modification timestamp.
string
Current folder name.
object
Schema for folder mini representation.
Shared link information for the folder.
Slug: BOX_NEW_FILE_ADDED_TRIGGERType: pollTriggers when a new file is added to a folder in Box.This trigger monitors a specific Box folder and fires when new files are detected. Only files (not folders or web links) are monitored.

Configuration

string
required
The unique identifier of the folder to monitor for new files. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of items to check in each poll (1-1000)

Payload

string
Type of event that occurred
object
required
The newly added file
Slug: BOX_NEW_FOLDER_COLLABORATION_CREATED_TRIGGERType: pollTriggers when a new collaboration is created on a specific folder in Box.This trigger monitors a specific Box folder and fires when new collaborations are detected.

Configuration

string
required
The unique identifier of the folder to monitor for collaborations. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of collaborations to check in each poll (1-1000)

Payload

object
required
The newly created folder collaboration
string
Type of event that occurred
Slug: BOX_NEW_PENDING_COLLABORATION_TRIGGERType: pollTriggers when a new pending collaboration invite is created.This trigger monitors the user’s pending collaborations and fires when new pending collaboration invites are detected.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of pending collaborations to check in each poll (1-1000)

Payload

object
required
The new pending collaboration invite
string
Type of event that occurred
Slug: BOX_NEW_SIGN_REQUEST_CREATED_TRIGGERType: pollTriggers when a new Box sign request is created. This trigger monitors Box sign requests and fires when new sign requests are detected.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of sign requests to check in each poll (1-1000)

Payload

string
Type of event that occurred
object
required
The newly created Box sign request
Slug: BOX_NEW_TASK_ASSIGNMENT_TRIGGERType: pollTriggers when a new assignment is added to a task in Box.This trigger monitors a specific Box task and fires when new assignments are detected.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the task to monitor for new assignments. Task IDs can be obtained from the ‘create_task’ or ‘list_tasks_on_file’ actions. Example: ‘39641675308’.

Payload

string
Type of event that occurred
object
required
The newly added task assignment
Slug: BOX_NEW_TASK_CREATED_TRIGGERType: pollTriggers when a new task is created on a Box file.This trigger monitors a specific Box file and fires when new tasks are detected.

Configuration

string
required
The unique identifier of the file to monitor for new tasks. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

string
Type of event that occurred
object
required
The newly created task on the file
Slug: BOX_SIGN_REQUEST_STATUS_CHANGED_TRIGGERType: pollTriggers when a Box Sign request’s status or meaningful fields change.This trigger monitors a specific Box Sign request and fires when changes are detected in key fields like status, signer decisions, document readiness, or completion state.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier (UUID) of the Box Sign request to monitor for status or detail changes. This ID can be obtained from the response when creating a sign request or by listing all sign requests. Example: ‘c5c832e7-b890-4a48-96f5-27ce66d1e3b9’.

Payload

array
List of field names that changed in this update
string
Type of event that occurred
object
required
The Box Sign request with updated state
Slug: BOX_TASK_ASSIGNMENT_STATE_CHANGED_TRIGGERType: pollTriggers when a task assignment’s state changes.This trigger monitors task assignments for a specific task and detects when the resolution_state changes (e.g., from incomplete to completed, or from completed to approved/rejected).

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the task to monitor for assignment state changes. Task IDs can be obtained from the ‘create_task’ or ‘list_tasks_on_file’ actions.

Payload

object
required
The task assignment with updated state
string
The current resolution state of the assignment
string
Type of event that occurred
string
The previous resolution state of the assignment
Slug: BOX_TASK_STATE_CHANGED_TRIGGERType: pollTriggers when a task’s status or details change in Box.This trigger monitors a specific Box task and fires when changes are detected in key fields like status, due date, message, or completion state.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the task to monitor for status or detail changes. Task IDs can be obtained from the ‘create_task’ or ‘list_tasks_on_file’ actions. Example: ‘39641675308’.

Payload

array
List of field names that changed in this update
string
Type of event that occurred
object
required
The task with updated state
Slug: BOX_TRASHED_FILE_STATE_CHANGED_TRIGGERType: pollTriggers when a file’s trash state changes in Box.This trigger monitors a specific Box file and fires when its trash state changes (e.g., moved to trash or restored from trash).

Configuration

string
required
The unique identifier of the file to monitor for trash state changes. The file ID can be obtained from the ‘get_file_information’ or ‘list_items_in_folder’ actions. Example: ‘2119317417511’.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

array
List of field names that changed in this update
string
Current item_status value (‘active’, ‘trashed’, or ‘deleted’)
string
Type of event that occurred
object
required
The file with updated trash state
string
Previous item_status value (‘active’, ‘trashed’, or ‘deleted’)
Slug: BOX_TRASHED_FOLDER_STATE_CHANGED_TRIGGERType: pollTriggers when a folder’s trash state changes in Box.This trigger monitors a specific Box folder and fires when its trash state changes (e.g., moved to trash or restored from trash).

Configuration

string
required
The unique identifier of the folder to monitor for trash state changes. The folder ID can be obtained from the ‘get_folder_information’ or ‘list_items_in_folder’ actions. Example: ‘353353898191’.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload

array
List of field names that changed in this update
string
Current item_status value (‘active’, ‘trashed’, or ‘deleted’)
string
Type of event that occurred
object
required
The folder with updated trash state
string
Previous item_status value (‘active’, ‘trashed’, or ‘deleted’)