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

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Box and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat 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.

EventWhat it doesHow
New or updated ai studioFires for each ai studio created or changed since the last check.Checks for changes by modified_at
New or updated archiveFires for each archive that appears or changes since the last check.Checks for changes
New or updated automate workflowFires for each automate workflow created or changed since the last check.Checks for changes by updated_at
New or updated domain restrictions for collaborationFires 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 genFires for each box doc gen that appears or changes since the last check.Checks for changes
New or updated box hubFires for each box hub created or changed since the last check.Checks for changes by updated_at
New or updated device pinnerFires for each device pinner that appears or changes since the last check.Checks for changes
New or updated eventFires for each event that appears or changes since the last check.Checks for changes
New or updated commentFires for each comment created or changed since the last check.Checks for changes by modified_at
New or updated file versionFires 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 folderFires for each folder that appears or changes since the last check.Checks for changes
New or updated groupFires for each group created or changed since the last check.Checks for changes by modified_at
New or updated group membershipFires for each group membership created or changed since the last check.Checks for changes by modified_at
New or updated box hub collaborationFires for each box hub collaboration that appears or changes since the last check.Checks for changes
New or updated box hub itemFires for each box hub item that appears or changes since the last check.Checks for changes
New or updated integration mappingFires for each integration mapping created or changed since the last check.Checks for changes by modified_at
New or updated legal hold policyFires for each legal hold policy created or changed since the last check.Checks for changes by modified_at
New or updated legal hold policy assignmentFires for each legal hold policy assignment that appears or changes since the last check.Checks for changes
New or updated metadata cascade policyFires for each metadata cascade policy that appears or changes since the last check.Checks for changes
New or updated metadata taxonomyFires for each metadata taxonomy that appears or changes since the last check.Checks for changes
New or updated metadata templateFires for each metadata template that appears or changes since the last check.Checks for changes
New or updated retention policyFires for each retention policy created or changed since the last check.Checks for changes by modified_at
New or updated retention policy assignmentFires for each retention policy assignment that appears or changes since the last check.Checks for changes
New or updated searchFires for each search created or changed since the last check.Checks for changes by modified_at
New or updated shield information barrier reportFires 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 memberFires 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 restrictionFires 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 segmentFires for each shield information barrier segment created or changed since the last check.Checks for changes by updated_at
New or updated shield information barrierFires for each shield information barrier created or changed since the last check.Checks for changes by updated_at
New or updated box sign requestFires for each box sign request that appears or changes since the last check.Checks for changes
New or updated standard and zones storage policy assignmentFires for each standard and zones storage policy assignment that appears or changes since the last check.Checks for changes
New or updated userFires for each user created or changed since the last check.Checks for changes by modified_at
New or updated webhookFires for each webhook that appears or changes since the last check.Checks for changes
New or updated workflowFires for each workflow that appears or changes since the last check.Checks for changes
New ai studioFires for each ai studio created since the last check.Checks for changes by created_at
New archiveFires for each archive that appears since the last check.Checks for changes
New automate workflowFires for each automate workflow created since the last check.Checks for changes by created_at
New domain restrictions for collaborationFires 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 genFires for each box doc gen that appears since the last check.Checks for changes
New box hubFires for each box hub created since the last check.Checks for changes by created_at
New device pinnerFires for each device pinner that appears since the last check.Checks for changes
New eventFires for each event created since the last check.Checks for changes by created_at
New commentFires for each comment created since the last check.Checks for changes by created_at
New file versionFires 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 folderFires for each folder that appears since the last check.Checks for changes
New groupFires for each group created since the last check.Checks for changes by created_at
New group membershipFires for each group membership created since the last check.Checks for changes by created_at
New box hub collaborationFires for each box hub collaboration that appears since the last check.Checks for changes
New box hub itemFires for each box hub item that appears since the last check.Checks for changes
New integration mappingFires for each integration mapping created since the last check.Checks for changes by created_at
New legal hold policyFires for each legal hold policy created since the last check.Checks for changes by created_at
New legal hold policy assignmentFires for each legal hold policy assignment that appears since the last check.Checks for changes
New metadata cascade policyFires for each metadata cascade policy that appears since the last check.Checks for changes
New metadata taxonomyFires for each metadata taxonomy that appears since the last check.Checks for changes
New metadata templateFires for each metadata template that appears since the last check.Checks for changes
New retention policyFires for each retention policy created since the last check.Checks for changes by created_at
New retention policy assignmentFires for each retention policy assignment that appears since the last check.Checks for changes
New searchFires for each search created since the last check.Checks for changes by created_at
New shield information barrier reportFires for each shield information barrier report created since the last check.Checks for changes by created_at
New shield information barrier segment memberFires for each shield information barrier segment member created since the last check.Checks for changes by created_at
New shield information barrier segment restrictionFires for each shield information barrier segment restriction created since the last check.Checks for changes by created_at
New shield information barrier segmentFires for each shield information barrier segment created since the last check.Checks for changes by created_at
New shield information barrierFires for each shield information barrier created since the last check.Checks for changes by created_at
New box sign requestFires for each box sign request created since the last check.Checks for changes by created_at
New standard and zones storage policy assignmentFires for each standard and zones storage policy assignment that appears since the last check.Checks for changes
New userFires for each user created since the last check.Checks for changes by created_at
New webhookFires for each webhook that appears since the last check.Checks for changes
New workflowFires for each workflow that appears since the last check.Checks for changes

