Connectors
File Storage & Transfer
Box
Cloud content management: files, folders, sharing, metadata, and collaboration
Box API referenceAPI checked August 16, 2026
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 338
- Ready-made triggers
- 72
Connect Box
- In Neblex open Connect › Connections and click New Connection.
- Search for Box and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Access tokenRequiredSecret |
Triggers
Start a flow when something changes in Box: add a Poll for changes trigger, choose Box and pick the event.
| Event | What it does | How |
|---|---|---|
| New or updated ai studio | Fires for each ai studio created or changed since the last check. | Checks for changes by modified_at |
| New or updated archive | Fires for each archive that appears or changes since the last check. | Checks for changes |
| New or updated automate workflow | Fires for each automate workflow created or changed since the last check. | Checks for changes by updated_at |
| New or updated domain restrictions for collaboration | Fires for each domain restrictions for collaboration that appears or changes since the last check. | Checks for changes |
| New or updated domain restrictions (user exemptions) | Fires for each domain restrictions (user exemptions) created or changed since the last check. | Checks for changes by modified_at |
| New or updated box doc gen | Fires for each box doc gen that appears or changes since the last check. | Checks for changes |
| New or updated box hub | Fires for each box hub created or changed since the last check. | Checks for changes by updated_at |
| New or updated device pinner | Fires for each device pinner that appears or changes since the last check. | Checks for changes |
| New or updated event | Fires for each event that appears or changes since the last check. | Checks for changes |
| New or updated comment | Fires for each comment created or changed since the last check. | Checks for changes by modified_at |
| New or updated file version | Fires for each file version created or changed since the last check. | Checks for changes by modified_at |
| New or updated uploads (chunked) | Fires for each uploads (chunked) that appears or changes since the last check. | Checks for changes |
| New or updated folder | Fires for each folder that appears or changes since the last check. | Checks for changes |
| New or updated group | Fires for each group created or changed since the last check. | Checks for changes by modified_at |
| New or updated group membership | Fires for each group membership created or changed since the last check. | Checks for changes by modified_at |
| New or updated box hub collaboration | Fires for each box hub collaboration that appears or changes since the last check. | Checks for changes |
| New or updated box hub item | Fires for each box hub item that appears or changes since the last check. | Checks for changes |
| New or updated integration mapping | Fires for each integration mapping created or changed since the last check. | Checks for changes by modified_at |
| New or updated legal hold policy | Fires for each legal hold policy created or changed since the last check. | Checks for changes by modified_at |
| New or updated legal hold policy assignment | Fires for each legal hold policy assignment that appears or changes since the last check. | Checks for changes |
| New or updated metadata cascade policy | Fires for each metadata cascade policy that appears or changes since the last check. | Checks for changes |
| New or updated metadata taxonomy | Fires for each metadata taxonomy that appears or changes since the last check. | Checks for changes |
| New or updated metadata template | Fires for each metadata template that appears or changes since the last check. | Checks for changes |
| New or updated retention policy | Fires for each retention policy created or changed since the last check. | Checks for changes by modified_at |
| New or updated retention policy assignment | Fires for each retention policy assignment that appears or changes since the last check. | Checks for changes |
| New or updated search | Fires for each search created or changed since the last check. | Checks for changes by modified_at |
| New or updated shield information barrier report | Fires for each shield information barrier report created or changed since the last check. | Checks for changes by updated_at |
| New or updated shield information barrier segment member | Fires for each shield information barrier segment member created or changed since the last check. | Checks for changes by updated_at |
| New or updated shield information barrier segment restriction | Fires for each shield information barrier segment restriction created or changed since the last check. | Checks for changes by updated_at |
| New or updated shield information barrier segment | Fires for each shield information barrier segment created or changed since the last check. | Checks for changes by updated_at |
| New or updated shield information barrier | Fires for each shield information barrier created or changed since the last check. | Checks for changes by updated_at |
| New or updated box sign request | Fires for each box sign request that appears or changes since the last check. | Checks for changes |
| New or updated standard and zones storage policy assignment | Fires for each standard and zones storage policy assignment that appears or changes since the last check. | Checks for changes |
| New or updated user | Fires for each user created or changed since the last check. | Checks for changes by modified_at |
| New or updated webhook | Fires for each webhook that appears or changes since the last check. | Checks for changes |
| New or updated workflow | Fires for each workflow that appears or changes since the last check. | Checks for changes |
| New ai studio | Fires for each ai studio created since the last check. | Checks for changes by created_at |
| New archive | Fires for each archive that appears since the last check. | Checks for changes |
| New automate workflow | Fires for each automate workflow created since the last check. | Checks for changes by created_at |
| New domain restrictions for collaboration | Fires for each domain restrictions for collaboration created since the last check. | Checks for changes by created_at |
| New domain restrictions (user exemptions) | Fires for each domain restrictions (user exemptions) created since the last check. | Checks for changes by created_at |
| New box doc gen | Fires for each box doc gen that appears since the last check. | Checks for changes |
| New box hub | Fires for each box hub created since the last check. | Checks for changes by created_at |
| New device pinner | Fires for each device pinner that appears since the last check. | Checks for changes |
| New event | Fires for each event created since the last check. | Checks for changes by created_at |
| New comment | Fires for each comment created since the last check. | Checks for changes by created_at |
| New file version | Fires for each file version created since the last check. | Checks for changes by created_at |
| New uploads (chunked) | Fires for each uploads (chunked) that appears since the last check. | Checks for changes |
| New folder | Fires for each folder that appears since the last check. | Checks for changes |
| New group | Fires for each group created since the last check. | Checks for changes by created_at |
| New group membership | Fires for each group membership created since the last check. | Checks for changes by created_at |
| New box hub collaboration | Fires for each box hub collaboration that appears since the last check. | Checks for changes |
| New box hub item | Fires for each box hub item that appears since the last check. | Checks for changes |
| New integration mapping | Fires for each integration mapping created since the last check. | Checks for changes by created_at |
| New legal hold policy | Fires for each legal hold policy created since the last check. | Checks for changes by created_at |
| New legal hold policy assignment | Fires for each legal hold policy assignment that appears since the last check. | Checks for changes |
| New metadata cascade policy | Fires for each metadata cascade policy that appears since the last check. | Checks for changes |
| New metadata taxonomy | Fires for each metadata taxonomy that appears since the last check. | Checks for changes |
| New metadata template | Fires for each metadata template that appears since the last check. | Checks for changes |
| New retention policy | Fires for each retention policy created since the last check. | Checks for changes by created_at |
| New retention policy assignment | Fires for each retention policy assignment that appears since the last check. | Checks for changes |
| New search | Fires for each search created since the last check. | Checks for changes by created_at |
| New shield information barrier report | Fires for each shield information barrier report created since the last check. | Checks for changes by created_at |
| New shield information barrier segment member | Fires for each shield information barrier segment member created since the last check. | Checks for changes by created_at |
| New shield information barrier segment restriction | Fires for each shield information barrier segment restriction created since the last check. | Checks for changes by created_at |
| New shield information barrier segment | Fires for each shield information barrier segment created since the last check. | Checks for changes by created_at |
| New shield information barrier | Fires for each shield information barrier created since the last check. | Checks for changes by created_at |
| New box sign request | Fires for each box sign request created since the last check. | Checks for changes by created_at |
| New standard and zones storage policy assignment | Fires for each standard and zones storage policy assignment that appears since the last check. | Checks for changes |
| New user | Fires for each user created since the last check. | Checks for changes by created_at |
| New webhook | Fires for each webhook that appears since the last check. | Checks for changes |
| New workflow | Fires for each workflow that appears since the last check. | Checks for changes |
Use it in a flow
- Open a flow, open the node library and search for Box.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
338 operations in 86 groups. Each one is a step you can add to a flow.
AI5
Ask questionpost_ai_ask | POST | Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context. |
Extract metadata (freeform)post_ai_extract | POST | Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. |
Extract metadata (structured)post_ai_extract_structured | POST | Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. |
Generate textpost_ai_text_gen | POST | Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt. |
Get AI agent default configurationget_ai_agent_default | GET | Get the AI agent default config. |
AI Studio5
Create AI agentpost_ai_agents | POST | Creates an AI agent. |
Delete AI agentdelete_ai_agents_id | DELETE | Deletes an AI agent using the provided parameters. |
Get AI agent by agent IDget_ai_agents_id | GET | Gets an AI Agent using the agent id parameter. |
List AI agentsget_ai_agents | GET | Lists AI agents based on the provided parameters. |
Update AI agentput_ai_agents_id | PUT | Updates an AI agent. |
App Item Association2
List file app item associationsget_files_id_app_item_associations | GET | This is a beta feature, which means that its availability might be limited. |
List folder app item associationsget_folders_id_app_item_associations | GET | This is a beta feature, which means that its availability might be limited. |
Archive4
Create archivepost_archives_v2025_0 | POST | Creates an archive. |
Delete archivedelete_archives_id_v2025_0 | DELETE | Permanently deletes an archive. |
List archivesget_archives_v2025_0 | GET | Retrieves archives for an enterprise. |
Update archiveput_archives_id_v2025_0 | PUT | Updates an archive. |
Authorization4
Authorize userget_authorize | GET | Authorize a user by sending them through the Box website and request their permission to act on their behalf. |
Refresh access tokenpost_oauth2_token_refresh | POST | Refresh an Access Token using its client ID, secret, and refresh token. |
Request access tokenpost_oauth2_token | POST | Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion. |
Revoke access tokenpost_oauth2_revoke | POST | Revoke an active Access Token, effectively logging a user out that has been previously authenticated. |
Automate Workflow2
List Automate workflows defined as callable actionsget_automate_workflows_v2026_0 | GET | Returns workflow actions from Automate for a folder, using the WORKFLOW action category. |
Start Automate workflowpost_automate_workflows_id_start_v2026_0 | POST | Starts an Automate workflow manually by using a workflow action ID and file IDs. |
Box Doc Gen4
Generate document using Box Doc Gen templatepost_docgen_batches_v2025_0 | POST | Generates a document using a Box Doc Gen template. |
Get Box Doc Gen job by IDget_docgen_jobs_id_v2025_0 | GET | Get details of the Box Doc Gen job. |
Get Box Doc Gen jobs by batch IDget_docgen_batch_jobs_id_v2025_0 | GET | Lists Box Doc Gen jobs in a batch. |
List all Box Doc Gen jobsget_docgen_jobs_v2025_0 | GET | Lists all Box Doc Gen jobs for a user. |
Box Doc Gen Template6
Create Box Doc Gen templatepost_docgen_templates_v2025_0 | POST | Marks a file as a Box Doc Gen template. |
Delete Box Doc Gen templatedelete_docgen_templates_id_v2025_0 | DELETE | Unmarks file as Box Doc Gen template. |
Get Box Doc Gen template by IDget_docgen_templates_id_v2025_0 | GET | Lists details of a specific Box Doc Gen template. |
Get list of all Box Doc Gen jobs for templateget_docgen_template_jobs_id_v2025_0 | GET | Lists the users jobs which use this template. |
List all Box Doc Gen template tags in templateget_docgen_templates_id_tags_v2025_0 | GET | Lists all tags in a Box Doc Gen template. |
List Box Doc Gen templatesget_docgen_templates_v2025_0 | GET | Lists Box Doc Gen templates on which the user is a collaborator. |
Box Hub7
Copy Box Hubpost_hubs_id_copy_v2025_0 | POST | Creates a copy of a Box Hub. |
Create Box Hubpost_hubs_v2025_0 | POST | Creates a new Box Hub. |
Delete Box Hubdelete_hubs_id_v2025_0 | DELETE | Deletes a single Box Hub. |
Get Box Hub information by IDget_hubs_id_v2025_0 | GET | Retrieves details for a Box Hub by its ID. |
List all Box Hubsget_hubs_v2025_0 | GET | Retrieves all Box Hubs for requesting user. |
List all Box Hubs for requesting enterpriseget_enterprise_hubs_v2025_0 | GET | Retrieves all Box Hubs for a given enterprise. |
Update Box Hub information by IDput_hubs_id_v2025_0 | PUT | Updates a Box Hub. |
Box Hub Collaboration5
Create Box Hub collaborationpost_hub_collaborations_v2025_0 | POST | Adds a collaboration for a single user or a single group to a Box Hub. |
Get Box Hub collaboration by collaboration IDget_hub_collaborations_id_v2025_0 | GET | Retrieves details for a Box Hub collaboration by collaboration ID. |
Get Box Hub collaborationsget_hub_collaborations_v2025_0 | GET | Retrieves all collaborations for a Box Hub. |
Remove Box Hub collaborationdelete_hub_collaborations_id_v2025_0 | DELETE | Deletes a single Box Hub collaboration. |
Update Box Hub collaborationput_hub_collaborations_id_v2025_0 | PUT | Updates a Box Hub collaboration. |
Box Hub Document2
List Hub Document blocks for pageget_hub_document_blocks_v2025_0 | GET | Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items. |
List Hub Document Pagesget_hub_document_pages_v2025_0 | GET | Retrieves a list of Hub Document Pages for the specified hub. |
Box Hub Item2
Get Box Hub itemsget_hub_items_v2025_0 | GET | Retrieves all items associated with a Box Hub. |
Manage Box Hub itemspost_hubs_id_manage_items_v2025_0 | POST | Adds and/or removes Box Hub items from a Box Hub. |
Box Sign Request5
Cancel Box Sign requestpost_sign_requests_id_cancel | POST | Cancels a sign request. |
Create Box Sign requestpost_sign_requests | POST | Creates a signature request. |
Get Box Sign request by IDget_sign_requests_id | GET | Gets a sign request by ID. |
List Box Sign requestsget_sign_requests | GET | Gets signature requests created by a user. |
Resend Box Sign requestpost_sign_requests_id_resend | POST | Resends a signature request email to all outstanding signers. |
Box Sign Template2
Get Box Sign template by IDget_sign_templates_id | GET | Fetches details of a specific Box Sign template. |
List Box Sign templatesget_sign_templates | GET | Gets Box Sign templates created by a user. |
Classification4
Add classificationput_metadata_templates_enterprise_securityClassification_6VMVochwUWo_schema_add | PUT | Adds one or more new classifications to the list of classifications available to the enterprise. |
Add initial classificationspost_metadata_templates_schema_classifications | POST | When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications. |
List all classificationsget_metadata_templates_enterprise_securityClassification_6VMVochwUWo_schema | GET | Retrieves the classification metadata template and lists all the classifications available to this enterprise. |
Update classificationput_metadata_templates_enterprise_securityClassification_6VMVochwUWo_schema_update | PUT | Updates the labels and descriptions of one or more classifications available to the enterprise. |
Classifications On File4
Add classification to filepost_files_id_metadata_enterprise_securityClassification_6VMVochwUWo | POST | Adds a classification to a file by specifying the label of the classification to add. |
Get classification on fileget_files_id_metadata_enterprise_securityClassification_6VMVochwUWo | GET | Retrieves the classification metadata instance that has been applied to a file. |
Remove classification from filedelete_files_id_metadata_enterprise_securityClassification_6VMVochwUWo | DELETE | Removes any classifications from a file. |
Update classification on fileput_files_id_metadata_enterprise_securityClassification_6VMVochwUWo | PUT | Updates a classification on a file. |
Classifications On Folder4
Add classification to folderpost_folders_id_metadata_enterprise_securityClassification_6VMVochwUWo | POST | Adds a classification to a folder by specifying the label of the classification to add. |
Get classification on folderget_folders_id_metadata_enterprise_securityClassification_6VMVochwUWo | GET | Retrieves the classification metadata instance that has been applied to a folder. |
Remove classification from folderdelete_folders_id_metadata_enterprise_securityClassification_6VMVochwUWo | DELETE | Removes any classifications from a folder. |
Update classification on folderput_folders_id_metadata_enterprise_securityClassification_6VMVochwUWo | PUT | Updates a classification on a folder. |
Collaboration4
Create collaborationpost_collaborations | POST | Adds a collaboration for a single user or a single group to a file or folder. |
Get collaborationget_collaborations_id | GET | Retrieves a single collaboration. |
Remove collaborationdelete_collaborations_id | DELETE | Deletes a single collaboration. |
Update collaborationput_collaborations_id | PUT | Updates a collaboration. |
Collaborations (List)4
List file collaborationsget_files_id_collaborations | GET | Retrieves a list of pending and active collaborations for a file. |
List folder collaborationsget_folders_id_collaborations | GET | Retrieves a list of pending and active collaborations for a folder. |
List group collaborationsget_groups_id_collaborations | GET | Retrieves all the collaborations for a group. |
List pending collaborationsget_collaborations | GET | Retrieves all pending collaboration invites for this user. |
Collection3
Get collection by IDget_collections_id | GET | Retrieves a collection by its ID. |
List all collectionsget_collections | GET | Retrieves all collections for a given user. |
List collection itemsget_collections_id_items | GET | Retrieves the files and/or folders contained within this collection. |
Comment5
Create commentpost_comments | POST | Adds a comment by the user to a specific file, or as a reply to an other comment. |
Get commentget_comments_id | GET | Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment. |
List file commentsget_files_id_comments | GET | Retrieves a list of comments for a file. |
Remove commentdelete_comments_id | DELETE | Permanently deletes a comment. |
Update commentput_comments_id | PUT | Update the message of a comment. |
Convert To Box Note1
Convert content to Box Notepost_notes_convert_v2026_0 | POST | Creates a Box Note (.boxnote file) from supported source content. |
Device Pinner3
Get device pinget_device_pinners_id | GET | Retrieves information about an individual device pin. |
List enterprise device pinsget_enterprises_id_device_pinners | GET | Retrieves all the device pins within an enterprise. |
Remove device pindelete_device_pinners_id | DELETE | Deletes an individual device pin. |
Domain Restrictions (User Exemptions)4
Create user exemption from collaboration domain restrictionspost_collaboration_whitelist_exempt_targets | POST | Exempts a user from the restrictions set out by the allowed list of domains for collaborations. |
Get user exempt from collaboration domain restrictionsget_collaboration_whitelist_exempt_targets_id | GET | Returns a users who has been exempt from the collaboration domain restrictions. |
List users exempt from collaboration domain restrictionsget_collaboration_whitelist_exempt_targets | GET | Returns a list of users who have been exempt from the collaboration domain restrictions. |
Remove user from list of users exempt from domain restrictionsdelete_collaboration_whitelist_exempt_targets_id | DELETE | Removes a user's exemption from the restrictions set out by the allowed list of domains for collaborations. |
Domain Restrictions For Collaboration4
Add domain to list of allowed collaboration domainspost_collaboration_whitelist_entries | POST | Creates a new entry in the list of allowed domains to allow collaboration for. |
Get allowed collaboration domainget_collaboration_whitelist_entries_id | GET | Returns a domain that has been deemed safe to create collaborations for within the current enterprise. |
List allowed collaboration domainsget_collaboration_whitelist_entries | GET | Returns the list domains that have been deemed safe to create collaborations for within the current enterprise. |
Remove domain from list of allowed collaboration domainsdelete_collaboration_whitelist_entries_id | DELETE | Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise. |
Download1
Download fileget_files_id_content | GET | Returns the contents of a file in binary format. |
Email Aliase3
Create email aliaspost_users_id_email_aliases | POST | Adds a new email alias to a user account.. |
List user's email aliasesget_users_id_email_aliases | GET | Retrieves all email aliases for a user. |
Remove email aliasdelete_users_id_email_aliases_id | DELETE | Removes an email alias from a user. |
Enterprise Configuration1
Get enterprise configurationget_enterprise_configurations_id_v2025_0 | GET | Retrieves the configuration for an enterprise. |
Event2
Get events long poll endpointoptions_events | OPTIONS | Returns a list of real-time servers that can be used for long-polling updates to the event stream. |
List user and enterprise eventsget_events | GET | Returns up to a year of past events for a given user or for the entire enterprise. |
External User1
Submit job to delete external userspost_external_users_submit_delete_job_v2025_0 | POST | Delete external users from current user enterprise. |
File6
Copy filepost_files_id_copy | POST | Creates a copy of a file. |
Delete filedelete_files_id | DELETE | Deletes a file, either permanently or by moving it to the trash. |
Get file informationget_files_id | GET | Retrieves the details about a file. |
Get file thumbnailget_files_id_thumbnail_id | GET | Retrieves a thumbnail, or smaller image representation, of a file. |
Preflight check before uploadoptions_files_content | OPTIONS | Performs a check to verify that a file will be accepted by Box before you upload the entire file. |
Update fileput_files_id | PUT | Updates a file. |
File Request4
Copy file requestpost_file_requests_id_copy | POST | Copies an existing file request that is already present on one folder, and applies it to another folder. |
Delete file requestdelete_file_requests_id | DELETE | Deletes a file request permanently. |
Get file requestget_file_requests_id | GET | Retrieves the information about a file request. |
Update file requestput_file_requests_id | PUT | Updates a file request. |
File Version5
Get file versionget_files_id_versions_id | GET | Retrieve a specific version of a file. |
List all file versionsget_files_id_versions | GET | Retrieve a list of the past versions for a file. |
Promote file versionpost_files_id_versions_current | POST | Promote a specific version of a file. |
Remove file versiondelete_files_id_versions_id | DELETE | Move a file version to the trash. |
Restore file versionput_files_id_versions_id | PUT | Restores a specific version of a file after it was deleted. |
File Version Legal Hold2
Get file version legal holdget_file_version_legal_holds_id | GET | Retrieves information about the legal hold policies assigned to a file version. |
List file version legal holdsget_file_version_legal_holds | GET | Get a list of file versions on legal hold for a legal hold assignment. |
File Version Retention2
Get retention on fileget_file_version_retentions_id | GET | Returns information about a file version retention. |
List file version retentionsget_file_version_retentions | GET | Retrieves all file version retentions for the given enterprise. |
Folder6
Copy folderpost_folders_id_copy | POST | Creates a copy of a folder within a destination folder. |
Create folderpost_folders | POST | Creates a new empty folder within the specified parent folder. |
Delete folderdelete_folders_id | DELETE | Deletes a folder, either permanently or by moving it to the trash. |
Get folder informationget_folders_id | GET | Retrieves details for a folder, including the first 100 entries in the folder. |
List items in folderget_folders_id_items | GET | Retrieves a page of items in a folder. |
Update folderput_folders_id | PUT | Updates a folder. |
Folder Lock3
Create folder lockpost_folder_locks | POST | Creates a folder lock on a folder, preventing it from being moved and/or deleted. |
Delete folder lockdelete_folder_locks_id | DELETE | Deletes a folder lock on a given folder. |
List folder locksget_folder_locks | GET | Retrieves folder lock details for a given folder. |
Group5
Create grouppost_groups | POST | Creates a new group of users in an enterprise. |
Get groupget_groups_id | GET | Retrieves information about a group. |
List groups for enterpriseget_groups | GET | Retrieves all of the groups for a given enterprise. |
Remove groupdelete_groups_id | DELETE | Permanently deletes a group. |
Update groupput_groups_id | PUT | Updates a specific group. |
Group Membership6
Add user to grouppost_group_memberships | POST | Creates a group membership. |
Get group membershipget_group_memberships_id | GET | Retrieves a specific group membership. |
List members of groupget_groups_id_memberships | GET | Retrieves all the members for a group. |
List user's groupsget_users_id_memberships | GET | Retrieves all the groups for a user. |
Remove user from groupdelete_group_memberships_id | DELETE | Deletes a specific group membership. |
Update group membershipput_group_memberships_id | PUT | Updates a user's group membership. |
Integration Mapping8
Create Slack integration mappingpost_integration_mappings_slack | POST | Creates a Slack integration mapping by mapping a Slack channel to a Box item. |
Create Teams integration mappingpost_integration_mappings_teams | POST | Creates a Teams integration mapping by mapping a Teams channel to a Box item. |
Delete Slack integration mappingdelete_integration_mappings_slack_id | DELETE | Deletes a Slack integration mapping. |
Delete Teams integration mappingdelete_integration_mappings_teams_id | DELETE | Deletes a Teams integration mapping. |
List Slack integration mappingsget_integration_mappings_slack | GET | Lists Slack integration mappings in a users' enterprise. |
List Teams integration mappingsget_integration_mappings_teams | GET | Lists Teams integration mappings in a users' enterprise. |
Update Slack integration mappingput_integration_mappings_slack_id | PUT | Updates a Slack integration mapping. |
Update Teams integration mappingput_integration_mappings_teams_id | PUT | Updates a Teams integration mapping. |
Invite2
Create user invitepost_invites | POST | Invites an existing external user to join an enterprise. |
Get user invite statusget_invites_id | GET | Returns the status of a user invite. |
Legal Hold Policy5
Create legal hold policypost_legal_hold_policies | POST | Create a new legal hold policy. |
Get legal hold policyget_legal_hold_policies_id | GET | Retrieve a legal hold policy. |
List all legal hold policiesget_legal_hold_policies | GET | Retrieves a list of legal hold policies that belong to an enterprise. |
Remove legal hold policydelete_legal_hold_policies_id | DELETE | Delete an existing legal hold policy. |
Update legal hold policyput_legal_hold_policies_id | PUT | Update legal hold policy. |
Legal Hold Policy Assignment6
Assign legal hold policypost_legal_hold_policy_assignments | POST | Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions. |
Get legal hold policy assignmentget_legal_hold_policy_assignments_id | GET | Retrieve a legal hold policy assignment. |
List files with current file versions for legal hold policyget_legal_hold_policy_assignments_id_files_on_hold | GET | Get a list of files with current file versions for a legal hold assignment. |
List legal hold policy assignmentsget_legal_hold_policy_assignments | GET | Retrieves a list of items a legal hold policy has been assigned to. |
List previous file versions for legal hold policy assignmentget_legal_hold_policy_assignments_id_file_versions_on_hold | GET | Get a list of previous file versions for a legal hold assignment. |
Unassign legal hold policydelete_legal_hold_policy_assignments_id | DELETE | Remove a legal hold from an item. |
Metadata Cascade Policy5
Create metadata cascade policypost_metadata_cascade_policies | POST | Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder. |
Force-apply metadata cascade policy to folderpost_metadata_cascade_policies_id_apply | POST | Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. |
Get metadata cascade policyget_metadata_cascade_policies_id | GET | Retrieve a specific metadata cascade policy assigned to a folder. |
List metadata cascade policiesget_metadata_cascade_policies | GET | Retrieves a list of all the metadata cascade policies that are applied to a given folder. |
Remove metadata cascade policydelete_metadata_cascade_policies_id | DELETE | Deletes a metadata cascade policy. |
Metadata Instances (Files)5
Create metadata instance on filepost_files_id_metadata_id_id | POST | Applies an instance of a metadata template to a file. |
Get metadata instance on fileget_files_id_metadata_id_id | GET | Retrieves the instance of a metadata template that has been applied to a file. |
List metadata instances on fileget_files_id_metadata | GET | Retrieves all metadata for a given file. |
Remove metadata instance from filedelete_files_id_metadata_id_id | DELETE | Deletes a piece of file metadata. |
Update metadata instance on fileput_files_id_metadata_id_id | PUT | Updates a piece of metadata on a file. |
Metadata Instances (Folders)5
Create metadata instance on folderpost_folders_id_metadata_id_id | POST | Applies an instance of a metadata template to a folder. |
Get metadata instance on folderget_folders_id_metadata_id_id | GET | Retrieves the instance of a metadata template that has been applied to a folder. |
List metadata instances on folderget_folders_id_metadata | GET | Retrieves all metadata for a given folder. |
Remove metadata instance from folderdelete_folders_id_metadata_id_id | DELETE | Deletes a piece of folder metadata. |
Update metadata instance on folderput_folders_id_metadata_id_id | PUT | Updates a piece of metadata on a folder. |
Metadata Taxonomy15
Add metadata taxonomy levelpost_metadata_taxonomies_id_id_levels_append | POST | Creates a new metadata taxonomy level and appends it to the existing levels. |
Create metadata taxonomypost_metadata_taxonomies | POST | Creates a new metadata taxonomy that can be used in metadata templates. |
Create metadata taxonomy levelspost_metadata_taxonomies_id_id_levels | POST | Creates new metadata taxonomy levels. |
Create metadata taxonomy nodepost_metadata_taxonomies_id_id_nodes | POST | Creates a new metadata taxonomy node. |
Delete metadata taxonomy levelpost_metadata_taxonomies_id_id_levels_trim | POST | Deletes the last level of the metadata taxonomy. |
Get metadata taxonomies for namespaceget_metadata_taxonomies_id | GET | Used to retrieve all metadata taxonomies in a namespace. |
Get metadata taxonomy by taxonomy keyget_metadata_taxonomies_id_id | GET | Used to retrieve a metadata taxonomy by taxonomy key. |
Get metadata taxonomy node by IDget_metadata_taxonomies_id_id_nodes_id | GET | Retrieves a metadata taxonomy node by its identifier. |
List metadata taxonomy nodesget_metadata_taxonomies_id_id_nodes | GET | Used to retrieve metadata taxonomy nodes based on the parameters specified. |
List metadata template's options for taxonomy fieldget_metadata_templates_id_id_fields_id_options | GET | Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. |
Remove metadata taxonomydelete_metadata_taxonomies_id_id | DELETE | Delete a metadata taxonomy. |
Remove metadata taxonomy nodedelete_metadata_taxonomies_id_id_nodes_id | DELETE | Delete a metadata taxonomy node. |
Update metadata taxonomypatch_metadata_taxonomies_id_id | PATCH | Updates an existing metadata taxonomy. |
Update metadata taxonomy levelpatch_metadata_taxonomies_id_id_levels_id | PATCH | Updates an existing metadata taxonomy level. |
Update metadata taxonomy nodepatch_metadata_taxonomies_id_id_nodes_id | PATCH | Updates an existing metadata taxonomy node. |
Metadata Template8
Create metadata templatepost_metadata_templates_schema | POST | Creates a new metadata template that can be applied to files and folders. |
Find metadata template by instance IDget_metadata_templates | GET | Finds a metadata template by searching for the ID of an instance of the template. |
Get metadata template by IDget_metadata_templates_id | GET | Retrieves a metadata template by its ID. |
Get metadata template by nameget_metadata_templates_id_id_schema | GET | Retrieves a metadata template by its scope and templateKey values. |
List all global metadata templatesget_metadata_templates_global | GET | Used to retrieve all generic, global metadata templates available to all enterprises using Box. |
List all metadata templates for enterpriseget_metadata_templates_enterprise | GET | Used to retrieve all metadata templates created to be used specifically within the user's enterprise. |
Remove metadata templatedelete_metadata_templates_id_id_schema | DELETE | Delete a metadata template and its instances. |
Update metadata templateput_metadata_templates_id_id_schema | PUT | Updates a metadata template. |
Query2
Create insights for Box itemspost_query_insights_v2026_0 | POST | Computes aggregated metrics over Box items matching a query predicate. |
Query for Box itemspost_query_v2026_0 | POST | Runs a query to discover Box items using a logical predicate that can filter across item fields and metadata templates. |
Recent Item1
List recently accessed itemsget_recent_items | GET | Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed. |
Retention Policy5
Create retention policypost_retention_policies | POST | Creates a retention policy. |
Delete retention policydelete_retention_policies_id | DELETE | Permanently deletes a retention policy. |
Get retention policyget_retention_policies_id | GET | Retrieves a retention policy. |
List retention policiesget_retention_policies | GET | Retrieves all of the retention policies for an enterprise. |
Update retention policyput_retention_policies_id | PUT | Updates a retention policy. |
Retention Policy Assignment6
Assign retention policypost_retention_policy_assignments | POST | Assigns a retention policy to an item. |
Get file versions under retentionget_retention_policy_assignments_id_file_versions_under_retention | GET | Returns a list of file versions under retention for a retention policy assignment. |
Get files under retentionget_retention_policy_assignments_id_files_under_retention | GET | Returns a list of files under retention for a retention policy assignment. |
Get retention policy assignmentget_retention_policy_assignments_id | GET | Retrieves a retention policy assignment. |
List retention policy assignmentsget_retention_policies_id_assignments | GET | Returns a list of all retention policy assignments associated with a specified retention policy. |
Remove retention policy assignmentdelete_retention_policy_assignments_id | DELETE | Removes a retention policy assignment applied to content. |
Search2
Query files/folders by metadatapost_metadata_queries_execute_read | POST | Create a search using SQL-like syntax to return items that match specific metadata. |
Search for contentget_search | GET | Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. |
Session Termination2
Create jobs to terminate user group sessionpost_groups_terminate_sessions | POST | Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. |
Create jobs to terminate users sessionpost_users_terminate_sessions | POST | Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. |
Shared Links (App Items)1
Find app item for shared linkget_shared_items_app_items | GET | Returns the app item represented by a shared link. |
Shared Links (Files)5
Add shared link to fileput_files_id_add_shared_link | PUT | Adds a shared link to a file. |
Find file for shared linkget_shared_items | GET | Returns the file represented by a shared link. |
Get shared link for fileget_files_id_get_shared_link | GET | Gets the information for a shared link on a file. |
Remove shared link from fileput_files_id_remove_shared_link | PUT | Removes a shared link from a file. |
Update shared link on fileput_files_id_update_shared_link | PUT | Updates a shared link on a file. |
Shared Links (Folders)5
Add shared link to folderput_folders_id_add_shared_link | PUT | Adds a shared link to a folder. |
Find folder for shared linkget_shared_items_folders | GET | Return the folder represented by a shared link. |
Get shared link for folderget_folders_id_get_shared_link | GET | Gets the information for a shared link on a folder. |
Remove shared link from folderput_folders_id_remove_shared_link | PUT | Removes a shared link from a folder. |
Update shared link on folderput_folders_id_update_shared_link | PUT | Updates a shared link on a folder. |
Shared Links (Web Links)5
Add shared link to web linkput_web_links_id_add_shared_link | PUT | Adds a shared link to a web link. |
Find web link for shared linkget_shared_items_web_links | GET | Returns the web link represented by a shared link. |
Get shared link for web linkget_web_links_id_get_shared_link | GET | Gets the information for a shared link on a web link. |
Remove shared link from web linkput_web_links_id_remove_shared_link | PUT | Removes a shared link from a web link. |
Update shared link on web linkput_web_links_id_update_shared_link | PUT | Updates a shared link on a web link. |
Shield Information Barrier4
Add changed status of shield information barrier with specifiedpost_shield_information_barriers_change_status | POST | Change status of shield information barrier with the specified ID. |
Create shield information barrierpost_shield_information_barriers | POST | Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them. |
Get shield information barrier with specified IDget_shield_information_barriers_id | GET | Get shield information barrier based on provided ID. |
List shield information barriersget_shield_information_barriers | GET | Retrieves a list of shield information barrier objects for the enterprise of JWT. |
Shield Information Barrier Report3
Create shield information barrier reportpost_shield_information_barrier_reports | POST | Creates a shield information barrier report for a given barrier. |
Get shield information barrier report by IDget_shield_information_barrier_reports_id | GET | Retrieves a shield information barrier report by its ID. |
List shield information barrier reportsget_shield_information_barrier_reports | GET | Lists shield information barrier reports. |
Shield Information Barrier Segment5
Create shield information barrier segmentpost_shield_information_barrier_segments | POST | Creates a shield information barrier segment. |
Delete shield information barrier segmentdelete_shield_information_barrier_segments_id | DELETE | Deletes the shield information barrier segment based on provided ID. |
Get shield information barrier segment with specified IDget_shield_information_barrier_segments_id | GET | Retrieves shield information barrier segment based on provided ID.. |
List shield information barrier segmentsget_shield_information_barrier_segments | GET | Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID. |
Update shield information barrier segment with specified IDput_shield_information_barrier_segments_id | PUT | Updates the shield information barrier segment based on provided ID.. |
Shield Information Barrier Segment Member4
Create shield information barrier segment memberpost_shield_information_barrier_segment_members | POST | Creates a new shield information barrier segment member. |
Delete shield information barrier segment member by IDdelete_shield_information_barrier_segment_members_id | DELETE | Deletes a shield information barrier segment member based on provided ID. |
Get shield information barrier segment member by IDget_shield_information_barrier_segment_members_id | GET | Retrieves a shield information barrier segment member by its ID. |
List shield information barrier segment membersget_shield_information_barrier_segment_members | GET | Lists shield information barrier segment members based on provided segment IDs. |
Shield Information Barrier Segment Restriction4
Create shield information barrier segment restrictionpost_shield_information_barrier_segment_restrictions | POST | Creates a shield information barrier segment restriction object. |
Delete shield information barrier segment restriction by IDdelete_shield_information_barrier_segment_restrictions_id | DELETE | Delete shield information barrier segment restriction based on provided ID. |
Get shield information barrier segment restriction by IDget_shield_information_barrier_segment_restrictions_id | GET | Retrieves a shield information barrier segment restriction based on provided ID. |
List shield information barrier segment restrictionsget_shield_information_barrier_segment_restrictions | GET | Lists shield information barrier segment restrictions based on provided segment ID. |
Shield List5
Create shield listpost_shield_lists_v2025_0 | POST | Creates a shield list. |
Delete single shield list by shield list iddelete_shield_lists_id_v2025_0 | DELETE | Delete a single shield list by its ID. |
Get all shield lists in enterpriseget_shield_lists_v2025_0 | GET | Retrieves all shield lists in the enterprise. |
Get single shield list by shield list idget_shield_lists_id_v2025_0 | GET | Retrieves a single shield list by its ID. |
Update shield listput_shield_lists_id_v2025_0 | PUT | Updates a shield list. |
Skill5
Create Box Skill cards on filepost_files_id_metadata_global_boxSkillsCards | POST | Applies one or more Box Skills metadata cards to a file. |
List Box Skill cards on fileget_files_id_metadata_global_boxSkillsCards | GET | List the Box Skills metadata cards that are attached to a file. |
Remove Box Skill cards from filedelete_files_id_metadata_global_boxSkillsCards | DELETE | Removes any Box Skills cards metadata from a file. |
Update all Box Skill cards on fileput_skill_invocations_id | PUT | An alternative method that can be used to overwrite and update all Box Skill metadata cards on a file. |
Update Box Skill cards on fileput_files_id_metadata_global_boxSkillsCards | PUT | Updates one or more Box Skills metadata cards to a file. |
Standard And Zones Storage Policy2
Get storage policyget_storage_policies_id | GET | Fetches a specific storage policy. |
List storage policiesget_storage_policies | GET | Fetches all the storage policies in the enterprise. |
Standard And Zones Storage Policy Assignment5
Assign storage policypost_storage_policy_assignments | POST | Creates a storage policy assignment for an enterprise or user. |
Get storage policy assignmentget_storage_policy_assignments_id | GET | Fetches a specific storage policy assignment. |
List storage policy assignmentsget_storage_policy_assignments | GET | Fetches all the storage policy assignment for an enterprise or user. |
Unassign storage policydelete_storage_policy_assignments_id | DELETE | Delete a storage policy assignment. |
Update storage policy assignmentput_storage_policy_assignments_id | PUT | Updates a specific storage policy assignment. |
Task5
Create taskpost_tasks | POST | Creates a single task on a file. |
Get taskget_tasks_id | GET | Retrieves information about a specific task. |
List tasks on fileget_files_id_tasks | GET | Retrieves a list of all the tasks for a file. |
Remove taskdelete_tasks_id | DELETE | Removes a task from a file. |
Update taskput_tasks_id | PUT | Updates a task. |
Task Assignment5
Assign taskpost_task_assignments | POST | Assigns a task to a user. |
Get task assignmentget_task_assignments_id | GET | Retrieves information about a task assignment. |
List task assignmentsget_tasks_id_assignments | GET | Lists all of the assignments for a given task. |
Unassign taskdelete_task_assignments_id | DELETE | Deletes a specific task assignment. |
Update task assignmentput_task_assignments_id | PUT | Updates a task assignment. |
Terms Of Service4
Create terms of servicepost_terms_of_services | POST | Creates a terms of service for a given enterprise and type of user. |
Get terms of serviceget_terms_of_services_id | GET | Fetches a specific terms of service. |
List terms of servicesget_terms_of_services | GET | Returns the current terms of service text and settings for the enterprise. |
Update terms of serviceput_terms_of_services_id | PUT | Updates a specific terms of service. |
Terms Of Service User Statuse3
Create terms of service status for new userpost_terms_of_service_user_statuses | POST | Sets the status for a terms of service for a user. |
List terms of service user statusesget_terms_of_service_user_statuses | GET | Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when. |
Update terms of service status for existing userput_terms_of_service_user_statuses_id | PUT | Updates the status for a terms of service for a user. |
Transfer Folder1
Transfer owned foldersput_users_id_folders_0 | PUT | Move all of the items (files, folders and workflows) owned by a user into another user's account. |
Trashed File3
Get trashed fileget_files_id_trash | GET | Retrieves a file that has been moved to the trash. |
Permanently remove filedelete_files_id_trash | DELETE | Permanently deletes a file that is in the trash. |
Restore filepost_files_id | POST | Restores a file that has been moved to the trash. |
Trashed Folder3
Get trashed folderget_folders_id_trash | GET | Retrieves a folder that has been moved to the trash. |
Permanently remove folderdelete_folders_id_trash | DELETE | Permanently deletes a folder that is in the trash. |
Restore folderpost_folders_id | POST | Restores a folder that has been moved to the trash. |
Trashed Item1
List trashed itemsget_folders_trash_items | GET | Retrieves the files and folders that have been moved to the trash. |
Trashed Web Link3
Get trashed web linkget_web_links_id_trash | GET | Retrieves a web link that has been moved to the trash. |
Permanently remove web linkdelete_web_links_id_trash | DELETE | Permanently deletes a web link that is in the trash. |
Restore web linkpost_web_links_id | POST | Restores a web link that has been moved to the trash. |
Upload2
Upload filepost_files_content | POST | Uploads a small file to Box. |
Upload file versionpost_files_id_content | POST | Update a file's content. |
Uploads (Chunked)7
Commit upload sessionpost_files_upload_sessions_id_commit | POST | Close an upload session and create a file from the uploaded chunks. |
Create upload sessionpost_files_upload_sessions | POST | Creates an upload session for a new file. |
Create upload session for existing filepost_files_id_upload_sessions | POST | Creates an upload session for an existing file. |
Get upload sessionget_files_upload_sessions_id | GET | Return information about an upload session. |
List partsget_files_upload_sessions_id_parts | GET | Return a list of the chunks uploaded to the upload session so far. |
Remove upload sessiondelete_files_upload_sessions_id | DELETE | Abort an upload session and discard all data uploaded. |
Upload part of fileput_files_upload_sessions_id | PUT | Uploads a chunk of a file for an upload session. |
User6
Create userpost_users | POST | Creates a new managed user in an enterprise. |
Delete userdelete_users_id | DELETE | Deletes a user. |
Get current userget_users_me | GET | Retrieves information about the user who is currently authenticated. |
Get userget_users_id | GET | Retrieves information about a user in the enterprise. |
List enterprise usersget_users | GET | Returns a list of all users for the Enterprise along with their user id, public name, and login. |
Update userput_users_id | PUT | Updates a managed or app user in an enterprise. |
User Avatar3
Add or update user avatarpost_users_id_avatar | POST | Adds or updates a user avatar. |
Delete user avatardelete_users_id_avatar | DELETE | Removes an existing user avatar. |
Get user avatarget_users_id_avatar | GET | Retrieves an image of a the user's avatar. |
Watermarks (Files)3
Apply watermark to fileput_files_id_watermark | PUT | Applies or update a watermark on a file. |
Get watermark on fileget_files_id_watermark | GET | Retrieve the watermark for a file. |
Remove watermark from filedelete_files_id_watermark | DELETE | Removes the watermark from a file. |
Watermarks (Folders)3
Apply watermark to folderput_folders_id_watermark | PUT | Applies or update a watermark on a folder. |
Get watermark for folderget_folders_id_watermark | GET | Retrieve the watermark for a folder. |
Remove watermark from folderdelete_folders_id_watermark | DELETE | Removes the watermark from a folder. |
Web Link4
Create web linkpost_web_links | POST | Creates a web link object within a folder. |
Get web linkget_web_links_id | GET | Retrieve information about a web link. |
Remove web linkdelete_web_links_id | DELETE | Deletes a web link. |
Update web linkput_web_links_id | PUT | Updates a web link object. |
Webhook5
Create webhookpost_webhooks | POST | Creates a webhook. |
Get webhookget_webhooks_id | GET | Retrieves a specific webhook. |
List all webhooksget_webhooks | GET | Returns all defined webhooks for the requesting application. |
Remove webhookdelete_webhooks_id | DELETE | Deletes a webhook. |
Update webhookput_webhooks_id | PUT | Updates a webhook. |
Workflow2
List workflowsget_workflows | GET | Returns list of workflows that act on a given folder ID, and have a flow with a trigger type of WORKFLOW MANUAL START. |
Starts workflow based on request bodypost_workflows_id_start | POST | Initiates a flow with a trigger type of WORKFLOW MANUAL START. |
Zip Download3
Create zip downloadpost_zip_downloads | POST | Creates a request to download multiple files and folders as a single zip archive file. |
Download zip archiveget_zip_downloads_id_content | GET | Returns the contents of a zip archive in binary format. |
Get zip download statusget_zip_downloads_id_status | GET | Returns the download status of a zip archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped. |