Use it in a flow

  1. Open a flow, open the node library and search for Box.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. 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_askPOSTSends 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_extractPOSTSends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
Extract metadata (structured)post_ai_extract_structuredPOSTSends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
Generate textpost_ai_text_genPOSTSends 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_defaultGETGet the AI agent default config.
AI Studio5
Create AI agentpost_ai_agentsPOSTCreates an AI agent.
Delete AI agentdelete_ai_agents_idDELETEDeletes an AI agent using the provided parameters.
Get AI agent by agent IDget_ai_agents_idGETGets an AI Agent using the agent id parameter.
List AI agentsget_ai_agentsGETLists AI agents based on the provided parameters.
Update AI agentput_ai_agents_idPUTUpdates an AI agent.
App Item Association2
List file app item associationsget_files_id_app_item_associationsGETThis is a beta feature, which means that its availability might be limited.
List folder app item associationsget_folders_id_app_item_associationsGETThis is a beta feature, which means that its availability might be limited.
Archive4
Create archivepost_archives_v2025_0POSTCreates an archive.
Delete archivedelete_archives_id_v2025_0DELETEPermanently deletes an archive.
List archivesget_archives_v2025_0GETRetrieves archives for an enterprise.
Update archiveput_archives_id_v2025_0PUTUpdates an archive.
Authorization4
Authorize userget_authorizeGETAuthorize a user by sending them through the Box website and request their permission to act on their behalf.
Refresh access tokenpost_oauth2_token_refreshPOSTRefresh an Access Token using its client ID, secret, and refresh token.
Request access tokenpost_oauth2_tokenPOSTRequest an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.
Revoke access tokenpost_oauth2_revokePOSTRevoke 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_0GETReturns workflow actions from Automate for a folder, using the WORKFLOW action category.
Start Automate workflowpost_automate_workflows_id_start_v2026_0POSTStarts 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_0POSTGenerates a document using a Box Doc Gen template.
Get Box Doc Gen job by IDget_docgen_jobs_id_v2025_0GETGet details of the Box Doc Gen job.
Get Box Doc Gen jobs by batch IDget_docgen_batch_jobs_id_v2025_0GETLists Box Doc Gen jobs in a batch.
List all Box Doc Gen jobsget_docgen_jobs_v2025_0GETLists all Box Doc Gen jobs for a user.
Box Doc Gen Template6
Create Box Doc Gen templatepost_docgen_templates_v2025_0POSTMarks a file as a Box Doc Gen template.
Delete Box Doc Gen templatedelete_docgen_templates_id_v2025_0DELETEUnmarks file as Box Doc Gen template.
Get Box Doc Gen template by IDget_docgen_templates_id_v2025_0GETLists details of a specific Box Doc Gen template.
Get list of all Box Doc Gen jobs for templateget_docgen_template_jobs_id_v2025_0GETLists the users jobs which use this template.
List all Box Doc Gen template tags in templateget_docgen_templates_id_tags_v2025_0GETLists all tags in a Box Doc Gen template.
List Box Doc Gen templatesget_docgen_templates_v2025_0GETLists Box Doc Gen templates on which the user is a collaborator.
Box Hub7
Copy Box Hubpost_hubs_id_copy_v2025_0POSTCreates a copy of a Box Hub.
Create Box Hubpost_hubs_v2025_0POSTCreates a new Box Hub.
Delete Box Hubdelete_hubs_id_v2025_0DELETEDeletes a single Box Hub.
Get Box Hub information by IDget_hubs_id_v2025_0GETRetrieves details for a Box Hub by its ID.
List all Box Hubsget_hubs_v2025_0GETRetrieves all Box Hubs for requesting user.
List all Box Hubs for requesting enterpriseget_enterprise_hubs_v2025_0GETRetrieves all Box Hubs for a given enterprise.
Update Box Hub information by IDput_hubs_id_v2025_0PUTUpdates a Box Hub.
Box Hub Collaboration5
Create Box Hub collaborationpost_hub_collaborations_v2025_0POSTAdds 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_0GETRetrieves details for a Box Hub collaboration by collaboration ID.
Get Box Hub collaborationsget_hub_collaborations_v2025_0GETRetrieves all collaborations for a Box Hub.
Remove Box Hub collaborationdelete_hub_collaborations_id_v2025_0DELETEDeletes a single Box Hub collaboration.
Update Box Hub collaborationput_hub_collaborations_id_v2025_0PUTUpdates a Box Hub collaboration.
Box Hub Document2
List Hub Document blocks for pageget_hub_document_blocks_v2025_0GETRetrieves 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_0GETRetrieves a list of Hub Document Pages for the specified hub.
Box Hub Item2
Get Box Hub itemsget_hub_items_v2025_0GETRetrieves all items associated with a Box Hub.
Manage Box Hub itemspost_hubs_id_manage_items_v2025_0POSTAdds and/or removes Box Hub items from a Box Hub.
Box Sign Request5
Cancel Box Sign requestpost_sign_requests_id_cancelPOSTCancels a sign request.
Create Box Sign requestpost_sign_requestsPOSTCreates a signature request.
Get Box Sign request by IDget_sign_requests_idGETGets a sign request by ID.
List Box Sign requestsget_sign_requestsGETGets signature requests created by a user.
Resend Box Sign requestpost_sign_requests_id_resendPOSTResends a signature request email to all outstanding signers.
Box Sign Template2
Get Box Sign template by IDget_sign_templates_idGETFetches details of a specific Box Sign template.
List Box Sign templatesget_sign_templatesGETGets Box Sign templates created by a user.
Classification4
Add classificationput_metadata_templates_enterprise_securityClassification_6VMVochwUWo_schema_addPUTAdds one or more new classifications to the list of classifications available to the enterprise.
Add initial classificationspost_metadata_templates_schema_classificationsPOSTWhen 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_schemaGETRetrieves the classification metadata template and lists all the classifications available to this enterprise.
Update classificationput_metadata_templates_enterprise_securityClassification_6VMVochwUWo_schema_updatePUTUpdates 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_6VMVochwUWoPOSTAdds a classification to a file by specifying the label of the classification to add.
Get classification on fileget_files_id_metadata_enterprise_securityClassification_6VMVochwUWoGETRetrieves the classification metadata instance that has been applied to a file.
Remove classification from filedelete_files_id_metadata_enterprise_securityClassification_6VMVochwUWoDELETERemoves any classifications from a file.
Update classification on fileput_files_id_metadata_enterprise_securityClassification_6VMVochwUWoPUTUpdates a classification on a file.
Classifications On Folder4
Add classification to folderpost_folders_id_metadata_enterprise_securityClassification_6VMVochwUWoPOSTAdds a classification to a folder by specifying the label of the classification to add.
Get classification on folderget_folders_id_metadata_enterprise_securityClassification_6VMVochwUWoGETRetrieves the classification metadata instance that has been applied to a folder.
Remove classification from folderdelete_folders_id_metadata_enterprise_securityClassification_6VMVochwUWoDELETERemoves any classifications from a folder.
Update classification on folderput_folders_id_metadata_enterprise_securityClassification_6VMVochwUWoPUTUpdates a classification on a folder.
Collaboration4
Create collaborationpost_collaborationsPOSTAdds a collaboration for a single user or a single group to a file or folder.
Get collaborationget_collaborations_idGETRetrieves a single collaboration.
Remove collaborationdelete_collaborations_idDELETEDeletes a single collaboration.
Update collaborationput_collaborations_idPUTUpdates a collaboration.
Collaborations (List)4
List file collaborationsget_files_id_collaborationsGETRetrieves a list of pending and active collaborations for a file.
List folder collaborationsget_folders_id_collaborationsGETRetrieves a list of pending and active collaborations for a folder.
List group collaborationsget_groups_id_collaborationsGETRetrieves all the collaborations for a group.
List pending collaborationsget_collaborationsGETRetrieves all pending collaboration invites for this user.
Collection3
Get collection by IDget_collections_idGETRetrieves a collection by its ID.
List all collectionsget_collectionsGETRetrieves all collections for a given user.
List collection itemsget_collections_id_itemsGETRetrieves the files and/or folders contained within this collection.
Comment5
Create commentpost_commentsPOSTAdds a comment by the user to a specific file, or as a reply to an other comment.
Get commentget_comments_idGETRetrieves the message and metadata for a specific comment, as well as information on the user who created the comment.
List file commentsget_files_id_commentsGETRetrieves a list of comments for a file.
Remove commentdelete_comments_idDELETEPermanently deletes a comment.
Update commentput_comments_idPUTUpdate the message of a comment.
Convert To Box Note1
Convert content to Box Notepost_notes_convert_v2026_0POSTCreates a Box Note (.boxnote file) from supported source content.
Device Pinner3
Get device pinget_device_pinners_idGETRetrieves information about an individual device pin.
List enterprise device pinsget_enterprises_id_device_pinnersGETRetrieves all the device pins within an enterprise.
Remove device pindelete_device_pinners_idDELETEDeletes an individual device pin.
Domain Restrictions (User Exemptions)4
Create user exemption from collaboration domain restrictionspost_collaboration_whitelist_exempt_targetsPOSTExempts 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_idGETReturns a users who has been exempt from the collaboration domain restrictions.
List users exempt from collaboration domain restrictionsget_collaboration_whitelist_exempt_targetsGETReturns 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_idDELETERemoves 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_entriesPOSTCreates a new entry in the list of allowed domains to allow collaboration for.
Get allowed collaboration domainget_collaboration_whitelist_entries_idGETReturns a domain that has been deemed safe to create collaborations for within the current enterprise.
List allowed collaboration domainsget_collaboration_whitelist_entriesGETReturns 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_idDELETERemoves 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_contentGETReturns the contents of a file in binary format.
Email Aliase3
Create email aliaspost_users_id_email_aliasesPOSTAdds a new email alias to a user account..
List user's email aliasesget_users_id_email_aliasesGETRetrieves all email aliases for a user.
Remove email aliasdelete_users_id_email_aliases_idDELETERemoves an email alias from a user.
Enterprise Configuration1
Get enterprise configurationget_enterprise_configurations_id_v2025_0GETRetrieves the configuration for an enterprise.
Event2
Get events long poll endpointoptions_eventsOPTIONSReturns a list of real-time servers that can be used for long-polling updates to the event stream.
List user and enterprise eventsget_eventsGETReturns 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_0POSTDelete external users from current user enterprise.
File6
Copy filepost_files_id_copyPOSTCreates a copy of a file.
Delete filedelete_files_idDELETEDeletes a file, either permanently or by moving it to the trash.
Get file informationget_files_idGETRetrieves the details about a file.
Get file thumbnailget_files_id_thumbnail_idGETRetrieves a thumbnail, or smaller image representation, of a file.
Preflight check before uploadoptions_files_contentOPTIONSPerforms a check to verify that a file will be accepted by Box before you upload the entire file.
Update fileput_files_idPUTUpdates a file.
File Request4
Copy file requestpost_file_requests_id_copyPOSTCopies an existing file request that is already present on one folder, and applies it to another folder.
Delete file requestdelete_file_requests_idDELETEDeletes a file request permanently.
Get file requestget_file_requests_idGETRetrieves the information about a file request.
Update file requestput_file_requests_idPUTUpdates a file request.
File Version5
Get file versionget_files_id_versions_idGETRetrieve a specific version of a file.
List all file versionsget_files_id_versionsGETRetrieve a list of the past versions for a file.
Promote file versionpost_files_id_versions_currentPOSTPromote a specific version of a file.
Remove file versiondelete_files_id_versions_idDELETEMove a file version to the trash.
Restore file versionput_files_id_versions_idPUTRestores a specific version of a file after it was deleted.
File Version Legal Hold2
Get file version legal holdget_file_version_legal_holds_idGETRetrieves information about the legal hold policies assigned to a file version.
List file version legal holdsget_file_version_legal_holdsGETGet a list of file versions on legal hold for a legal hold assignment.
File Version Retention2
Get retention on fileget_file_version_retentions_idGETReturns information about a file version retention.
List file version retentionsget_file_version_retentionsGETRetrieves all file version retentions for the given enterprise.
Folder6
Copy folderpost_folders_id_copyPOSTCreates a copy of a folder within a destination folder.
Create folderpost_foldersPOSTCreates a new empty folder within the specified parent folder.
Delete folderdelete_folders_idDELETEDeletes a folder, either permanently or by moving it to the trash.
Get folder informationget_folders_idGETRetrieves details for a folder, including the first 100 entries in the folder.
List items in folderget_folders_id_itemsGETRetrieves a page of items in a folder.
Update folderput_folders_idPUTUpdates a folder.
Folder Lock3
Create folder lockpost_folder_locksPOSTCreates a folder lock on a folder, preventing it from being moved and/or deleted.
Delete folder lockdelete_folder_locks_idDELETEDeletes a folder lock on a given folder.
List folder locksget_folder_locksGETRetrieves folder lock details for a given folder.
Group5
Create grouppost_groupsPOSTCreates a new group of users in an enterprise.
Get groupget_groups_idGETRetrieves information about a group.
List groups for enterpriseget_groupsGETRetrieves all of the groups for a given enterprise.
Remove groupdelete_groups_idDELETEPermanently deletes a group.
Update groupput_groups_idPUTUpdates a specific group.
Group Membership6
Add user to grouppost_group_membershipsPOSTCreates a group membership.
Get group membershipget_group_memberships_idGETRetrieves a specific group membership.
List members of groupget_groups_id_membershipsGETRetrieves all the members for a group.
List user's groupsget_users_id_membershipsGETRetrieves all the groups for a user.
Remove user from groupdelete_group_memberships_idDELETEDeletes a specific group membership.
Update group membershipput_group_memberships_idPUTUpdates a user's group membership.
Integration Mapping8
Create Slack integration mappingpost_integration_mappings_slackPOSTCreates a Slack integration mapping by mapping a Slack channel to a Box item.
Create Teams integration mappingpost_integration_mappings_teamsPOSTCreates a Teams integration mapping by mapping a Teams channel to a Box item.
Delete Slack integration mappingdelete_integration_mappings_slack_idDELETEDeletes a Slack integration mapping.
Delete Teams integration mappingdelete_integration_mappings_teams_idDELETEDeletes a Teams integration mapping.
List Slack integration mappingsget_integration_mappings_slackGETLists Slack integration mappings in a users' enterprise.
List Teams integration mappingsget_integration_mappings_teamsGETLists Teams integration mappings in a users' enterprise.
Update Slack integration mappingput_integration_mappings_slack_idPUTUpdates a Slack integration mapping.
Update Teams integration mappingput_integration_mappings_teams_idPUTUpdates a Teams integration mapping.
Invite2
Create user invitepost_invitesPOSTInvites an existing external user to join an enterprise.
Get user invite statusget_invites_idGETReturns the status of a user invite.
Legal Hold Policy5
Create legal hold policypost_legal_hold_policiesPOSTCreate a new legal hold policy.
Get legal hold policyget_legal_hold_policies_idGETRetrieve a legal hold policy.
List all legal hold policiesget_legal_hold_policiesGETRetrieves a list of legal hold policies that belong to an enterprise.
Remove legal hold policydelete_legal_hold_policies_idDELETEDelete an existing legal hold policy.
Update legal hold policyput_legal_hold_policies_idPUTUpdate legal hold policy.
Legal Hold Policy Assignment6
Assign legal hold policypost_legal_hold_policy_assignmentsPOSTAssign 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_idGETRetrieve a legal hold policy assignment.
List files with current file versions for legal hold policyget_legal_hold_policy_assignments_id_files_on_holdGETGet a list of files with current file versions for a legal hold assignment.
List legal hold policy assignmentsget_legal_hold_policy_assignmentsGETRetrieves 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_holdGETGet a list of previous file versions for a legal hold assignment.
Unassign legal hold policydelete_legal_hold_policy_assignments_idDELETERemove a legal hold from an item.
Metadata Cascade Policy5
Create metadata cascade policypost_metadata_cascade_policiesPOSTCreates 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_applyPOSTForce 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_idGETRetrieve a specific metadata cascade policy assigned to a folder.
List metadata cascade policiesget_metadata_cascade_policiesGETRetrieves a list of all the metadata cascade policies that are applied to a given folder.
Remove metadata cascade policydelete_metadata_cascade_policies_idDELETEDeletes a metadata cascade policy.
Metadata Instances (Files)5
Create metadata instance on filepost_files_id_metadata_id_idPOSTApplies an instance of a metadata template to a file.
Get metadata instance on fileget_files_id_metadata_id_idGETRetrieves the instance of a metadata template that has been applied to a file.
List metadata instances on fileget_files_id_metadataGETRetrieves all metadata for a given file.
Remove metadata instance from filedelete_files_id_metadata_id_idDELETEDeletes a piece of file metadata.
Update metadata instance on fileput_files_id_metadata_id_idPUTUpdates a piece of metadata on a file.
Metadata Instances (Folders)5
Create metadata instance on folderpost_folders_id_metadata_id_idPOSTApplies an instance of a metadata template to a folder.
Get metadata instance on folderget_folders_id_metadata_id_idGETRetrieves the instance of a metadata template that has been applied to a folder.
List metadata instances on folderget_folders_id_metadataGETRetrieves all metadata for a given folder.
Remove metadata instance from folderdelete_folders_id_metadata_id_idDELETEDeletes a piece of folder metadata.
Update metadata instance on folderput_folders_id_metadata_id_idPUTUpdates a piece of metadata on a folder.
Metadata Taxonomy15
Add metadata taxonomy levelpost_metadata_taxonomies_id_id_levels_appendPOSTCreates a new metadata taxonomy level and appends it to the existing levels.
Create metadata taxonomypost_metadata_taxonomiesPOSTCreates a new metadata taxonomy that can be used in metadata templates.
Create metadata taxonomy levelspost_metadata_taxonomies_id_id_levelsPOSTCreates new metadata taxonomy levels.
Create metadata taxonomy nodepost_metadata_taxonomies_id_id_nodesPOSTCreates a new metadata taxonomy node.
Delete metadata taxonomy levelpost_metadata_taxonomies_id_id_levels_trimPOSTDeletes the last level of the metadata taxonomy.
Get metadata taxonomies for namespaceget_metadata_taxonomies_idGETUsed to retrieve all metadata taxonomies in a namespace.
Get metadata taxonomy by taxonomy keyget_metadata_taxonomies_id_idGETUsed to retrieve a metadata taxonomy by taxonomy key.
Get metadata taxonomy node by IDget_metadata_taxonomies_id_id_nodes_idGETRetrieves a metadata taxonomy node by its identifier.
List metadata taxonomy nodesget_metadata_taxonomies_id_id_nodesGETUsed to retrieve metadata taxonomy nodes based on the parameters specified.
List metadata template's options for taxonomy fieldget_metadata_templates_id_id_fields_id_optionsGETUsed 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_idDELETEDelete a metadata taxonomy.
Remove metadata taxonomy nodedelete_metadata_taxonomies_id_id_nodes_idDELETEDelete a metadata taxonomy node.
Update metadata taxonomypatch_metadata_taxonomies_id_idPATCHUpdates an existing metadata taxonomy.
Update metadata taxonomy levelpatch_metadata_taxonomies_id_id_levels_idPATCHUpdates an existing metadata taxonomy level.
Update metadata taxonomy nodepatch_metadata_taxonomies_id_id_nodes_idPATCHUpdates an existing metadata taxonomy node.
Metadata Template8
Create metadata templatepost_metadata_templates_schemaPOSTCreates a new metadata template that can be applied to files and folders.
Find metadata template by instance IDget_metadata_templatesGETFinds a metadata template by searching for the ID of an instance of the template.
Get metadata template by IDget_metadata_templates_idGETRetrieves a metadata template by its ID.
Get metadata template by nameget_metadata_templates_id_id_schemaGETRetrieves a metadata template by its scope and templateKey values.
List all global metadata templatesget_metadata_templates_globalGETUsed to retrieve all generic, global metadata templates available to all enterprises using Box.
List all metadata templates for enterpriseget_metadata_templates_enterpriseGETUsed to retrieve all metadata templates created to be used specifically within the user's enterprise.
Remove metadata templatedelete_metadata_templates_id_id_schemaDELETEDelete a metadata template and its instances.
Update metadata templateput_metadata_templates_id_id_schemaPUTUpdates a metadata template.
Query2
Create insights for Box itemspost_query_insights_v2026_0POSTComputes aggregated metrics over Box items matching a query predicate.
Query for Box itemspost_query_v2026_0POSTRuns 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_itemsGETReturns 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_policiesPOSTCreates a retention policy.
Delete retention policydelete_retention_policies_idDELETEPermanently deletes a retention policy.
Get retention policyget_retention_policies_idGETRetrieves a retention policy.
List retention policiesget_retention_policiesGETRetrieves all of the retention policies for an enterprise.
Update retention policyput_retention_policies_idPUTUpdates a retention policy.
Retention Policy Assignment6
Assign retention policypost_retention_policy_assignmentsPOSTAssigns a retention policy to an item.
Get file versions under retentionget_retention_policy_assignments_id_file_versions_under_retentionGETReturns a list of file versions under retention for a retention policy assignment.
Get files under retentionget_retention_policy_assignments_id_files_under_retentionGETReturns a list of files under retention for a retention policy assignment.
Get retention policy assignmentget_retention_policy_assignments_idGETRetrieves a retention policy assignment.
List retention policy assignmentsget_retention_policies_id_assignmentsGETReturns a list of all retention policy assignments associated with a specified retention policy.
Remove retention policy assignmentdelete_retention_policy_assignments_idDELETERemoves a retention policy assignment applied to content.
Search2
Query files/folders by metadatapost_metadata_queries_execute_readPOSTCreate a search using SQL-like syntax to return items that match specific metadata.
Search for contentget_searchGETSearches 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_sessionsPOSTValidates 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_sessionsPOSTValidates 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_itemsGETReturns the app item represented by a shared link.
Shared Links (Files)5
Add shared link to fileput_files_id_add_shared_linkPUTAdds a shared link to a file.
Find file for shared linkget_shared_itemsGETReturns the file represented by a shared link.
Get shared link for fileget_files_id_get_shared_linkGETGets the information for a shared link on a file.
Remove shared link from fileput_files_id_remove_shared_linkPUTRemoves a shared link from a file.
Update shared link on fileput_files_id_update_shared_linkPUTUpdates a shared link on a file.
Shared Links (Folders)5
Add shared link to folderput_folders_id_add_shared_linkPUTAdds a shared link to a folder.
Find folder for shared linkget_shared_items_foldersGETReturn the folder represented by a shared link.
Get shared link for folderget_folders_id_get_shared_linkGETGets the information for a shared link on a folder.
Remove shared link from folderput_folders_id_remove_shared_linkPUTRemoves a shared link from a folder.
Update shared link on folderput_folders_id_update_shared_linkPUTUpdates a shared link on a folder.
Shared Links (Web Links)5
Add shared link to web linkput_web_links_id_add_shared_linkPUTAdds a shared link to a web link.
Find web link for shared linkget_shared_items_web_linksGETReturns the web link represented by a shared link.
Get shared link for web linkget_web_links_id_get_shared_linkGETGets the information for a shared link on a web link.
Remove shared link from web linkput_web_links_id_remove_shared_linkPUTRemoves a shared link from a web link.
Update shared link on web linkput_web_links_id_update_shared_linkPUTUpdates a shared link on a web link.
Shield Information Barrier4
Add changed status of shield information barrier with specifiedpost_shield_information_barriers_change_statusPOSTChange status of shield information barrier with the specified ID.
Create shield information barrierpost_shield_information_barriersPOSTCreates 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_idGETGet shield information barrier based on provided ID.
List shield information barriersget_shield_information_barriersGETRetrieves a list of shield information barrier objects for the enterprise of JWT.
Shield Information Barrier Report3
Create shield information barrier reportpost_shield_information_barrier_reportsPOSTCreates a shield information barrier report for a given barrier.
Get shield information barrier report by IDget_shield_information_barrier_reports_idGETRetrieves a shield information barrier report by its ID.
List shield information barrier reportsget_shield_information_barrier_reportsGETLists shield information barrier reports.
Shield Information Barrier Segment5
Create shield information barrier segmentpost_shield_information_barrier_segmentsPOSTCreates a shield information barrier segment.
Delete shield information barrier segmentdelete_shield_information_barrier_segments_idDELETEDeletes the shield information barrier segment based on provided ID.
Get shield information barrier segment with specified IDget_shield_information_barrier_segments_idGETRetrieves shield information barrier segment based on provided ID..
List shield information barrier segmentsget_shield_information_barrier_segmentsGETRetrieves 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_idPUTUpdates the shield information barrier segment based on provided ID..
Shield Information Barrier Segment Member4
Create shield information barrier segment memberpost_shield_information_barrier_segment_membersPOSTCreates a new shield information barrier segment member.
Delete shield information barrier segment member by IDdelete_shield_information_barrier_segment_members_idDELETEDeletes a shield information barrier segment member based on provided ID.
Get shield information barrier segment member by IDget_shield_information_barrier_segment_members_idGETRetrieves a shield information barrier segment member by its ID.
List shield information barrier segment membersget_shield_information_barrier_segment_membersGETLists 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_restrictionsPOSTCreates a shield information barrier segment restriction object.
Delete shield information barrier segment restriction by IDdelete_shield_information_barrier_segment_restrictions_idDELETEDelete shield information barrier segment restriction based on provided ID.
Get shield information barrier segment restriction by IDget_shield_information_barrier_segment_restrictions_idGETRetrieves a shield information barrier segment restriction based on provided ID.
List shield information barrier segment restrictionsget_shield_information_barrier_segment_restrictionsGETLists shield information barrier segment restrictions based on provided segment ID.
Shield List5
Create shield listpost_shield_lists_v2025_0POSTCreates a shield list.
Delete single shield list by shield list iddelete_shield_lists_id_v2025_0DELETEDelete a single shield list by its ID.
Get all shield lists in enterpriseget_shield_lists_v2025_0GETRetrieves all shield lists in the enterprise.
Get single shield list by shield list idget_shield_lists_id_v2025_0GETRetrieves a single shield list by its ID.
Update shield listput_shield_lists_id_v2025_0PUTUpdates a shield list.
Skill5
Create Box Skill cards on filepost_files_id_metadata_global_boxSkillsCardsPOSTApplies one or more Box Skills metadata cards to a file.
List Box Skill cards on fileget_files_id_metadata_global_boxSkillsCardsGETList the Box Skills metadata cards that are attached to a file.
Remove Box Skill cards from filedelete_files_id_metadata_global_boxSkillsCardsDELETERemoves any Box Skills cards metadata from a file.
Update all Box Skill cards on fileput_skill_invocations_idPUTAn 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_boxSkillsCardsPUTUpdates one or more Box Skills metadata cards to a file.
Standard And Zones Storage Policy2
Get storage policyget_storage_policies_idGETFetches a specific storage policy.
List storage policiesget_storage_policiesGETFetches all the storage policies in the enterprise.
Standard And Zones Storage Policy Assignment5
Assign storage policypost_storage_policy_assignmentsPOSTCreates a storage policy assignment for an enterprise or user.
Get storage policy assignmentget_storage_policy_assignments_idGETFetches a specific storage policy assignment.
List storage policy assignmentsget_storage_policy_assignmentsGETFetches all the storage policy assignment for an enterprise or user.
Unassign storage policydelete_storage_policy_assignments_idDELETEDelete a storage policy assignment.
Update storage policy assignmentput_storage_policy_assignments_idPUTUpdates a specific storage policy assignment.
Task5
Create taskpost_tasksPOSTCreates a single task on a file.
Get taskget_tasks_idGETRetrieves information about a specific task.
List tasks on fileget_files_id_tasksGETRetrieves a list of all the tasks for a file.
Remove taskdelete_tasks_idDELETERemoves a task from a file.
Update taskput_tasks_idPUTUpdates a task.
Task Assignment5
Assign taskpost_task_assignmentsPOSTAssigns a task to a user.
Get task assignmentget_task_assignments_idGETRetrieves information about a task assignment.
List task assignmentsget_tasks_id_assignmentsGETLists all of the assignments for a given task.
Unassign taskdelete_task_assignments_idDELETEDeletes a specific task assignment.
Update task assignmentput_task_assignments_idPUTUpdates a task assignment.
Terms Of Service4
Create terms of servicepost_terms_of_servicesPOSTCreates a terms of service for a given enterprise and type of user.
Get terms of serviceget_terms_of_services_idGETFetches a specific terms of service.
List terms of servicesget_terms_of_servicesGETReturns the current terms of service text and settings for the enterprise.
Update terms of serviceput_terms_of_services_idPUTUpdates a specific terms of service.
Terms Of Service User Statuse3
Create terms of service status for new userpost_terms_of_service_user_statusesPOSTSets the status for a terms of service for a user.
List terms of service user statusesget_terms_of_service_user_statusesGETRetrieves 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_idPUTUpdates the status for a terms of service for a user.
Transfer Folder1
Transfer owned foldersput_users_id_folders_0PUTMove all of the items (files, folders and workflows) owned by a user into another user's account.
Trashed File3
Get trashed fileget_files_id_trashGETRetrieves a file that has been moved to the trash.
Permanently remove filedelete_files_id_trashDELETEPermanently deletes a file that is in the trash.
Restore filepost_files_idPOSTRestores a file that has been moved to the trash.
Trashed Folder3
Get trashed folderget_folders_id_trashGETRetrieves a folder that has been moved to the trash.
Permanently remove folderdelete_folders_id_trashDELETEPermanently deletes a folder that is in the trash.
Restore folderpost_folders_idPOSTRestores a folder that has been moved to the trash.
Trashed Item1
List trashed itemsget_folders_trash_itemsGETRetrieves the files and folders that have been moved to the trash.
Trashed Web Link3
Get trashed web linkget_web_links_id_trashGETRetrieves a web link that has been moved to the trash.
Permanently remove web linkdelete_web_links_id_trashDELETEPermanently deletes a web link that is in the trash.
Restore web linkpost_web_links_idPOSTRestores a web link that has been moved to the trash.
Upload2
Upload filepost_files_contentPOSTUploads a small file to Box.
Upload file versionpost_files_id_contentPOSTUpdate a file's content.
Uploads (Chunked)7
Commit upload sessionpost_files_upload_sessions_id_commitPOSTClose an upload session and create a file from the uploaded chunks.
Create upload sessionpost_files_upload_sessionsPOSTCreates an upload session for a new file.
Create upload session for existing filepost_files_id_upload_sessionsPOSTCreates an upload session for an existing file.
Get upload sessionget_files_upload_sessions_idGETReturn information about an upload session.
List partsget_files_upload_sessions_id_partsGETReturn a list of the chunks uploaded to the upload session so far.
Remove upload sessiondelete_files_upload_sessions_idDELETEAbort an upload session and discard all data uploaded.
Upload part of fileput_files_upload_sessions_idPUTUploads a chunk of a file for an upload session.
User6
Create userpost_usersPOSTCreates a new managed user in an enterprise.
Delete userdelete_users_idDELETEDeletes a user.
Get current userget_users_meGETRetrieves information about the user who is currently authenticated.
Get userget_users_idGETRetrieves information about a user in the enterprise.
List enterprise usersget_usersGETReturns a list of all users for the Enterprise along with their user id, public name, and login.
Update userput_users_idPUTUpdates a managed or app user in an enterprise.
User Avatar3
Add or update user avatarpost_users_id_avatarPOSTAdds or updates a user avatar.
Delete user avatardelete_users_id_avatarDELETERemoves an existing user avatar.
Get user avatarget_users_id_avatarGETRetrieves an image of a the user's avatar.
Watermarks (Files)3
Apply watermark to fileput_files_id_watermarkPUTApplies or update a watermark on a file.
Get watermark on fileget_files_id_watermarkGETRetrieve the watermark for a file.
Remove watermark from filedelete_files_id_watermarkDELETERemoves the watermark from a file.
Watermarks (Folders)3
Apply watermark to folderput_folders_id_watermarkPUTApplies or update a watermark on a folder.
Get watermark for folderget_folders_id_watermarkGETRetrieve the watermark for a folder.
Remove watermark from folderdelete_folders_id_watermarkDELETERemoves the watermark from a folder.
Web Link4
Create web linkpost_web_linksPOSTCreates a web link object within a folder.
Get web linkget_web_links_idGETRetrieve information about a web link.
Remove web linkdelete_web_links_idDELETEDeletes a web link.
Update web linkput_web_links_idPUTUpdates a web link object.
Webhook5
Create webhookpost_webhooksPOSTCreates a webhook.
Get webhookget_webhooks_idGETRetrieves a specific webhook.
List all webhooksget_webhooksGETReturns all defined webhooks for the requesting application.
Remove webhookdelete_webhooks_idDELETEDeletes a webhook.
Update webhookput_webhooks_idPUTUpdates a webhook.
Workflow2
List workflowsget_workflowsGETReturns 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_startPOSTInitiates a flow with a trigger type of WORKFLOW MANUAL START.
Zip Download3
Create zip downloadpost_zip_downloadsPOSTCreates a request to download multiple files and folders as a single zip archive file.
Download zip archiveget_zip_downloads_id_contentGETReturns the contents of a zip archive in binary format.
Get zip download statusget_zip_downloads_id_statusGETReturns 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.