# Box Developer Documentation > Complete documentation for Box Platform APIs, SDKs, and developer tools. Box Platform enables developers to integrate secure content management, collaboration, and AI capabilities into their applications. ## Complete Documentation - [llms-full.txt](https://developer.box.com/llms-full.txt): Complete concatenated documentation with all content in a single file ## Box Platform - [Appendix](https://developer.box.com/platform/appendix.md): Appendix In this section, you will find some other getting started related material. It isn't vital to know from the get go, but it can help… - [Application Types](https://developer.box.com/platform/application-types.md): Application Types Box offers various application types to cater to different needs and use cases in application development. Each provides… - [Architecture Patterns](https://developer.box.com/platform/appendix/architecture-patterns.md): Architecture Patterns We recommend creating a visual representation for your application before writing any code. The architecture patterns… - [Authentication Methods](https://developer.box.com/platform/authentication-methods.md): Authentication Methods Box offers a variety of authentication methods for application development, each tailored to different use cases and… - [Box Platform 101](https://developer.box.com/platform/box-platform-101.md): Box Platform 101 What is Box Box is a cloud-based content management and file sharing platform that enables individuals and businesses to… - [Box Platform glossary](https://developer.box.com/platform/box-glossary.md): Box Platform glossary This glossary includes terms and definitions used in Box Platform. If you need to find out what a term means, this is… - [Branding Guidelines](https://developer.box.com/platform/appendix/branding-guidelines.md): Branding Guidelines We are glad you are using Box Platform, and we want you to be able to broadcast to the world that you are using Box… - [Learn Box Platform](https://developer.box.com/platform.md): Learn Box Platform If you are new to Box, start here! In the following pages, you'll learn how all the Box Platform concepts and components… - [Locating Common Values](https://developer.box.com/platform/appendix/locating-values.md): Locating Common Values User IDs As a developer To locate your own user ID via the Box web app, navigate to your All Files page. Click the… - [Start Creating](https://developer.box.com/platform/start-creating.md): Start Creating Now that you have learned all about the various parts that makeup Box Platform, you are ready to jump in and start creating… - [Support](https://developer.box.com/platform/support.md): Support The Box Developer Relations team loves to help developers in any way we can. Outside of interviewing developers regularly, we… - [Tools](https://developer.box.com/platform/tools.md): Tools Box offers several tools for you to use to jump start your development. Check them out below. Sample Code Catalog The sample code… - [Use Cases](https://developer.box.com/platform/use-cases.md): Use Cases Before beginning application development, it is best to assess if your use case is a good fit for the Box Platform. Generally… - [User Models](https://developer.box.com/platform/appendix/user-models.md): User Models Once you confirm your use case is a good fit for Box Platform and you have a solid understanding of the types of users involved… - [User Types](https://developer.box.com/platform/user-types.md): User Types A critical part of planning and developing an application is understanding the types of users involved. There are four main types… ## Developer Guides - [Access Tokens](https://developer.box.com/guides/authentication/tokens/access-tokens.md): Access Tokens Instead of a user name and password, Access Tokens are the credentials used to represent the authenticated user to the Box… - [Add content to Box Archive](https://developer.box.com/guides/archives/add-content.md): Add content to Box Archive To add content to an archive, you need to create it first. If you have not done this yet, use the Create Archive… - [Add Item to Collection](https://developer.box.com/guides/collections/add.md): Add Item to Collection To add an item to a collection, call the PUT endpoint for that specific type of item and pass along a list of… - [Add Metadata Template to a File](https://developer.box.com/guides/search/quick-start/apply-template-to-file.md): Add Metadata Template to a File Your metadata template needs to be applied to at least one file to ensure a result in step 4. There are two… - [AI agent configuration versioning](https://developer.box.com/guides/box-ai/ai-agents/ai-agent-versioning.md): AI agent configuration versioning Box updates the default models across the endpoints on a regular basis in order to stay up to date with… - [AI model overrides](https://developer.box.com/guides/box-ai/ai-agents.md): AI model overrides Box updates the default models across the endpoints on a regular basis to stay up to date with the most advanced options… - [AI studio agents](https://developer.box.com/guides/ai-studio/ai-studio-agents.md): AI studio agents Box AI Studio is available only for Enterprise Advanced accounts. Create, list, update, and delete custom AI agents. - [Allow a domain for collaboration](https://developer.box.com/guides/collaborations/allowed-domains/create.md): Allow a domain for collaboration An enterprise that normally restricts creating collaborations can add domains, such as example.com, to a… - [Allow domain access](https://developer.box.com/guides/api-calls/allowing-domain-access.md): Allow domain access To use the Box APIs it is important that your application and users have access to the following domains, where needed… - [Allowed collaboration domains](https://developer.box.com/guides/collaborations/allowed-domains.md): Allowed collaboration domains Within the content and sharing settings for an enterprise, an admin can specify collaboration restrictions for… - [Android](https://developer.box.com/guides/mobile/android.md): Android The Box Android SDK provides native access to the Box API from within your Android project. As of May 31, 2023 Android SDK is no… - [Android SDK Installation](https://developer.box.com/guides/mobile/android/install.md): Android SDK Installation As of May 31, 2023 Android SDK is no longer supported. You can still use your existing Android SDK applications… - [Annotations](https://developer.box.com/guides/embed/ui-elements/annotations.md): Annotations Box Annotations allow developers to provide collaboration capabilities right from within the embedded Box preview in their… - [Annotator Tokens](https://developer.box.com/guides/authentication/tokens/annotator-tokens.md): Annotator Tokens Annotations is one of the key features supported by new Box View, that allows developers to provide collaboration… - [API Calls](https://developer.box.com/guides/api-calls.md): API Calls The Box API is a restful API that follow common HTTP standards where possible. The following guides take a look at some of the… - [API versioning strategy](https://developer.box.com/guides/api-calls/api-versioning-strategy.md): API versioning strategy Box provides versioning capabilities for selected API endpoints. The version control system guarantees seamless… - [App Diagnostics Report](https://developer.box.com/guides/api-calls/permissions-and-errors/app-diagnostics-report.md): App Diagnostics Report The App Diagnostics Report provides a spreadsheet detailing each API call made by a given application during a… - [App Token Auth](https://developer.box.com/guides/authentication/app-token.md): App Token Auth Server-side authentication using App Tokens is an alternative way to authenticate to the Box API with fixed, long-lived… - [App Tokens with SDKs](https://developer.box.com/guides/authentication/app-token/with-sdk.md): App Tokens with SDKs The official Box SDKs have built-in support for App Token authentication. App Token authentication is designed for… - [App Tokens without SDKs](https://developer.box.com/guides/authentication/app-token/without-sdk.md): App Tokens without SDKs If you are not ready to use any of the official Box SDKs, or an SDK is not available in your language of choice, it… - [Application Flow](https://developer.box.com/guides/security/terms-of-service/flow.md): Application Flow In general, applications use Terms of Services as follows. When an application, authenticated as a user, tries to access an… - [Application Types](https://developer.box.com/guides/applications/app-types.md): Application Types The following is an overview of the different Box Application types you can create. Application Type Authentication… - [Applications](https://developer.box.com/guides/applications.md): Applications Box Developer Console allows you to create applications you can then use to integrate with Box. My Platform Apps view displays… - [Apply metadata to a file](https://developer.box.com/guides/metadata/quick-start/create-instance.md): Apply metadata to a file With your new customerData template in hand you can now apply this template to a file or folder. To apply this… - [Apply metadata to an item](https://developer.box.com/guides/metadata/instances/create.md): Apply metadata to an item A metadata template can be applied to a file or folder using the item's id, the template's templateKey and scope… - [as-user Header](https://developer.box.com/guides/authentication/jwt/as-user.md): as-user Header It is possible to for a JWT application to act on behalf of another user by leveraging the as-user header. In this situation… - [As-User Header](https://developer.box.com/guides/authentication/oauth2/as-user.md): As-User Header It is possible to for an OAuth 2.0 application to act on behalf of another user through the as-user header. In this situation… - [Ask questions to Box AI](https://developer.box.com/guides/box-ai/ai-tutorials/ask-questions.md): Ask questions to Box AI Box AI API is available to all Enterprise Plus and Enterprise Advanced customers. Box AI API allows you to ask a… - [Assign a task to a user](https://developer.box.com/guides/tasks/assignments/assign.md): Assign a task to a user To assign a task to a user you will need to provide the POST /task_assignments API with the id of the task and the… - [Assigning tasks](https://developer.box.com/guides/tasks/assignments.md): Assigning tasks When a task is delegated to a user in Box it creates a task assignment. A task assignment is a request for that user to… - [Authentication](https://developer.box.com/guides/authentication.md): Authentication Authentication with the Box API uses an Access Token to identify a user. The way in which an Access Token is acquired depends… - [Authorization](https://developer.box.com/guides/authorization.md): Authorization Some applications require explicit Admin authorization before use with an enterprise. The steps an Admin needs to take are… - [AWS Claude 3 Haiku](https://developer.box.com/guides/box-ai/ai-models/aws-claude-3-haiku-model-card.md): AWS Claude 3 Haiku Overview AWS Claude 3 Haiku model is tailored for various language tasks, including creative writing and conversational… - [AWS Claude 3 Sonnet](https://developer.box.com/guides/box-ai/ai-models/aws-claude-3-sonnet-model-card.md): AWS Claude 3 Sonnet AWS Claude 3 Sonnet model is designed for advanced language tasks, focusing on comprehension and context handling. Model… - [AWS Claude 3.5 Sonnet](https://developer.box.com/guides/box-ai/ai-models/aws-claude-3-5-sonnet-model-card.md): AWS Claude 3.5 Sonnet Overview AWS Claude 3.5 Sonnet model is designed to enhance language understanding and generation tasks. Model details… - [AWS Claude 3.7 Sonnet](https://developer.box.com/guides/box-ai/ai-models/aws-claude-3-7-sonnet-model-card.md): AWS Claude 3.7 Sonnet Overview AWS Claude 3.7 Sonnet model is designed to enhance language understanding and generation tasks. Model details… - [AWS Claude 4 Opus](https://developer.box.com/guides/box-ai/ai-models/aws-claude-4-opus-model-card.md): AWS Claude 4 Opus AWS Claude 4 Opus model excels at coding and complex problem-solving, powering frontier agent products. It's possible to… - [AWS Claude 4 Sonnet](https://developer.box.com/guides/box-ai/ai-models/aws-claude-4-sonnet-model-card.md): AWS Claude 4 Sonnet AWS Claude 4 Sonnet model delivers superior coding and reasoning while responding more precisely to your instructions… - [AWS Titan Text Lite](https://developer.box.com/guides/box-ai/ai-models/aws-titan-text-lite-model-card.md): AWS Titan Text Lite AWS Titan Text Lite model is designed for advanced language processing, capable of handling extensive contexts, making… - [Azure OpenAI GPT-4.1](https://developer.box.com/guides/box-ai/ai-models/azure-openai-gpt-4-1-model-card.md): Azure OpenAI GPT-4.1 Azure OpenAI GPT-4.1 is a multimodal model, highly efficient in handling complex, multi-step tasks. Model details Item… - [Azure OpenAI GPT-4.1 Mini](https://developer.box.com/guides/box-ai/ai-models/azure-openai-gpt-4-1-mini-model-card.md): Azure OpenAI GPT-4.1 Mini Azure OpenAI GPT-4.1 Mini is a multimodal model designed to handle lightweight tasks. Model details Item Value… - [Azure OpenAI GPT-4o](https://developer.box.com/guides/box-ai/ai-models/azure-openai-gpt-4o-model-card.md): Azure OpenAI GPT-4o Azure OpenAI GPT-4o is a multimodal model designed to handle lightweight tasks. Model details Item Value Description… - [Azure OpenAI GPT-4o Mini](https://developer.box.com/guides/box-ai/ai-models/azure-openai-gpt-4o-mini-model-card.md): Azure OpenAI GPT-4o Mini Azure OpenAI GPT-4o Mini is a multimodal model designed to handle lightweight tasks. Model details Item Value… - [Azure text-embedding-ada-002](https://developer.box.com/guides/box-ai/ai-models/azure-text-embedding-ada-002-model-card.md): Azure text-embedding-ada-002 Azure text-embedding-ada-002 is a multimodal model designed to handle lightweight tasks. Model details Item… - [Best Practices](https://developer.box.com/guides/authentication/best-practices.md): Best Practices Client secret security Your client secret is confidential and needs to be protected. Because this is how we securely identify… - [Best Practices](https://developer.box.com/guides/embed/box-view/best-practices.md): Best Practices Rotate App Tokens See our guide on rotating App Tokens. Use Downscope Tokens App Tokens are a set of two tokens (Primary and… - [Box AI](https://developer.box.com/guides/box-ai.md): Box AI Box AI API allows you to use Box AI functionality in your platform applications. For example, you can implement Box AI question and… - [Box AI Studio](https://developer.box.com/guides/ai-studio.md): Box AI Studio Box AI Studio is available only for Enterprise Advanced accounts. Box AI Studio allows you to build and manage custom AI… - [Box AI tutorials](https://developer.box.com/guides/box-ai/ai-tutorials.md): Box AI tutorials The listed tutorials provide you with an overview and use cases for Q&A and text generation, metadata extraction, and AI… - [Box API & SSO](https://developer.box.com/guides/authentication/sso.md): Box API & SSO Many Box Enterprises use Single Sign On (SSO) to authenticate Managed Users logging in to Box. The way an application built on… - [Box Archive](https://developer.box.com/guides/archives.md): Box Archive Box Archive is available only for Enterprise Advanced accounts. Box Archive allows you to create and manage archives. An archive… - [Box CLI with JWT Authentication](https://developer.box.com/guides/cli/cli-docs/jwt-cli.md): Box CLI with JWT Authentication Previously, our Box CLI Quick Start Guide, followed the JWT or server authentication application setup flow… - [Box Doc Gen](https://developer.box.com/guides/docgen.md): Box Doc Gen Box Doc Gen allows you to generate business documents such as offer letters, sales contracts, invoices or agreements. You can… - [Box Doc Gen jobs](https://developer.box.com/guides/docgen/docgen-jobs.md): Box Doc Gen jobs A Box Doc Gen job runs when you make a request to generate a document. The document_generation_data parameter in the POST… - [Box Doc Gen templates](https://developer.box.com/guides/docgen/docgen-templates.md): Box Doc Gen templates Box Doc Gen API allows you to retrieve information related to Box Doc Gen templates. Prerequisites Before you start… - [Box Edit Custom Domains](https://developer.box.com/guides/embed/ui-elements/custom-domains.md): Box Edit Custom Domains In order to integrate a third party web application with Box Tools, you will need to explicitly add your application… - [Box Embed](https://developer.box.com/guides/embed/box-embed.md): Box Embed Box Embed is a HTML-based framework that allows embedding the entire Box Web App experience in a custom-made application. Box… - [Box for Agentforce Extension package](https://developer.box.com/guides/tooling/salesforce-toolkit/box-agentforce-package.md): Box for Agentforce Extension package The Box for Agentforce Extension package is an extension of the Box for Salesforce managed package… - [Box MCP Server](https://developer.box.com/guides/box-mcp.md): Box MCP Server Model Context Protocol (MCP) is an open protocol that standardizes how applications provide context to LLMs. MCP servers make… - [Box Relay](https://developer.box.com/guides/box-relay.md): Box Relay Box Relay is a workflow automation application that enables Box power users to automate and accelerate business processes centered… - [Box Sign](https://developer.box.com/guides/box-sign.md): Box Sign Programmatically harness the full functionality of the Box Sign web app experience by leveraging Box Sign’s API endpoints to create… - [Box Skills](https://developer.box.com/guides/skills.md): Box Skills Box Skills are designed to allow custom processing of files uploaded to Box, with the intent of enhancing the underlying metadata… - [Box Skills Kit](https://developer.box.com/guides/skills/kit.md): Box Skills Kit The Box Skills Kit is a Node wrapper that is designed to abstract many of the common complex operations required during the… - [Box Skills Payload](https://developer.box.com/guides/skills/handle/payload.md): Box Skills Payload When a new file is uploaded, copied, or moved to a folder monitored by a Skills app, the invocation URL that was… - [Box View](https://developer.box.com/guides/embed/box-view.md): Box View Box View is an embeddable service that allows developers to upload, convert, and display files in their web and mobile apps via a… - [Browser Support](https://developer.box.com/guides/embed/ui-elements/browser.md): Browser Support Box UI elements are supported in the following browsers. Chrome, Firefox, Safari, and Edge (latest 2 versions) Mobile Chrome… - [Build Folder Tree](https://developer.box.com/guides/folders/bulk/build-folder-tree.md): Build Folder Tree The following examples provide an example on how to create a JSON representation of a folder tree. A folder tree is the… - [Building Commands and Help Feature](https://developer.box.com/guides/cli/quick-start/build-commands-help.md): Building Commands and Help Feature A full list of CLI commands and usage information can be found in the GitHub repository. Only Service… - [Bulk Manipulation](https://developer.box.com/guides/folders/bulk.md): Bulk Manipulation The following pages discuss how to do various bulk methods to folders. - [Cancel Box Sign Request](https://developer.box.com/guides/box-sign/cancel-sign-request.md): Cancel Box Sign Request A Box Sign request, that has not yet been signed or declined, can be cancelled using the cancel Box Sign request… - [Change an assignment's message](https://developer.box.com/guides/tasks/assignments/update-message.md): Change an assignment's message To update a task assignment's message call the PUT /tasks/:task_id/assignments API, and include the new… - [Change Folder Owner](https://developer.box.com/guides/folders/single/change-owner.md): Change Folder Owner To change the owner of a folder, first invite the user you wish to transfer the folder to as a collaborator on the… - [Change task assignment state](https://developer.box.com/guides/tasks/assignments/change-state.md): Change task assignment state To update a task assignment's state call the PUT /tasks/:task_id/assignments API and include a resolution_state… - [Chunked Upload with SDKs](https://developer.box.com/guides/uploads/chunked/with-sdks.md): Chunked Upload with SDKs The Box SDKs make it possible to perform a chunked upload with the built-in SDK methods. The SDKs also support… - [Chunked Uploads](https://developer.box.com/guides/uploads/chunked.md): Chunked Uploads The Chunked Upload API provides a way to reliably upload large files to Box by chunking them into a sequence of parts that… - [Classifications](https://developer.box.com/guides/metadata/classifications.md): Classifications Box enables users and applications to apply a security classification label to files, and cascade a classification label to… - [CLI](https://developer.box.com/guides/cli.md): CLI The Box Command Line Interface (CLI) is a tool for making requests to Box APIs from your terminal window or command prompt. Quick start… - [CLI bulk commands](https://developer.box.com/guides/cli/cli-docs/bulk-commands.md): CLI bulk commands The Box CLI bulk commands help you to automate repetitive tasks. By adding a --bulk-file-path flag to your command, you… - [CLI guides](https://developer.box.com/guides/cli/cli-docs.md): CLI guides Here you can find guides on how to use Box CLI features and capabilities. Set up and test Box CLI with JWT authentication. Set up… - [CLI Installation and Configuration](https://developer.box.com/guides/cli/quick-start/install-and-configure.md): CLI Installation and Configuration Installers are available for Windows and macOS. However, the raw source-code is available if you would… - [CLI sample scripts](https://developer.box.com/guides/cli/scripts.md): CLI sample scripts Box CLI scripts are designed to help you automate your tasks. Currently, the sample scripts library provides several… - [Client Credentials Grant](https://developer.box.com/guides/authentication/client-credentials.md): Client Credentials Grant Follow the steps below if you would like to leverage server authentication and verify your application's identity… - [Code Samples](https://developer.box.com/guides/tooling/salesforce-toolkit/samples.md): Code Samples Generic Method The following code will create metadata on a Box folder in Salesforce using the generic Toolkit method: New… - [Collaborations](https://developer.box.com/guides/collaborations.md): Collaborations Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A… - [Collections](https://developer.box.com/guides/collections.md): Collections Collections in Box are a way to group files, folders, and web links without putting them all into a folder together. The only… - [Comments](https://developer.box.com/guides/comments.md): Comments Comments are messages generated by Box users on files, allowing users to collaborate together on a file, discussing any feedback… - [Commit Upload Session](https://developer.box.com/guides/uploads/chunked/commit-session.md): Commit Upload Session The final step in a chunked upload is to commit the session. To commit a file upload session, call the POST /files… - [Common errors](https://developer.box.com/guides/metadata/queries/errors.md): Common errors Metadata query API errors mostly are similar to errors returned by other APIs, however at this time some incorrect client… - [Common Errors](https://developer.box.com/guides/authorization/common-errors.md): Common Errors Unable to retrieve service of enterprise app authorization This error indicates that the entered client ID entered is invalid… - [Comparison to regular search](https://developer.box.com/guides/metadata/queries/comparison.md): Comparison to regular search At the surface the Metadata Query API seems very similar to the Search for content API, but there are several… - [Configure a Box App](https://developer.box.com/guides/cli/quick-start/create-oauth-app.md): Configure a Box App To use the Box CLI you will need to create a Box App. A Box App is an application that can be used for making API calls… - [Configure a Box App](https://developer.box.com/guides/tooling/postman/quick-start/configure-box-app.md): Configure a Box App To use the Postman Collection the Postman application needs to authenticate to the Box API using an Access Token. The… - [Configure a Box Platform App](https://developer.box.com/guides/mobile/ios/quick-start/configure-box-app.md): Configure a Box Platform App To start making authenticated API calls to the Box API with the Box iOS SDK, an Access Token will be needed… - [Configure Box](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/configure-box.md): Configure Box We will need to set up a Box application to manage Box groups and add collaborators to files and folders in Box. Set up a Box… - [Configure Box](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/configure-box.md): Configure Box Once we have created a login experience with Okta we need to have a Box application available that will permit us to use the… - [Configure Okta](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/configure-okta.md): Configure Okta Our next step in the Okta / Box integration is to create and configure the Okta application and users, then extract a few… - [Configure Slack](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/configure-slack.md): Configure Slack The first step in this guide is to create and configure a Slack application. This Slack application will act as a bot that… - [Connect Bot to Box](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/connect-box-functions.md): Connect Bot to Box We're now handling and processing events coming from Slack, then obtaining all information needed to connect with Box… - [Connect Okta identities to Box App Users in a web app](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users.md): Connect Okta identities to Box App Users in a web app Okta is a popular access management and identity platform used by companies to provide… - [Connect Slack to Box Group Collaborations](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs.md): Connect Slack to Box Group Collaborations Slack is a popular communication and productivity tool, allowing for real-time coordination when… - [Connect SSO identities to app users](https://developer.box.com/guides/sso-identities-and-app-users/connect-identities.md): Connect SSO identities to app users Your SSO service will have a unique user record for each person using it within your company. When… - [Content Explorer](https://developer.box.com/guides/embed/ui-elements/explorer.md): Content Explorer The Box Content Explorer UI Element allows developers to embed a folder view of content stored on Box in their desktop or… - [Content Explorer - metadata view](https://developer.box.com/guides/embed/ui-elements/explorer-metadata.md): Content Explorer - metadata view With Content Explorer you can also display files based on their metadata. The metadata view uses metadata… - [Content Open With](https://developer.box.com/guides/embed/ui-elements/open-with.md): Content Open With We no longer support the OpenWith UI element for any new customers as of December 21, 2021. The Box Content Open With UI… - [Content Picker](https://developer.box.com/guides/embed/ui-elements/picker.md): Content Picker The Box Content Picker UI Element allows developers to add support for selecting files and folders from Box in their desktop… - [Content Preview](https://developer.box.com/guides/embed/ui-elements/preview.md): Content Preview The Box Content Preview UI Element allows developers to embed high quality and interactive previews of Box files in their… - [Content Sidebar](https://developer.box.com/guides/embed/ui-elements/sidebar.md): Content Sidebar The Box Content Sidebar UI Element allows developers to add support for viewing file related metadata (incl. Box Skills) and… - [Content Uploader](https://developer.box.com/guides/embed/ui-elements/uploader.md): Content Uploader The Box Content Uploader UI Element allows developers to embed an upload widget in their desktop or mobile web application… - [Copy a File Request](https://developer.box.com/guides/file-requests/copy.md): Copy a File Request To create a copy of an existing template file request, all you need is its unique ID, and the ID of the folder to apply… - [Copy Folder](https://developer.box.com/guides/folders/single/copy.md): Copy Folder Creates a copy of a folder within a destination folder. The original folder will not be changed. To copy a folder in Box you… - [Create a custom metadata template](https://developer.box.com/guides/metadata/quick-start/create-template.md): Create a custom metadata template To create a custom metadata template for your enterprise you can use our API directly or one of our SDKs… - [Create a metadata cascade policy](https://developer.box.com/guides/metadata/cascades/create.md): Create a metadata cascade policy When a metadata template has been applied to a folder, a metadata cascade policy can be created by calling… - [Create a metadata query](https://developer.box.com/guides/metadata/quick-start/create-query.md): Create a metadata query As a final step, let's look at how you can create a query to find specific files and folders based on the metadata… - [Create a metadata template](https://developer.box.com/guides/metadata/templates/create.md): Create a metadata template To create a metadata template, pass a scope, displayName and an optional set of fields to the POST /metadata… - [Create a Metadata Template](https://developer.box.com/guides/search/quick-start/create-metadata-template.md): Create a Metadata Template There are two ways to create a new metadata template: via the Admin Console or via the API using an Admin Access… - [Create a query](https://developer.box.com/guides/metadata/queries/create.md): Create a query A metadata query is a POST request to the ​/metadata_queries/execute_read- endpoint, in which the body contains all the parts… - [Create a task](https://developer.box.com/guides/tasks/create.md): Create a task To create a task, you will need to provide the POST /tasks API with the action for the task, as well as an item to represent… - [Create a template File Request](https://developer.box.com/guides/file-requests/template.md): Create a template File Request Currently, the API only allows the creation of new file requests by copying an existing file request… - [Create agents](https://developer.box.com/guides/ai-studio/ai-studio-agents/create-agents.md): Create agents Box AI Studio is available only for Enterprise Advanced accounts. The POST /2.0/ai_agents endpoint allows you to create a new… - [Create an iOS App](https://developer.box.com/guides/mobile/ios/quick-start/create-ios-app.md): Create an iOS App Before installing the Box iOS SDK you'll need to have an iOS application available to add the dependencies into. We'll… - [Create App User](https://developer.box.com/guides/users/create-app-user.md): Create App User App Users are programmatic user accounts that may only be created by apps that are using JWT authentication. They are… - [Create Architecture Skeleton](https://developer.box.com/guides/users/provision/architecture.md): Create Architecture Skeleton Our first requirement is to copy general files and folders into each individual user's root folder on account… - [Create Box Sign Request](https://developer.box.com/guides/box-sign/create-sign-request.md): Create Box Sign Request At minimum, to create Box Sign request you need the a file you want to be signed, a destination folder for the… - [Create Comment](https://developer.box.com/guides/comments/create-comment.md): Create Comment To create a comment, call the POST /comments API with the message of the comment, as well as the ID of the file to leave the… - [Create connection between SSO identity and app user](https://developer.box.com/guides/sso-identities-and-app-users/create-app-user.md): Create connection between SSO identity and app user When a user signs in to a custom Box application for the first time using their SSO… - [Create File Preview](https://developer.box.com/guides/embed/box-view/create-preview.md): Create File Preview Once a file is uploaded to an App Token application, it can be previewed using two different methods: Direct embed: A… - [Create Folder](https://developer.box.com/guides/folders/single/create.md): Create Folder To create a folder in Box you will need to provide our API with a name for the new folder, as well as the id of the parent… - [Create Folder Lock](https://developer.box.com/guides/folders/single/create-lock.md): Create Folder Lock To create a lock on a folder in Box you will need to provide our API with the id of the folder for which the lock should… - [Create Managed User](https://developer.box.com/guides/users/create-managed-user.md): Create Managed User To generate a new managed user, the minimal information that will be required will be a name and an email address for… - [Create or Update Shared Link](https://developer.box.com/guides/shared-links/create-or-update.md): Create or Update Shared Link Shared links may be created or directly for file, folder, or web link resources to generate a read-only URL to… - [Create Reply](https://developer.box.com/guides/comments/create-reply.md): Create Reply To create a reply to a previous comment, call the POST /comments API with the message of the new comment, as well as the ID of… - [Create Sign Request with Sign Template](https://developer.box.com/guides/box-sign/sign-templates.md): Create Sign Request with Sign Template The Sign Request API allows you to use a predefined Box Sign template when creating a sign request… - [Create Slack Integration Mapping](https://developer.box.com/guides/integration-mappings/slack-mappings/create-mapping.md): Create Slack Integration Mapping Use the POST integration_mappings/slack/:integration_mapping_id call to create a mapping. To make it work… - [Create Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/create-mappings.md): Create Teams integration mappings Use the POST integration_mappings_teams call to create a mapping. To make it work, you need the box_item… - [Create Upload Session](https://developer.box.com/guides/uploads/chunked/create-session.md): Create Upload Session To create an upload session, call the POST /files/upload_sessions API with the desired file_name and folder_id to put… - [Create Web App Integration](https://developer.box.com/guides/applications/web-app-integrations/configure.md): Create Web App Integration This guide explains how to set up a Web App Integration with a Platform App. Server-side integration is no longer… - [Create Web Link](https://developer.box.com/guides/web-links/create.md): Create Web Link To create a web link in Box, you will need to provide our API with a folder id and the url you want the web link to be… - [Create Webhooks](https://developer.box.com/guides/webhooks/v1/create-v1.md): Create Webhooks V1 webhooks are created in the Developer Console by following the steps below. Navigate to your application in the Developer… - [Create Webhooks](https://developer.box.com/guides/webhooks/v2/create-v2.md): Create Webhooks V2 webhooks can monitor specific files or folders. They can be created in the Developer Console and with API. Developer… - [Create your first application](https://developer.box.com/guides/getting-started/first-application.md): Create your first application Once you have your Developer Enterprise set up, you can start creating applications. Click the Dev Console… - [Cross-Origin Resource Sharing (CORS)](https://developer.box.com/guides/security/cors.md): Cross-Origin Resource Sharing (CORS) Cross-Origin Resource Sharing (CORS) is a security mechanism used by web browsers to prevent malicious… - [Custom Skill](https://developer.box.com/guides/applications/app-types/custom-skills.md): Custom Skill A Custom Skill, or Box Skill is a type of application that performs custom processing for files uploaded to Box. Skills are… - [Custom Skill Approval](https://developer.box.com/guides/authorization/custom-skill-approval.md): Custom Skill Approval Custom Skills will must be enabled on a folder by the enterprise's Box Admin before use. As a developer As the… - [Customize Access](https://developer.box.com/guides/embed/ui-elements/access.md): Customize Access Motivation Box UI Elements are initialized on the client and make API calls directly to Box. Thus, a valid access token… - [Customize Logo](https://developer.box.com/guides/embed/ui-elements/logo.md): Customize Logo Each of the Box UI Elements allow for specifying a custom logo to place in the top-left corner of the embedded container. By… - [Date metadata field](https://developer.box.com/guides/metadata/fields/date.md): Date metadata field A metadata field of type date is displayed to a user as a date picker. Although dates are presented to users in the Box… - [Dedicated Scopes](https://developer.box.com/guides/embed/ui-elements/scopes.md): Dedicated Scopes When working with Box UI Elements many developers have shown interest in being able to implement their own permission model… - [Deep Linking](https://developer.box.com/guides/mobile/mobile-deep-linking.md): Deep Linking Box’s mobile applications support deep linking into folder and file objects. From a web page or native app it is possible to… - [Delete a File Request](https://developer.box.com/guides/file-requests/delete.md): Delete a File Request To delete a file request, all you need is its unique ID. The ID of a file request can be determined by visiting the… - [Delete a metadata cascade policy](https://developer.box.com/guides/metadata/cascades/delete.md): Delete a metadata cascade policy A metadata cascade policy can be deleted by calling the DELETE /metadata_cascade_policies/:id API endpoint… - [Delete a metadata template](https://developer.box.com/guides/metadata/templates/delete.md): Delete a metadata template Deleting a metadata template can be achieved by calling the DELETE /metadata_templates/enterprise/:templateKey… - [Delete a task](https://developer.box.com/guides/tasks/delete.md): Delete a task To remove a task, call the DELETE /tasks/:task_id API with the id of the task. - [Delete AI agent](https://developer.box.com/guides/ai-studio/ai-studio-agents/delete-agents.md): Delete AI agent The DELETE /2.0/ai_agents/{id} endpoint allows you to delete a custom AI agent based on its ID. Send a request To send a… - [Delete Folder](https://developer.box.com/guides/folders/single/delete.md): Delete Folder To remove a folder in Box you will need to provide our API with the ID of the folder. Deleting non-empty folders This API… - [Delete Folder Lock](https://developer.box.com/guides/folders/single/delete-lock.md): Delete Folder Lock To remove a lock applied to a folder in Box, call the DELETE /folder_locks/:id API with the id of the folder lock. Folder… - [Delete Slack Integration Mapping](https://developer.box.com/guides/integration-mappings/slack-mappings/delete-mapping.md): Delete Slack Integration Mapping The DELETE integration_mappings/slack/:integration_mapping_id call removes the mapping between the channel… - [Delete Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/delete-mappings.md): Delete Teams integration mappings The DELETE integration_mappings_teams_id call removes the mapping between the channel and the folder. A… - [Delete User](https://developer.box.com/guides/users/delete-user.md): Delete User The process for deleting both app and managed users is the same. To delete a user account, supply the user ID for the account… - [Delete Web Link](https://developer.box.com/guides/web-links/delete.md): Delete Web Link To remove a web link in Box you will need to provide our API with the ID of the web link. - [Delete Webhooks](https://developer.box.com/guides/webhooks/v1/delete-v1.md): Delete Webhooks V1 webhooks cannot be fully deleted. Instead, the webhook can be set back to Developer Mode by support. Developers can also… - [Delete Webhooks](https://developer.box.com/guides/webhooks/v2/delete-v2.md): Delete Webhooks You can delete a webhook using the Developer Console or API. Developer Console To delete a webhook follow the steps below… - [Deprovision Users](https://developer.box.com/guides/users/deprovision.md): Deprovision Users Part of regular Box enterprise maintenance is removing accounts for users that are no longer active in your enterprise… - [Deprovision users and archive folders](https://developer.box.com/guides/cli/scripts/deprovision-users.md): Deprovision users and archive folders This script allows you to deprovision and delete a list of users. It performs the following steps… - [Developer Tokens](https://developer.box.com/guides/authentication/tokens/developer-tokens.md): Developer Tokens A Developer Token is an Access Token available to developers during development and testing. These tokens are short lived… - [Device Pinners](https://developer.box.com/guides/security/device-pinners.md): Device Pinners Building on the login tracking feature – which allows admins to set limits on the number of devices a user can access Box… - [Direct Uploads](https://developer.box.com/guides/uploads/direct.md): Direct Uploads The most straightforward way to upload a file to Box is using a direct upload. Direct uploads allow an application to upload… - [Download All Files in Folder using SDKs](https://developer.box.com/guides/downloads/folder.md): Download All Files in Folder using SDKs Sometimes an application might want to download all files for a folder. To do so with the SDKs and… - [Download File](https://developer.box.com/guides/downloads/file.md): Download File To download a file, pass the GET /files/:id/content the ID of the file to get the content for. Download URL When not using the… - [Download File Representation](https://developer.box.com/guides/representations/download-a-representation.md): Download File Representation Use theurl_template that was received when selecting the representation to download the representation. Replace… - [Download File Version](https://developer.box.com/guides/downloads/file-version.md): Download File Version To download a specific file version, pass the GET /files/:id/content the ID of the file to get the content for, as… - [Download in Browser](https://developer.box.com/guides/downloads/in-browser.md): Download in Browser Sometimes an application wants to embed a file into a page as a HTML element. An example would be when working with an… - [Download Shared Link](https://developer.box.com/guides/downloads/shared-link.md): Download Shared Link To download the file for a Shared Link, first determine the file for the link. You cannot use the shared link to… - [Download ZIP Archive](https://developer.box.com/guides/downloads/zip-archive.md): Download ZIP Archive To download all files in a folder or an entire folder structure, you have to create and download a ZIP archive. Create… - [Downloads](https://developer.box.com/guides/downloads.md): Downloads The Box API allows for downloading files to the application's server, or directly by the end user in a browser. When not to… - [Downscope a Token](https://developer.box.com/guides/authentication/tokens/downscope.md): Downscope a Token Downscoping is a way to exchange an existing Access Token for a new one that is more restricted. Reasons to downscope An… - [Embed Box](https://developer.box.com/guides/embed.md): Embed Box Box supports a few different ways to embed files and folders straight into your front-end application. - [Embedded Sign client](https://developer.box.com/guides/box-sign/embedded-sign-client.md): Embedded Sign client Box Embed allows you to embed Box Sign features into your own website. This way, users don't have to leave the website… - [Ensure consistency with headers](https://developer.box.com/guides/api-calls/ensure-consistency.md): Ensure consistency with headers Some Box APIs support headers used to ensure consistency between your application and Box. etag, if-match… - [Enterprise Events](https://developer.box.com/guides/events/enterprise-events.md): Enterprise Events Enterprise events provide an event feed for all users and content in an enterprise Box instance. Depending upon the stream… - [Enterprise-wide search](https://developer.box.com/guides/search/enterprise.md): Enterprise-wide search By default, a search is only performed against the content that the authenticated user has access to. In some cases… - [Enum metadata field](https://developer.box.com/guides/metadata/fields/enum.md): Enum metadata field A metadata field of type enum is displayed to a user as a dropdown list. The user can select one item from the list. An… - [Errors](https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors.md): Errors The Box APIs uses HTTP status codes to communicate if a request has been successfully processed or not. Client error Most client… - [Event Source](https://developer.box.com/guides/events/event-triggers/event-source.md): Event Source If a user or item triggers an event, The response of the GET /events endpoint contains an event source object. User Source… - [Event Stream Parameters](https://developer.box.com/guides/events/parameters.md): Event Stream Parameters The GET /events endpoint can take in several parameters. stream_type and stream_position are described in more… - [Event Triggers](https://developer.box.com/guides/events/event-triggers.md): Event Triggers Events appear in the event stream based on upon actions committed by users, items, or other resources. The response of the… - [Events](https://developer.box.com/guides/events.md): Events The event feed provides a way for an application to subscribe to any actions performed by any user, users, or service in an… - [Extract metadata](https://developer.box.com/guides/cli/scripts/metadata-extraction.md): Extract metadata This script extracts metadata details for all the files and folders in any Box folder and saves the result in a CSV… - [Extract metadata from file (freeform)](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata.md): Extract metadata from file (freeform) Box AI API allows you to query a document or image and extract metadata based on a provided prompt… - [Extract metadata from file (structured)](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured.md): Extract metadata from file (structured) With Box AI API, you can extract metadata from the provided file and get the result in the form of… - [FAQ](https://developer.box.com/guides/embed/box-view/faq.md): FAQ How does Box View work? To get started with the New Box View, follow our guide here. Which Preview method, Embed Link or UI Element, is… - [FedRAMP](https://developer.box.com/guides/security/fedramp.md): FedRAMP Overview FedRAMP is a certification program that allows federal agencies to use cloud providers for increasingly secure/sensitive… - [File Requests](https://developer.box.com/guides/file-requests.md): File Requests Box File Request gives you a fast and secure way to request files and associated metadata from anyone. Using a drag-and-drop… - [Files](https://developer.box.com/guides/files.md): Files Files, together with Folders, are at the core of the Box API. Files can be uploaded and downloaded, as well as hold important metadata… - [Filter search results](https://developer.box.com/guides/search/filtering.md): Filter search results The GET /search API supports a variety of different ways to filter the results returned by the API. Filter by content… - [Find app user for SSO identity](https://developer.box.com/guides/sso-identities-and-app-users/find-app-user.md): Find app user for SSO identity When a user logs into a Box platform application with their SSO provider, the first step that should be taken… - [Find Item from Shared Link](https://developer.box.com/guides/shared-links/find-for-item.md): Find Item from Shared Link The find item for shared link API is designed to accept a shared link as an input using a BoxApi header and… - [Find or create Box app users](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/find-or-create-box-users.md): Find or create Box app users At this point we have application code that will handle traffic from users visiting, forward them to Okta to… - [Find Terms for Collaboration](https://developer.box.com/guides/security/terms-of-service/for-colaboration.md): Find Terms for Collaboration Information about the Terms of Service that is in effect for any Collaboration can be inspected by calling the… - [Finding recent shared links](https://developer.box.com/guides/search/shared-links.md): Finding recent shared links By default, the search API only returns items that are either owned by the user or items that the user has been… - [Float metadata field](https://developer.box.com/guides/metadata/fields/float.md): Float metadata field A metadata field of type float is displayed to a user as a standard text-field that only accepts numeric input. Create… - [Flow Actions](https://developer.box.com/guides/tooling/salesforce-toolkit/flow-actions.md): Flow Actions Salesforce toolkit includes wrappers that allow admins to invoke the following methods. It allows Box for Salesforce users to… - [Folders](https://developer.box.com/guides/folders.md): Folders Folders, together with Files, are at the core of the Box API. Folders can be uploaded and downloaded, as well as hold important… - [Force-apply metadata to all items in a folder](https://developer.box.com/guides/metadata/cascades/force-apply.md): Force-apply metadata to all items in a folder When a metadata cascade policy already exists on a folder, the metadata instance can be force… - [Fork a collection](https://developer.box.com/guides/tooling/postman/quick-start/load-postman-collection.md): Fork a collection Now that you are logged in we can fork the Box Postman Collection into the Postman App that we installed previously. When… - [Generate documents](https://developer.box.com/guides/docgen/generate-document.md): Generate documents The POST /2.0/docgen_batches endpoint allows you to generate a document using Box Doc Gen template as input… - [Generate text with Box AI](https://developer.box.com/guides/box-ai/ai-tutorials/generate-text.md): Generate text with Box AI Box AI API is available to all Enterprise Plus and Enterprise Advanced customers. You can use Box AI to generate… - [Get a metadata cascade policy](https://developer.box.com/guides/metadata/cascades/get.md): Get a metadata cascade policy Information for a metadata cascade policy can be retrieved by calling the GET /metadata_cascade_policies/:id… - [Get a metadata template](https://developer.box.com/guides/metadata/templates/get.md): Get a metadata template Information for a metadata template can be retrieved using the template's name and scope, or the template's… - [Get agents](https://developer.box.com/guides/ai-studio/ai-studio-agents/get-agents.md): Get agents Box AI Studio is available only for Enterprise Advanced accounts. List all AI agents The GET /2.0/ai_agents endpoint allows you… - [Get AI agent by ID](https://developer.box.com/guides/ai-studio/ai-studio-agents/get-agent-id.md): Get AI agent by ID The GET /2.0/ai_agents/{id} endpoint allows you to list a specific AI agent by the agent_id parameter. Send a request To… - [Get Basic Thumbnail](https://developer.box.com/guides/representations/thumbnail.md): Get Basic Thumbnail A thumbnail is a small image, either as .png or as .jpg that can be used in an application as a representation of the… - [Get default AI agent configuration](https://developer.box.com/guides/box-ai/ai-agents/get-agent-default-config.md): Get default AI agent configuration The GET /2.0/ai_agent_default endpoint allows you to fetch the default configuration for AI services… - [Get Download URL](https://developer.box.com/guides/downloads/get-url.md): Get Download URL The official Box SDKs return the binary data when downloading a file. To get the download URL for the data instead, use the… - [Get Enterprise Events](https://developer.box.com/guides/events/enterprise-events/for-enterprise.md): Get Enterprise Events To get a enterprise's events, make a call to the GET /events API with the stream_type set to admin_logs or admin_logs… - [Get File Information](https://developer.box.com/guides/files/get.md): Get File Information To get a file's information, not it's content, call the GET /files/:id API with the id of the file. File ID The id for… - [Get Folder Lock](https://developer.box.com/guides/folders/single/get-locks.md): Get Folder Lock To get a list of the current locks on a folder in Box, call the GET /folder_locks/ API with the id of the folder supplied as… - [Get information about a task](https://developer.box.com/guides/tasks/get.md): Get information about a task To get information about an assigned task, call the GET /tasks/:task_id API with the id of the task. - [Get information for a File Request](https://developer.box.com/guides/file-requests/get.md): Get information for a File Request To get details about an existing file request, all you need is its unique ID. The ID of a file request… - [Get Legal Hold Policy](https://developer.box.com/guides/legal-holds/get.md): Get Legal Hold Policy To get the information for a specific Legal Hold policy that has been created in an enterprise, call the GET /legal… - [Get metadata on item](https://developer.box.com/guides/metadata/instances/get.md): Get metadata on item Information about an instance of a metadata template assigned to a file or folder can be retrieved using the item's id… - [Get PDF Representation](https://developer.box.com/guides/representations/pdf.md): Get PDF Representation A PDF representation provides a predictable way to embed documents in mobile and web applications. PDF… - [Get Pending Collaborations](https://developer.box.com/guides/collaborations/pending.md): Get Pending Collaborations To get the pending collaborations for a user, call the GET /collaborations API with a status of pending. This… - [Get Retention Policy](https://developer.box.com/guides/retention-policies/get.md): Get Retention Policy To get the information for a specific Retention Policy that has been created in an enterprise, call the GET /retention… - [Get started with AI studio](https://developer.box.com/guides/ai-studio/getting-started-ai-studio.md): Get started with AI studio Box AI Studio is available only for Enterprise Advanced accounts. To start creating custom AI agents with AI… - [Get started with Box AI](https://developer.box.com/guides/box-ai/ai-tutorials/prerequisites.md): Get started with Box AI To implement Box AI API in your solutions, you need to make sure you have access to the functionality. You will also… - [Get started with Box Doc Gen](https://developer.box.com/guides/docgen/docgen-getting-started.md): Get started with Box Doc Gen To start generating documents with Box Doc Gen API you will need a platform application and a developer token… - [Get task assignment information](https://developer.box.com/guides/tasks/assignments/get.md): Get task assignment information To get information about an assigned task, call the GET /tasks/:task_id/assignments API with the id of the… - [Get Text Representation](https://developer.box.com/guides/representations/text.md): Get Text Representation A text representation provides a way to extract plain text from a document. Text is generated for all document file… - [Get Thumbnail Representation](https://developer.box.com/guides/representations/thumbnail-representation.md): Get Thumbnail Representation A thumbnail is a small image, either as .png or as .jpg that can be used in an application as a representation… - [Get User Events](https://developer.box.com/guides/events/user-events/for-user.md): Get User Events To get a user's events, authenticate as any user and make a call to the GET /events API. The events returned will only be… - [Get Workflows](https://developer.box.com/guides/box-relay/get-workflows.md): Get Workflows The get workflows endpoint can be used to grab all workflows on a particular folder. It will return all workflows regardless… - [Google Gemini 1.5 Flash](https://developer.box.com/guides/box-ai/ai-models/google-gemini-1-5-flash-001-model-card.md): Google Gemini 1.5 Flash Google Gemini 1.5 Flash is a multimodal model designed to handle lightweight tasks. It is designed for high-volume… - [Google Gemini 1.5 Pro 001](https://developer.box.com/guides/box-ai/ai-models/google-gemini-1-5-pro-001-model-card.md): Google Gemini 1.5 Pro 001 Google Gemini 1.5 Pro 001 is a multimodal model designed to handle lightweight tasks. This model mid-size… - [Google Gemini 2.0 Flash](https://developer.box.com/guides/box-ai/ai-models/google-gemini-2-0-flash-001-model-card.md): Google Gemini 2.0 Flash Google Gemini 2.0 Flash is a multimodal model designed for optimal for high-volume, high-frequency tasks at scale… - [Google Gemini 2.0 Flash Lite](https://developer.box.com/guides/box-ai/ai-models/google-gemini-2-0-flash-lite-preview-02-05.md): Google Gemini 2.0 Flash Lite Google Gemini 2.0 Flash Lite is a multimodal model designed to handle lightweight tasks. It is designed for… - [Google Gemini 2.5 Pro](https://developer.box.com/guides/box-ai/ai-models/google-gemini-2-5-pro-model-card.md): Google Gemini 2.5 Pro Google Gemini 2.5 Pro is a multimodal model capable of solving complex problems. It can comprehend vast datasets and… - [Guides](https://developer.box.com/guides.md): Guides - [Handle Skills Payloads](https://developer.box.com/guides/skills/handle.md): Handle Skills Payloads Within the application or site that is set up as your invocation URL you will generally need to perform two tasks… - [Handle Slack Events](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/handle-slack-events.md): Handle Slack Events With the application scaffold in place, the next step is to build the handling and processing functionality for user… - [IBM Llama 3.2 Vision Instruct](https://developer.box.com/guides/box-ai/ai-models/ibm-llama-3-2-90b-vision-instruct-model-card.md): IBM Llama 3.2 Vision Instruct IBM Llama 3.2 Vision Instruct is a model built for image-in, text-out use cases such as document-level… - [IBM Llama 4 Scout](https://developer.box.com/guides/box-ai/ai-models/ibm-llama-4-scout-model-card.md): IBM Llama 4 Scout IBM Llama 4 Scout is an auto-regressive language model that uses a mixture-of-experts (MoE) architecture and incorporates… - [Install .NET SDK (Deprecated)](https://developer.box.com/guides/tooling/sdks/dotnet.md): Install .NET SDK (Deprecated) You can use Box .NET SDK to call Box APIs in a .NET project. .NET SDK is currently in maintenance mode and… - [Install .NET SDK (Generated)](https://developer.box.com/guides/tooling/sdks/dotnet-gen.md): Install .NET SDK (Generated) You can use Box .NET SDK to call Box APIs in a .NET project. The SDK is available for both .NET Framework 4.… - [Install Java SDK](https://developer.box.com/guides/tooling/sdks/java.md): Install Java SDK You can use Box Java SDK to call Box APIs in a Java project. To install Java SDK, add a Gradle dependency or Maven… - [Install Node SDK (Deprecated)](https://developer.box.com/guides/tooling/sdks/node.md): Install Node SDK (Deprecated) You can use Box Node SDK to call Box APIs in a Node project. Node SDK is currently in maintenance mode and… - [Install Postman](https://developer.box.com/guides/tooling/postman/quick-start/install-postman.md): Install Postman To use the Box Postman Collection you will need to have the Postman app installed on your device. Postman is available for… - [Install Postman & Collection](https://developer.box.com/guides/tooling/postman/install.md): Install Postman & Collection To use the Box Postman Collection you will need to have Postman installed on your device. Postman is available… - [Install Python SDK (Deprecated)](https://developer.box.com/guides/tooling/sdks/python.md): Install Python SDK (Deprecated) You can use Box Python SDK to call Box APIs in a Python project. Python SDK is currently in maintenance mode… - [Install Python SDK (Generated)](https://developer.box.com/guides/tooling/sdks/python-gen.md): Install Python SDK (Generated) You can use the auto-generated Box Python SDK to call Box APIs in a Python project. This next generation SDK… - [Install Salesforce SDK](https://developer.box.com/guides/tooling/sdks/salesforce.md): Install Salesforce SDK The Salesforce SDK can be deployed directly to Sandbox or Developer organizations by using the Deploy to Salesforce… - [Install Swift SDK (Generated)](https://developer.box.com/guides/tooling/sdks/swift-gen.md): Install Swift SDK (Generated) You can use Box Swift SDK to call Box APIs in a Swift project. Swift SDK is in a Public Beta phase. Learn more… - [Install the iOS SDK](https://developer.box.com/guides/mobile/ios/quick-start/install-ios-sdk.md): Install the iOS SDK With an iOS application in place, you will need to import the required Box iOS SDK dependencies into your project using… - [Install Typescript SDK (Generated)](https://developer.box.com/guides/tooling/sdks/typescript-gen.md): Install Typescript SDK (Generated) You can use the auto-generated Box TypeScript SDK to call Box APIs in a TypeScript project. This next… - [Installation](https://developer.box.com/guides/embed/ui-elements/installation.md): Installation UI Elements can be used either by downloading the Javascript libraries directly from the Box CDN or by installing our NPM… - [Integration Mappings](https://developer.box.com/guides/integration-mappings.md): Integration Mappings With Integration Mappings, you can manage where content from partner apps is stored in Box. - [Integrations](https://developer.box.com/guides/applications/integrations.md): Integrations Box Integrations is the first place for Box users to find out about applications they can use in combination with Box. If your… - [Integrations Types](https://developer.box.com/guides/applications/web-app-integrations/types.md): Integrations Types Currently, Box provides the Popup integration type. Popup Integrations In a popup integration, Box opens a panel and… - [Invocation URL](https://developer.box.com/guides/skills/invocation-url.md): Invocation URL When creating a new Box Skills application you will be asked to supply an invocation_url. This URL is the public web address… - [iOS](https://developer.box.com/guides/mobile/ios.md): iOS The Box iOS SDK provides native access to the Box API from within your iOS project. - [JWT Auth](https://developer.box.com/guides/authentication/jwt.md): JWT Auth Server-side authentication using JSON Web Tokens (JWT) is the most common way to authenticate to the Box API. JWT is an open… - [JWT with SDKs](https://developer.box.com/guides/authentication/jwt/with-sdk.md): JWT with SDKs The official Box SDKs have built-in support for JWT authentication. This guide will take you through user authentication using… - [JWT without SDKs](https://developer.box.com/guides/authentication/jwt/without-sdk.md): JWT without SDKs This guide takes you through JWT authentication without using a Box SDK. JWT does not require end-user interaction and is… - [Language codes](https://developer.box.com/guides/api-calls/language-codes.md): Language codes The Box API uses a modified version of the ISO 639-1 Language Code to specify a user's language. The following is a list of… - [Learn to use the iOS SDK](https://developer.box.com/guides/mobile/ios/quick-start.md): Learn to use the iOS SDK The Box iOS SDK is a Swift language wrapper for adding the Box API into your iOS project. Requirements To begin… - [Legal Holds](https://developer.box.com/guides/legal-holds.md): Legal Holds A legal hold is a process that an enterprise can use to preserve all forms of potentially relevant information when litigation… - [Limitations](https://developer.box.com/guides/files/limitations.md): Limitations A few limitations exists when working with files. Name restrictions There are some restrictions to a file's name. Names… - [Limitations](https://developer.box.com/guides/metadata/queries/limitations.md): Limitations A few limits apply to the the metadata query APIs. Files and folders ​A metadata query will only return items (files or folders… - [Limitations](https://developer.box.com/guides/webhooks/v2/limitations-v2.md): Limitations One webhook per item There's a limit of one webhook for each item (file or folder), each application and each authenticated user… - [Limited Access App](https://developer.box.com/guides/applications/app-types/limited-access-apps.md): Limited Access App A Limited Access App is used when leveraging Box View or previewing Box content within another application. This type of… - [Limited Access App Approval](https://developer.box.com/guides/authorization/limited-access-approval.md): Limited Access App Approval Limited Access Integrations are automatically authorized for use in an enterprise upon creation. However, if the… - [List a task's assignments](https://developer.box.com/guides/tasks/assignments/list.md): List a task's assignments To list all of the assignments for a specific tasks, call the GET /tasks/:task_id/assignments with the task id. - [List All Legal Hold Policies](https://developer.box.com/guides/legal-holds/list.md): List All Legal Hold Policies To list all Legal Hold Policies that have been created in an enterprise, call the GET /legal_hold_policies API… - [List all metadata on an item](https://developer.box.com/guides/metadata/instances/list.md): List all metadata on an item Metadata instances can be listed for either a file or a folder. List metadata on a file To list all metadata… - [List all metadata templates](https://developer.box.com/guides/metadata/quick-start/list-all.md): List all metadata templates It's likely your enterprise already has a list of metadata templates that you can use right off-the-shelve… - [List all metadata templates](https://developer.box.com/guides/metadata/templates/list.md): List all metadata templates Metadata templates can be listed for either the enterprise or the global scope. List global templates To list… - [List All Representations for File](https://developer.box.com/guides/representations/list-all-representations.md): List All Representations for File To see what representations are available for a file you can call the GET /files/:id endpoint while… - [List All Retention Policies](https://developer.box.com/guides/retention-policies/list.md): List All Retention Policies To list all Retention Policies that have been created in an enterprise, call the GET /retention_policies API… - [List allowed domains for collaboration](https://developer.box.com/guides/collaborations/allowed-domains/list.md): List allowed domains for collaboration Listing the domains that are allowed for collaboration will return all domains that permit… - [List Box Sign Requests](https://developer.box.com/guides/box-sign/list-sign-requests.md): List Box Sign Requests All The get sign requests endpoint can be used to view a list of all Box Sign requests created by the user associated… - [List Items in Collections](https://developer.box.com/guides/collections/list-items.md): List Items in Collections To list all files, folders and web links in a folder call the GET /collections/:id/items API. The only collection… - [List metadata cascade policies](https://developer.box.com/guides/metadata/cascades/list.md): List metadata cascade policies Metadata cascade policies can be listed for a folder by calling the GET /metadata_cascade_policies API… - [List Slack Integration Mappings](https://developer.box.com/guides/integration-mappings/slack-mappings/list-mappings.md): List Slack Integration Mappings Use the GET /integration_mappings/slack call to fetch and filter the mappings, both the ones created… - [List Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/list-mappings.md): List Teams integration mappings Use the GET /integration_mappings/teams call to fetch and filter the mappings, both the ones created… - [List User's Collections](https://developer.box.com/guides/collections/list.md): List User's Collections To list all collections for a user, call the GET /collections API. The only collection that is available via the API… - [List Webhooks for a User](https://developer.box.com/guides/webhooks/v2/list-v2.md): List Webhooks for a User To fetch all webhooks for the authenticated user, use the list all webhooks endpoint. This endpoint requires the… - [Lists all tasks for a file](https://developer.box.com/guides/tasks/for-file.md): Lists all tasks for a file To list all of the tasks for a specific file, call the GET /files/:id/tasks with the id of the file. - [Locate Information about a Metadata Template](https://developer.box.com/guides/search/quick-start/locate-template-info.md): Locate Information about a Metadata Template If you created your metadata template using the API and have the successful response on hand… - [Log in to Box](https://developer.box.com/guides/tooling/postman/quick-start/log-in-to-box.md): Log in to Box In this step, we will use the Client ID and Client Secret from the previous step to log you in and create an Access Token for… - [Logging into the app with Okta](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/logging-into-app.md): Logging into the app with Okta With the Okta, Box, and basic application set up, we can turn our attention to the first step in the… - [Long-Poll Events](https://developer.box.com/guides/events/user-events/polling.md): Long-Poll Events To get real-time notification of activity in a Box account you can use the long poll feature of the OPTIONS /events API… - [Make an API call](https://developer.box.com/guides/tooling/postman/make-api-call.md): Make an API call With the Box Postman Collection loaded into the Postman App it is possible to make API calls to the Box API on behalf of… - [Make an API call](https://developer.box.com/guides/mobile/ios/quick-start/make-api-call.md): Make an API call With our Box and iOS applications created and configured with the Box iOS SDK we can now make our first call to Box APIs… - [Make an API call](https://developer.box.com/guides/tooling/postman/quick-start/make-api-call.md): Make an API call With the Box Postman Collection forked into the Postman App it is now possible to make API calls to the Box API on behalf… - [Make changes to an existing task](https://developer.box.com/guides/tasks/update.md): Make changes to an existing task To update a task in Box you will need to call the PUT /tasks/:task_id API with the ID of the task. This API… - [Manage groups and collaborations](https://developer.box.com/guides/cli/scripts/manage-groups-collaborations.md): Manage groups and collaborations Script structure This script uses Box CLI to create or update groups, add users to them, and finally to… - [Manage Slack integration folder mappings](https://developer.box.com/guides/cli/scripts/slack-integration-mappings.md): Manage Slack integration folder mappings This script helps manage the folder mappings between Slack and Box if using Box as the content… - [Mark file as Box Doc Gen template](https://developer.box.com/guides/docgen/mark-template.md): Mark file as Box Doc Gen template You can mark an existing document as a Box Doc Gen template and use it to generate documents. Before you… - [Marker-based Pagination](https://developer.box.com/guides/api-calls/pagination/marker-based.md): Marker-based Pagination APIs that use marker-based paging use the marker and limit query parameters to paginate through items in a… - [Metadata](https://developer.box.com/guides/metadata.md): Metadata Metadata allows users and applications to define and store custom data associated with files and folders. Metadata consists of key… - [Metadata cascade policies](https://developer.box.com/guides/metadata/cascades.md): Metadata cascade policies A metadata cascade policy describes how metadata instances applied to a folder should be applied to any item… - [Metadata fields](https://developer.box.com/guides/metadata/fields.md): Metadata fields A metadata template field describes a specific piece of data within a metadata template. For example, the ID of an invoice… - [Metadata instances](https://developer.box.com/guides/metadata/instances.md): Metadata instances A metadata instance describes the relation between a metadata template and a file or folder. It includes the values that… - [Metadata queries](https://developer.box.com/guides/metadata/queries.md): Metadata queries A metadata query provides a way to find files and folders by searching for the metadata attached to them. For example, to… - [Metadata Query Filters](https://developer.box.com/guides/search/metadata-filters.md): Metadata Query Filters The GET /search API allows for filtering search results by their associated metadata. A mdfilters query parameter… - [Metadata template scopes](https://developer.box.com/guides/metadata/scopes.md): Metadata template scopes Metadata templates are grouped into two distinct groups, or scopes. global: a group of templates that is available… - [Metadata templates](https://developer.box.com/guides/metadata/templates.md): Metadata templates A metadata template describes a set of key/value pairs that can be assigned to a file or folder. For example, an… - [Methods and Operations](https://developer.box.com/guides/tooling/salesforce-toolkit/methods.md): Methods and Operations Toolkit Details Class Name: box.Toolkit Instance Variables mostRecentError String to indicate the most recent error… - [Migrating From History To Stream](https://developer.box.com/guides/events/enterprise-events/migrate-to-stream.md): Migrating From History To Stream Box recommends that applications subscribing to live events through admin_logs migrate to admin_logs… - [Mobile](https://developer.box.com/guides/mobile.md): Mobile The Box mobile SDKs provide native access to the Box API from within your iOS and Android projects. - [Move Folder](https://developer.box.com/guides/folders/single/move.md): Move Folder To move a folder, update the ID of its parent folder. Operation details This call will return synchronously. This holds true… - [Multi Select metadata field](https://developer.box.com/guides/metadata/fields/multi-select.md): Multi Select metadata field A metadata field of type multiSelect is displayed to a user as a dropdown list. The user can select multiple… - [Next steps](https://developer.box.com/guides/cli/quick-start/next-steps.md): Next steps You've reached the end of this Quick Start guide. By now you should have taken the following steps. Created and configured an… - [Next steps](https://developer.box.com/guides/metadata/quick-start/next-steps.md): Next steps You've reached the end of this Quick Start guide. By now you should have taken the following steps. Listed all templates… - [Next steps](https://developer.box.com/guides/mobile/ios/quick-start/next-steps.md): Next steps You've reached the end of this Quick Start guide. By now you should have taken the following steps. Created a new iOS app in… - [Next steps](https://developer.box.com/guides/tooling/postman/quick-start/next-steps.md): Next steps You've reached the end of this Quick Start guide. By now you should have taken the following steps. Installed Postman on your… - [Next Steps](https://developer.box.com/guides/search/quick-start/next-steps.md): Next Steps You've reached the end of this Quick Start guide. By now you should have taken the following steps. Created a metadata template… - [OAuth 2.0 Auth](https://developer.box.com/guides/authentication/oauth2.md): OAuth 2.0 Auth Client-side OAuth 2.0 is one of the easiest ways to authenticate a user for the Box API. It is an open standard designed to… - [OAuth 2.0 with SDKs](https://developer.box.com/guides/authentication/oauth2/with-sdk.md): OAuth 2.0 with SDKs The Box SDKs have built-in support for client-side OAuth 2.0. In the process a user is redirected to the Box web app in… - [OAuth 2.0 without SDKs](https://developer.box.com/guides/authentication/oauth2/without-sdk.md): OAuth 2.0 without SDKs Overview While leveraging an official Box SDK removes common hurdles of authentication, it is possible to use the Box… - [Offset-based Pagination](https://developer.box.com/guides/api-calls/pagination/offset-based.md): Offset-based Pagination APIs that use offset-based paging use the offset and limit query parameters to paginate through items in a… - [OpenAI GPT o3](https://developer.box.com/guides/box-ai/ai-models/openai-gpt-o3-model-card.md): OpenAI GPT o3 OpenAI GPT o3 is specifically designed to tackle reasoning and problem-solving tasks with increased focus and capability. It… - [Override AI model configuration](https://developer.box.com/guides/box-ai/ai-agents/ai-agent-overrides.md): Override AI model configuration The ai_agent configuration allows you to override the default AI model configuration. It is available for… - [Override AI model configuration](https://developer.box.com/guides/box-ai/ai-tutorials/default-agent-overrides.md): Override AI model configuration Before you start Make sure you followed the steps listed in getting started with Box AI to create a platform… - [Paginate and sort](https://developer.box.com/guides/metadata/queries/pagination.md): Paginate and sort By default only 20 query results are returned per page and the order of these results is not guaranteed and may change… - [Pagination](https://developer.box.com/guides/search/pagination.md): Pagination The search API supports offset-based pagination using the offset and limit query parameters. Marker-based pagination is not… - [Pagination](https://developer.box.com/guides/api-calls/pagination.md): Pagination The Box API supports two ways to paginate collections. The most common way to paginate is through offset-based pagination which… - [Permanently Delete File](https://developer.box.com/guides/trash/permanently-delete-file.md): Permanently Delete File Once a file has been moved to the trash, it will stay in the trash for 30 days by default before being purged… - [Permanently Delete Folder](https://developer.box.com/guides/trash/permanently-delete-folder.md): Permanently Delete Folder Once a folder has been moved to the trash, it will stay in the trash for 30 days by default before being purged… - [Permanently Delete Web Link](https://developer.box.com/guides/trash/permanently-delete-web-link.md): Permanently Delete Web Link Once a web link has been moved to the trash, it will stay in the trash for 30 days by default before being… - [Permissions](https://developer.box.com/guides/security/terms-of-service/permissions.md): Permissions The following is a list of permissions users, admins, and co-admins need to have when working with Terms of Services and Terms… - [Permissions and errors](https://developer.box.com/guides/api-calls/permissions-and-errors.md): Permissions and errors The following guides provide information on the permissions or errors related to the Box API. It includes pages on… - [Platform App](https://developer.box.com/guides/applications/app-types/platform-apps.md): Platform App Platform Apps encompass most use cases and is the most flexible application type. A platform application typically presents Box… - [Platform App Approval](https://developer.box.com/guides/authorization/custom-app-approval.md): Platform App Approval Server authentication applications using JWT or Client Credentials Grant must be authorized by a Box Admin before use… - [Platform App Approval](https://developer.box.com/guides/authorization/platform-app-approval.md): Platform App Approval Server authentication applications using JWT or Client Credentials Grant must be authorized by a Box Admin before use… - [Populate Content](https://developer.box.com/guides/users/provision/populate-content.md): Populate Content Once the architecture files have been defined through the etc/skel structure in your service account, you can now use the… - [Postman Collection](https://developer.box.com/guides/tooling/postman.md): Postman Collection Postman is a tool that lets you build and test HTTP requests in an easy-to-use interface without configuring a full… - [Preflight Check](https://developer.box.com/guides/uploads/check.md): Preflight Check The Pre-flight check API allows an application to verify that a file will be accepted by Box before it uploads any bytes. It… - [Preview - Viewers & Events](https://developer.box.com/guides/embed/ui-elements/viewers-and-events.md): Preview - Viewers & Events This page describes the preview experience for each file type. It also lists the events you can listen for by… - [Provision Users](https://developer.box.com/guides/users/provision.md): Provision Users When setting up a brand new Box user account, a common need is to have that new account be populated with standard folders… - [Provision users and folders](https://developer.box.com/guides/cli/scripts/provision-users-folders.md): Provision users and folders This script uses the Box CLI to build and create a personal folder structure, create managed users in bulk, and… - [Publish your app](https://developer.box.com/guides/getting-started/publish-app.md): Publish your app When you finish the platform app configuration and testing, you can publish it in the Box Integrations. It allows customers… - [Query operators](https://developer.box.com/guides/search/query-operators.md): Query operators The GET /search API supports a variety of different query operators to help refining the results returned by the API. All of… - [Query syntax](https://developer.box.com/guides/metadata/queries/syntax.md): Query syntax The query syntax for the metadata query API is similar to that of a SQL database. To query for all files and folders that match… - [Rate Limits](https://developer.box.com/guides/api-calls/permissions-and-errors/rate-limits.md): Rate Limits There are three common types of API call rate limitations that Box may use at its discretion to best protect network resources… - [Refresh a Token](https://developer.box.com/guides/authentication/tokens/refresh.md): Refresh a Token An Access Token can be refreshed by using the Refresh Token that came with the Access Token. This can be done before or… - [Refresh an Access Token](https://developer.box.com/guides/tooling/postman/refresh.md): Refresh an Access Token To authenticate to the Box API the Postman collection will use an Access Token to identify you, the User to the API… - [Remote Box MCP Server](https://developer.box.com/guides/box-mcp/remote.md): Remote Box MCP Server The remote Box MCP Server allows third party AI systems to securely connect and interact with your content in Box. Box… - [Remove a previously allowed domain for collaboration](https://developer.box.com/guides/collaborations/allowed-domains/delete.md): Remove a previously allowed domain for collaboration Deleting a domain from the list of allowed collaboration domains will remove the… - [Remove Item from Collection](https://developer.box.com/guides/collections/remove.md): Remove Item from Collection To remove an item from a collection, call the PUT endpoint for that specific type of item and pass along a list… - [Remove metadata from an item](https://developer.box.com/guides/metadata/instances/delete.md): Remove metadata from an item Removing an instance of a metadata template assigned to a file or folder can be done using the item's id, and… - [Remove Shared Link](https://developer.box.com/guides/shared-links/remove.md): Remove Shared Link A shared link may be removed from a resource by calling the update file or update folder or update weblink endpoint and… - [Rename Folder](https://developer.box.com/guides/folders/single/rename.md): Rename Folder To rename a folder in Box you will need to provide our API with a new name for the folder. Name restrictions There are some… - [Report inactive users](https://developer.box.com/guides/cli/scripts/report-inactive-users.md): Report inactive users This script generates a CSV file with a list of users who have been inactive for a number of days. It performs the… - [Representations](https://developer.box.com/guides/representations.md): Representations A representation is an alternative asset for a file stored in Box. These assets can be PDFs, thumbnails, or text extractions… - [Request Desired Representation](https://developer.box.com/guides/representations/request-a-representation.md): Request Desired Representation To select a specific representation call the GET /files/:id endpoint with a x-rep-hints-header defining the… - [Request extra fields](https://developer.box.com/guides/api-calls/request-extra-fields.md): Request extra fields The number of fields returned for a resource depends on the API endpoint used to request the resource. Use the fields… - [Requesting extra fields](https://developer.box.com/guides/search/fields.md): Requesting extra fields By default, the search API returns the standard format of a File, Folder, or Web Link. Each of these resources… - [Resend Box Sign Request](https://developer.box.com/guides/box-sign/resend-sign-request.md): Resend Box Sign Request The resend a Box sign request endpoint can be used to resend request emails to any remaining signers. A Box Sign… - [Restore content from Box Archive](https://developer.box.com/guides/archives/restore-content.md): Restore content from Box Archive This guide describes how to restore content that you archived by mistake. Restore file or folder from… - [Restore File](https://developer.box.com/guides/trash/restore-file.md): Restore File To restore a file that has been moved to the trash, but has not yet been purged, make a POST request to the /files/:file_id… - [Restore Folder](https://developer.box.com/guides/trash/restore-folder.md): Restore Folder To restore a folder that has been moved to the trash, but has not yet been purged, make a POST request to the /folders… - [Restore Web Link](https://developer.box.com/guides/trash/restore-web-link.md): Restore Web Link To restore a web link that has been moved to the trash, but has not yet been purged, make a POST request to the /web_links… - [Retention Policies](https://developer.box.com/guides/retention-policies.md): Retention Policies A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention… - [Retrieve an Access Token](https://developer.box.com/guides/tooling/postman/access-token.md): Retrieve an Access Token Every API call requires an Access Token to identify the authenticated user. For security purposes, Access Tokens… - [Revoke a Token](https://developer.box.com/guides/authentication/tokens/revoke.md): Revoke a Token An Access Token can be revoked at any time by either sending the Access Token or Refresh Token the POST /oauth2/revoke… - [Rotating App Tokens](https://developer.box.com/guides/authentication/app-token/rollover.md): Rotating App Tokens By updating one of the application's App Tokens at a time the application can rotate the tokens without running into any… - [Run the application](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/run-the-app.md): Run the application With all the components of the sample in place, it's time to run our program to see if everything is working correctly… - [Salesforce Developer Toolkit](https://developer.box.com/guides/tooling/salesforce-toolkit.md): Salesforce Developer Toolkit The Box for Salesforce Developer Toolkit allows customers to programmatically customize the behavior of the Box… - [Sandboxes in Box Platform](https://developer.box.com/guides/getting-started/sandbox.md): Sandboxes in Box Platform Developer sandboxes in Box provide a secure, controlled environment where developers can build, test, and… - [Scaffold application code](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/scaffold-application-code.md): Scaffold application code With our Slack and Box applications configured, we're ready to write the code for our application which will… - [Scaffold application code](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/scaffold-application-code.md): Scaffold application code Our first step in this guide is to create a local application to house our code and configuration data as we start… - [Scopes](https://developer.box.com/guides/api-calls/permissions-and-errors/scopes.md): Scopes When an application is created in the Developer Console, the user must configure application scopes. Similar to how users have… - [SDKs](https://developer.box.com/guides/tooling/sdks.md): SDKs Box offers a set of SDKs you can use to build your application. The next generation .NET SDK is the newest addition to the set. It is… - [Search](https://developer.box.com/guides/search.md): Search The Box API provides a way to find content in Box using full-text search queries. Support for the Box search API is available in all… - [Search content using metadata](https://developer.box.com/guides/search/quick-start.md): Search content using metadata The Box Metadata Query API enables programmatic search of Box content based strictly on applied custom… - [Search indexing](https://developer.box.com/guides/search/indexing.md): Search indexing Box keeps a search index for any files or folders stored in Box. Every time a file or folder is changed, those words are… - [Searching trash](https://developer.box.com/guides/search/trash.md): Searching trash By default, any content in the user's trash is ignored in the search results. To search the user's trash, the trash_content… - [Security](https://developer.box.com/guides/security.md): Security Whether your are a developer getting started with the Box API or a Box Admin tasked with authorizing applications, it is critical… - [Select App Type](https://developer.box.com/guides/applications/app-types/select.md): Select App Type Upon creating a new Box application in the Developer Console, you must first select one of the following types of… - [Select Auth Method](https://developer.box.com/guides/authentication/select.md): Select Auth Method The type of authorization your application can use depends on the type of Box Application that you've configured in the… - [Self-hosted Box MCP Server](https://developer.box.com/guides/box-mcp/self-hosted.md): Self-hosted Box MCP Server The Self-hosted Box MCP Server is a Python project that integrates with the Box API to perform various operations… - [Setup](https://developer.box.com/guides/embed/box-view/setup.md): Setup Before uploading files to Box and previewing them using Box View, a Box application must be created and an access token be generated… - [Setup](https://developer.box.com/guides/skills/handle/setup.md): Setup Setting up a Custom Skill is a multi-step process. Prerequisites To set up a Platform App using OAuth 2.0 authentication, you will… - [Setup Shared Folders](https://developer.box.com/guides/users/provision/shared-folders.md): Setup Shared Folders As a final step to manage access to shared folders, we'll create the folder structures needed within the service… - [Setup with App Token Auth](https://developer.box.com/guides/authentication/app-token/app-token-setup.md): Setup with App Token Auth A Limited Access App can be set up to use server-side App Tokens for authentication. Learn how App Token… - [Setup with Client Credentials Grant](https://developer.box.com/guides/authentication/client-credentials/client-credentials-setup.md): Setup with Client Credentials Grant Prerequisites To set up a Platform App using server-side authentication, you will need to ensure you… - [Setup with JWT](https://developer.box.com/guides/authentication/jwt/jwt-setup.md): Setup with JWT A Platform App can be set up to use server-side authentication with JWT. Learn how JWT authentication works Prerequisites To… - [Setup with OAuth 2.0](https://developer.box.com/guides/authentication/oauth2/oauth2-setup.md): Setup with OAuth 2.0 A Platform App can be set up to use client-side OAuth 2.0 authentication. Learn how OAuth 2.0 authentication works… - [Share Content with User](https://developer.box.com/guides/collaborations/share-content.md): Share Content with User To share content with a user, create a collaboration using the user ID or email address, the ID of the content, and… - [Shared Link Permissions](https://developer.box.com/guides/shared-links/permissions.md): Shared Link Permissions The shared link resource has three permissions that can be updated using the permissions field: can_preview, can… - [Shared Links](https://developer.box.com/guides/shared-links.md): Shared Links Shared links are URLs that are generated for files, folders, web links stored in Box, which provide direct, read-only access to… - [Sharing with Groups](https://developer.box.com/guides/collaborations/groups.md): Sharing with Groups To share a file or folder with a group of users, create a collaboration using the group ID, the ID of the file or folder… - [Shield Alert Events](https://developer.box.com/guides/events/event-triggers/shield-alert-events.md): Shield Alert Events Box Shield must be purchased and enabled on a Box enterprise to take advantage of the advanced security offerings… - [Shield Information Barrier Events](https://developer.box.com/guides/events/event-triggers/shield-information-barrier-events.md): Shield Information Barrier Events Information barrier prevents exchanges or communication that could lead to conflicts of interest or… - [Shield Smart Access Events](https://developer.box.com/guides/events/event-triggers/shield-smart-access-events.md): Shield Smart Access Events Smart Access enables Box Admins to define and enforce classification-based access policies to control access and… - [Sign Events](https://developer.box.com/guides/events/event-triggers/sign-events.md): Sign Events Audit Box Sign events using the enterprise events stream. To learn more about Box Sign, visit our guide. The status provided… - [Signature Verification](https://developer.box.com/guides/webhooks/v2/signatures-v2.md): Signature Verification Webhook signatures help ensure that a webhook payload was sent by Box and was not tampered with. Signatures greatly… - [Single Folders](https://developer.box.com/guides/folders/single.md): Single Folders The following pages discuss how to do various single folder methods. - [Skills Cards Metadata](https://developer.box.com/guides/skills/handle/metadata.md): Skills Cards Metadata Once a processing service has determined the metadata for the file, your application can write that data back to the… - [Slack Integration Mappings](https://developer.box.com/guides/integration-mappings/slack-mappings.md): Slack Integration Mappings When Box as the Content Layer is enabled, Box folder is created for each channel, and all files uploaded to this… - [Slack Integration Mappings Setup](https://developer.box.com/guides/integration-mappings/slack-mappings/setup.md): Slack Integration Mappings Setup Before starting work with Integration Mappings API, perform the following steps. Roles Make sure you have… - [Slack Integration Mappings Troubleshooting](https://developer.box.com/guides/integration-mappings/slack-mappings/troubleshooting.md): Slack Integration Mappings Troubleshooting As the Integration Mappings API performs different types of validation, some errors might occur… - [Sorting responses](https://developer.box.com/guides/api-calls/sorting.md): Sorting responses Where an API returns a collection of items it often supports sorting of API responses. Use the sort and direction query… - [SSO & App users](https://developer.box.com/guides/sso-identities-and-app-users.md): SSO & App users Single Sign-On (SSO) services are often used as part of a company's Identity and Access Management (IAM) solution. When… - [Start Here](https://developer.box.com/guides/getting-started.md): Start Here Our documentation is divided into five main sections: Learn Box Platform: A getting started walk through of all things Platform… - [Start Workflow](https://developer.box.com/guides/box-relay/start-workflow.md): Start Workflow The start workflow endpoint can be used to start a flow within a workflow of type WORKFLOW_MANUAL_START. Other flow types… - [Status codes](https://developer.box.com/guides/api-calls/status-codes.md): Status codes The following rules can be applied to interpret the HTTP status codes received when using the Box API. HTTP Status 200-299 Box… - [Stream Position Pagination](https://developer.box.com/guides/events/parameters/pagination.md): Stream Position Pagination Paginating the event stream works through the use of the stream_position parameter. First, send a request to the… - [Stream Types](https://developer.box.com/guides/events/parameters/stream-types.md): Stream Types Stream Types Scope Purpose Description Retention Access Pattern admin_logs A single enterprise (for authorized admins… - [String metadata field](https://developer.box.com/guides/metadata/fields/string.md): String metadata field A metadata field of type string is displayed to a user as a standard text-field. Create a string field A string field… - [Supported AI models](https://developer.box.com/guides/box-ai/ai-models.md): Supported AI models Box supports a variety of AI models, categorized along two dimensions: access level and capability tier. Access Levels… - [Supported APIs for Box Archive](https://developer.box.com/guides/archives/supported-apis.md): Supported APIs for Box Archive The basic Box Archive APIs allow you to create, list and delete archives, but you can use other APIs to… - [Supported Endpoints](https://developer.box.com/guides/authentication/app-token/endpoints.md): Supported Endpoints App Token authentication currently only supports a handful of the BOX API. Endpoint Path Create a folder POST /folders… - [Supported File Types](https://developer.box.com/guides/representations/supported-file-types.md): Supported File Types The following file types are supported by the representation API. 3D Graphics and Modeling Files File Type PDF Support… - [Suppress default Box Sign notifications](https://developer.box.com/guides/box-sign/suppress-sign-notifications.md): Suppress default Box Sign notifications Box Sign API allows you to suppress the default Box email notifications sent during the Sign… - [Suppress notifications](https://developer.box.com/guides/api-calls/suppress-notifications.md): Suppress notifications For some API calls, you can block email and webhook notifications by including a box-notifications: off header with… - [Tasks](https://developer.box.com/guides/tasks.md): Tasks Tasks allow users to request collaborators on a file to review a file or complete a piece of work. Tasks can be used by developers to… - [Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings.md): Teams integration mappings Before you can start working with Teams integration mapping API, perform the steps below. Prerequisites Admin or… - [Terms of Service](https://developer.box.com/guides/security/terms-of-service.md): Terms of Service The Box API allows administrators to configure Terms of Services for working on Box, and for users to accept & re-accept… - [Test the bot](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/test-bot.md): Test the bot In this last section we'll test the full range of functionality of the Slack bot. Group creation: When a bot is added to a… - [Theming & styling for Box UI Elements](https://developer.box.com/guides/embed/ui-elements/theming-styling.md): Theming & styling for Box UI Elements With theming & styling for Box UI Elements you can customize the look of the embedded Box component to… - [Token & URL Expiration](https://developer.box.com/guides/api-calls/permissions-and-errors/expiration.md): Token & URL Expiration Across the Box API there are a few tokens, codes, and URLs that automatically expire. The following is a quick… - [Tokens](https://developer.box.com/guides/authentication/tokens.md): Tokens At the core of every Box API call is an Access Token. Similar to using the Box Web App, you will only be able to successfully… - [Tooling](https://developer.box.com/guides/tooling.md): Tooling Box offers several options for using our APIs, including the Box CLI, Postman, Salesforce Developer Toolkit, and various SDKs. - [Transfer Files & Folders](https://developer.box.com/guides/users/deprovision/transfer-folders.md): Transfer Files & Folders As part of user account deprovisioning, a common requirement is to transfer all files and folders that are stored… - [Trash](https://developer.box.com/guides/trash.md): Trash Before items are deleted they might end up in a user's trash. The trash can be managed by a user through any of the Box apps, and by… - [Types and formats](https://developer.box.com/guides/api-calls/types-and-formats.md): Types and formats The following sections explain some basic concepts about the types and formats that can be encountered within the Box APIs… - [UI Elements](https://developer.box.com/guides/embed/ui-elements.md): UI Elements Box UI Elements are pre-built UI components that allow developers to add elements of the main Box web application into their own… - [UI Elements design tokens](https://developer.box.com/guides/embed/ui-elements/ui-elements-design-tokens.md): UI Elements design tokens This table shows all the design tokens you can use for theming and styling purposes. Provided default values and… - [UI Elements in Salesforce](https://developer.box.com/guides/tooling/salesforce-toolkit/ui-elements.md): UI Elements in Salesforce The Box for Salesforce managed package offers the following UI Elements as Lightning Components: content picker… - [Unassign a task](https://developer.box.com/guides/tasks/assignments/unassign.md): Unassign a task To unassign a task, you will need to provide the DELETE /task_assignments API with the id of the task assignment… - [Update a File Request](https://developer.box.com/guides/file-requests/update.md): Update a File Request To update some of the basic details for an existing file request, all you need is its unique ID. For more details on… - [Update a metadata template](https://developer.box.com/guides/metadata/quick-start/update-template.md): Update a metadata template Let's look at how we can update an existing metadata template. Updates to metadata templates are performed… - [Update a metadata template](https://developer.box.com/guides/metadata/templates/update.md): Update a metadata template Updating a metadata template can be achieved by passing an array of operations to the PUT /metadata_templates… - [Update AI agent](https://developer.box.com/guides/ai-studio/ai-studio-agents/update-agents.md): Update AI agent The PUT /2.0/ai_agents/{id} endpoint allows you to update a custom AI agent based on its ID. Send a request To send a… - [Update Folder](https://developer.box.com/guides/folders/single/update.md): Update Folder To update a folder in Box you will need to call the following API. Name restrictions There are some restrictions to the folder… - [Update metadata on a file](https://developer.box.com/guides/metadata/quick-start/update-instance.md): Update metadata on a file Once metadata has been applied to a file or folder there is often a need to update the metadata at a later date… - [Update metadata on an item](https://developer.box.com/guides/metadata/instances/update.md): Update metadata on an item Updating the metadata applied to a file or folder can be done by using the item's id, the template's templateKey… - [Update Slack Integration Mapping](https://developer.box.com/guides/integration-mappings/slack-mappings/update-mapping.md): Update Slack Integration Mapping Use the PUT integration_mappings/slack/:integration_mapping_id call to update the existing mapping or the… - [Update Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/update-mappings.md): Update Teams integration mappings Use the PUT integration_mappings_teams_id call to update the existing mapping of the target Box folder. - [Update user zones](https://developer.box.com/guides/cli/scripts/user-zones-mass-update.md): Update user zones This script provisions users to a specific data residency zone within a Multizone Box tenant. It performs the following… - [Update Webhooks](https://developer.box.com/guides/webhooks/v2/update-v2.md): Update Webhooks You can update a webhook using the Developer Console or API. Developer Console To update a webhook in the Developer Console… - [Upload All Files in Folder](https://developer.box.com/guides/uploads/chunked/folder.md): Upload All Files in Folder Sometimes an application might want to upload all files from a folder. To do so with the SDKs and the CLI… - [Upload File Version](https://developer.box.com/guides/uploads/direct/file-version.md): Upload File Version To upload a new version of a file to Box via direct upload, make an API call to the POST /files/:id/content API with the… - [Upload Files](https://developer.box.com/guides/embed/box-view/upload-file.md): Upload Files To generate a preview embed link for a file, the file must be uploaded to Box. For most file types, conversion is triggered… - [Upload New File](https://developer.box.com/guides/uploads/direct/file.md): Upload New File To upload a file to Box via direct upload, make an API call to the POST /files/content API with the content of the file, the… - [Upload Part](https://developer.box.com/guides/uploads/chunked/upload-part.md): Upload Part When you want to upload a large file, you can split it into smaller parts and upload them using the Upload Part API. Create… - [Uploads](https://developer.box.com/guides/uploads.md): Uploads The Box API supports two distinct methods of file upload. The direct file upload API supports files up to 50MB in size and sends all… - [Use a Token](https://developer.box.com/guides/authentication/tokens/api-calls.md): Use a Token Every authenticated API call requires an Access Token to be passed in the Authorization header as a Bearer Token or it will… - [Use Box CLI with OAuth 2.0](https://developer.box.com/guides/cli/quick-start.md): Use Box CLI with OAuth 2.0 The Box CLI is a user-friendly command line tool which allows both technical and non-technical users to leverage… - [Use Postman to make API calls](https://developer.box.com/guides/tooling/postman/quick-start.md): Use Postman to make API calls Postman is a tool that lets you build and test HTTP requests in an easy-to-use interface without configuring a… - [Use the Metadata Query API](https://developer.box.com/guides/search/quick-start/metadata-query-api.md): Use the Metadata Query API Finally, build a metadata query API call. Here is an example of what the body of the API call looks like: This… - [User Access Token](https://developer.box.com/guides/authentication/jwt/user-access-tokens.md): User Access Token It is possible for a JWT application to create an Access Token for a specific user instead of for the Service Account… - [User Events](https://developer.box.com/guides/events/user-events.md): User Events User Events provides a low latency stream of events relevant to the currently authenticated user. This event stream is how Box… - [User Experience](https://developer.box.com/guides/applications/web-app-integrations/user-experience.md): User Experience The following explains what a Web App Integration looks like from a user's point of view. Box users can discover… - [Users](https://developer.box.com/guides/users.md): Users The Box API supports a variety of users, ranging from real employees logging in with their Managed User account, to applications using… - [Using in SDKs](https://developer.box.com/guides/authentication/tokens/sdks.md): Using in SDKs The SDKs have direct support for JWT and OAuth 2.0 authentication, yet in some cases your application might need to provide an… - [Using Options and Bulk Commands](https://developer.box.com/guides/cli/quick-start/options-and-bulk-commands.md): Using Options and Bulk Commands Options Options provide additional, optional functionality to use with a CLI command. You may also hear… - [Using PowerShell Scripts with the Box CLI](https://developer.box.com/guides/cli/quick-start/powershell-script-templates.md): Using PowerShell Scripts with the Box CLI By itself, the CLI is already powerful, but using it alongside a PowerShell script lets you… - [V1 Webhooks](https://developer.box.com/guides/webhooks/v1.md): V1 Webhooks Webhooks created using the Developer Console monitor changes to all files and folders within a user's account. When creating one… - [V2 Webhooks](https://developer.box.com/guides/webhooks/v2.md): V2 Webhooks Flow When an event triggers a webhook for a file or a folder, it makes a HTTP call to the address specified when the webhook… - [Versioning errors](https://developer.box.com/guides/api-calls/permissions-and-errors/versioning-errors.md): Versioning errors Box provides versioning capabilities for selected API endpoints. The version control system guarantees seamless… - [Web App Integration](https://developer.box.com/guides/applications/web-app-integrations.md): Web App Integration Web App Integrations allow third-party applications to become part of the Box user experience by allowing users to use… - [Web Links](https://developer.box.com/guides/web-links.md): Web Links Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web Links are… - [Webhook Event Triggers](https://developer.box.com/guides/webhooks/triggers.md): Webhook Event Triggers V2 Files and Folders The following is a list of events that can be configured to trigger a V2 webhook. Some events… - [Webhooks](https://developer.box.com/guides/webhooks.md): Webhooks Webhooks allow you to monitor Box content for events, and receive notifications to a URL of your choice when they occur. For… - [Working with Metadata](https://developer.box.com/guides/metadata/quick-start.md): Working with Metadata The Metadata APIs are a great tool to allow applications to automatically add additional information to files and… - [xAI Grok 3 Beta](https://developer.box.com/guides/box-ai/ai-models/xai-grok-3-beta-model-card.md): xAI Grok 3 Beta xAI Grok 3 Beta is a model that excels at enterprise use cases like data extraction, coding, and text summarization… - [xAI Grok 3 Mini Reasoning Beta](https://developer.box.com/guides/box-ai/ai-models/xai-grok-3-mini-beta-model-card.md): xAI Grok 3 Mini Reasoning Beta xAI Grok 3 Mini Reasoning Beta is a lightweight model that thinks before responding. Fast, smart, and great… ## API Reference - [Access token](): A token that can be used to make authenticated API calls. - [Add changed status of shield information barrier with specified ID](https://developer.box.com/reference/post-shield-information-barriers-change-status.md) - [Add classification](https://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--add.md) - [Add classification to file](https://developer.box.com/reference/post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo.md) - [Add classification to folder](https://developer.box.com/reference/post-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo.md) - [Add domain to list of allowed collaboration domains](https://developer.box.com/reference/post-collaboration-whitelist-entries.md) - [Add initial classifications](https://developer.box.com/reference/post-metadata-templates-schema--classifications.md) - [Add or update user avatar](https://developer.box.com/reference/post-users-id-avatar.md) - [Add shared link to file](https://developer.box.com/reference/put-files-id--add-shared-link.md) - [Add shared link to folder](https://developer.box.com/reference/put-folders-id--add-shared-link.md) - [Add shared link to web link](https://developer.box.com/reference/put-web-links-id--add-shared-link.md) - [Add user to group](https://developer.box.com/reference/post-group-memberships.md) - [AI agent](): Standard representation of an AI Agent instance. - [AI agent (Full)](): Full representation of an AI Agent instance. - [AI agent capability ask](): The AI agent to be used to ask questions. - [AI agent capability ask request](): The AI agent to be used to handle queries. - [AI agent capability extract](): The AI agent to be used for metadata extraction. - [AI agent capability extract request](): The AI agent to be used for metadata extraction. - [AI agent capability text generation](): The AI agent to be used to generate text. - [AI agent capability text generation request](): The AI agent to be used to generate text. - [AI agent for extract requests](): The AI agent to be used for extraction. - [AI agent for question requests](): The AI agent used to handle queries. - [AI agent for structured extract request](): The AI agent to be used for structured extraction. - [AI agent for text generation requests](): The AI agent used for generating text. - [AI agent reference](): The AI agent used to handle queries. - [AI agents list](): List of AI Agents with pagination. - [AI extract response](): AI extract response. The content of this response may vary depending on the requested configuration. - [AI extract structured response](): AI extract structured response. - [AI LLM endpoint params AWS](): AI LLM endpoint params AWS object. - [AI LLM endpoint params Google](): AI LLM endpoint params Google object. - [AI LLM endpoint params IBM](): AI LLM endpoint params IBM object. - [AI LLM endpoint params OpenAI](): AI LLM endpoint params OpenAI object. - [AI response](): AI response. - [AI response (Full)](): AI ask response. - [Allowed collaboration domain](): An entry that describes an approved domain for which users can collaborate with files and folders in your enterprise or vice versa. - [Allowed collaboration domains](): A list of allowed domains for collaboration. - [Allowed collaboration domains user exemption](): The user that is exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise. - [Allowed collaboration domains user exemptions](): A list of users exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise. - [App item](): An app item represents an content object owned by an application. It can group files and folders together from different paths. That set can be shared via a collaboration. - [App item association](): An app item association represents an association between a file or folder and an app item. Associations between a folder and an app item cascade down to all descendants of the folder. - [App item associations](): A list of app item associations. - [AppItem event source](): The AppItem that triggered an event in the event stream. - [Apply watermark to file](https://developer.box.com/reference/put-files-id-watermark.md) - [Apply watermark to folder](https://developer.box.com/reference/put-folders-id-watermark.md) - [Archive](): An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is not accessible to its owner and collaborators. To use this feature, you must request GCM scope for your Box application. - [Archives](): A list of archives. - [Ask question](https://developer.box.com/reference/post-ai-ask.md) - [Assign legal hold policy](https://developer.box.com/reference/post-legal-hold-policy-assignments.md) - [Assign retention policy](https://developer.box.com/reference/post-retention-policy-assignments.md) - [Assign storage policy](https://developer.box.com/reference/post-storage-policy-assignments.md) - [Assign task](https://developer.box.com/reference/post-task-assignments.md) - [Authorize user](https://developer.box.com/reference/get-authorize.md) - [Box Doc Gen batch (Base)](): The basic representation of a Box Doc Gen batch object. A Box Doc Gen batch contains one or more Box Doc Gen jobs. - [Box Doc Gen job](): A standard representation of a Box Doc Gen job. - [Box Doc Gen job (Base)](): The basic representation of a Box Doc Gen job. - [Box Doc Gen job (Full)](): A full representation of a Box Doc Gen job. - [Box Doc Gen jobs](): A list of Box Doc Gen jobs with a standard set of parameters. - [Box Doc Gen jobs (Full)](): A list of Box Doc Gen jobs with a full set of parameters. - [Box Doc Gen tags](): A list of Box Doc Gen tags. - [Box Doc Gen tags processing message](): A message informing the user that document tags are still being processed. - [Box Doc Gen template](): A Box Doc Gen template object. - [Box Doc Gen template (Base)](): A base representation of a Box Doc Gen template, used when nested within another resource. - [Box Doc Gen template tag](): A Box Doc Gen template tag object. - [Box Doc Gen templates](): List of Box Doc Gen templates. - [Box Sign request](): A Box Sign request object. - [Box Sign requests](): A standard representation of a signature request, as returned from any Box Sign API endpoints by default. - [Box Sign template](): A Box Sign template object. - [Box Sign templates](): A list of templates, as returned from any Box Sign API endpoints by default. - [Cancel Box Sign request](https://developer.box.com/reference/post-sign-requests-id-cancel.md) - [Classification](): An instance of the classification metadata template, containing the classification applied to the file or folder. To get more details about the classification applied to an item, request the classification metadata template. - [Classification Template](): A metadata template that holds the security classifications defined by an enterprise. - [Client error](): A generic error. - [Client error](): A generic error. - [Collaboration](): Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or group access to a file or folder with permissions defined by a specific role. - [Collaborations](): A list of collaborations. - [Collaborations](): A list of collaborations. - [Collection](): A collection of items, including files and folders. Currently, the only collection available is the `favorites` collection. The contents of a collection can be explored in a similar way to which the contents of a folder is explored. - [Collections](): A list of collections. - [Comment](): Standard representation of a comment. - [Comment (Base)](): Base representation of a comment. - [Comment (Full)](): Comments are messages created on files. Comments can be made independently or created as responses to other comments. - [Comments](): A list of comments. - [Commit upload session](https://developer.box.com/reference/post-files-upload-sessions-id-commit.md) - [Conflict error](): The error that occurs when a file can not be created due to a conflict. - [Copy file](https://developer.box.com/reference/post-files-id-copy.md) - [Copy file request](https://developer.box.com/reference/post-file-requests-id-copy.md) - [Copy folder](https://developer.box.com/reference/post-folders-id-copy.md) - [Copy hub](https://developer.box.com/reference/v2025.0/post-hubs-id-copy.md) - [Create a Box Sign request](): Creates a Box Sign request object. - [Create AI agent](https://developer.box.com/reference/post-ai-agents.md) - [Create archive](https://developer.box.com/reference/v2025.0/post-archives.md) - [Create Box Doc Gen template](https://developer.box.com/reference/v2025.0/post-docgen-templates.md) - [Create Box Sign request](https://developer.box.com/reference/post-sign-requests.md) - [Create Box Skill cards on file](https://developer.box.com/reference/post-files-id-metadata-global-boxSkillsCards.md) - [Create collaboration](https://developer.box.com/reference/post-collaborations.md) - [Create comment](https://developer.box.com/reference/post-comments.md) - [Create email alias](https://developer.box.com/reference/post-users-id-email-aliases.md) - [Create folder](https://developer.box.com/reference/post-folders.md) - [Create folder lock](https://developer.box.com/reference/post-folder-locks.md) - [Create group](https://developer.box.com/reference/post-groups.md) - [Create hub](https://developer.box.com/reference/v2025.0/post-hubs.md) - [Create hub collaboration](https://developer.box.com/reference/v2025.0/post-hub-collaborations.md) - [Create jobs to terminate user group session](https://developer.box.com/reference/post-groups-terminate-sessions.md) - [Create jobs to terminate users session](https://developer.box.com/reference/post-users-terminate-sessions.md) - [Create legal hold policy](https://developer.box.com/reference/post-legal-hold-policies.md) - [Create metadata cascade policy](https://developer.box.com/reference/post-metadata-cascade-policies.md) - [Create metadata instance on file](https://developer.box.com/reference/post-files-id-metadata-id-id.md) - [Create metadata instance on folder](https://developer.box.com/reference/post-folders-id-metadata-id-id.md) - [Create metadata template](https://developer.box.com/reference/post-metadata-templates-schema.md) - [Create retention policy](https://developer.box.com/reference/post-retention-policies.md) - [Create shield information barrier](https://developer.box.com/reference/post-shield-information-barriers.md) - [Create shield information barrier report](https://developer.box.com/reference/post-shield-information-barrier-reports.md) - [Create shield information barrier segment](https://developer.box.com/reference/post-shield-information-barrier-segments.md) - [Create shield information barrier segment member](https://developer.box.com/reference/post-shield-information-barrier-segment-members.md) - [Create shield information barrier segment restriction](https://developer.box.com/reference/post-shield-information-barrier-segment-restrictions.md) - [Create shield list](https://developer.box.com/reference/v2025.0/post-shield-lists.md) - [Create Slack integration mapping](https://developer.box.com/reference/post-integration-mappings-slack.md) - [Create Slack integration mapping request](): A request to create a Slack Integration Mapping object. - [Create task](https://developer.box.com/reference/post-tasks.md) - [Create Teams integration mapping](https://developer.box.com/reference/post-integration-mappings-teams.md) - [Create teams integration mapping request](): A request to create a Teams Integration Mapping object. - [Create terms of service](https://developer.box.com/reference/post-terms-of-services.md) - [Create terms of service status for new user](https://developer.box.com/reference/post-terms-of-service-user-statuses.md) - [Create upload session](https://developer.box.com/reference/post-files-upload-sessions.md) - [Create upload session for existing file](https://developer.box.com/reference/post-files-id-upload-sessions.md) - [Create user](https://developer.box.com/reference/post-users.md) - [Create user exemption from collaboration domain restrictions](https://developer.box.com/reference/post-collaboration-whitelist-exempt-targets.md) - [Create user invite](https://developer.box.com/reference/post-invites.md) - [Create web link](https://developer.box.com/reference/post-web-links.md) - [Create webhook](https://developer.box.com/reference/post-webhooks.md) - [Create zip download](https://developer.box.com/reference/post-zip-downloads.md) - [Delete AI agent](https://developer.box.com/reference/delete-ai-agents-id.md) - [Delete archive](https://developer.box.com/reference/v2025.0/delete-archives-id.md) - [Delete Box Doc Gen template](https://developer.box.com/reference/v2025.0/delete-docgen-templates-id.md) - [Delete file](https://developer.box.com/reference/delete-files-id.md) - [Delete file request](https://developer.box.com/reference/delete-file-requests-id.md) - [Delete folder](https://developer.box.com/reference/delete-folders-id.md) - [Delete folder lock](https://developer.box.com/reference/delete-folder-locks-id.md) - [Delete hub](https://developer.box.com/reference/v2025.0/delete-hubs-id.md) - [Delete retention policy](https://developer.box.com/reference/delete-retention-policies-id.md) - [Delete shield information barrier segment](https://developer.box.com/reference/delete-shield-information-barrier-segments-id.md) - [Delete shield information barrier segment member by ID](https://developer.box.com/reference/delete-shield-information-barrier-segment-members-id.md) - [Delete shield information barrier segment restriction by ID](https://developer.box.com/reference/delete-shield-information-barrier-segment-restrictions-id.md) - [Delete single shield list by shield list id](https://developer.box.com/reference/v2025.0/delete-shield-lists-id.md) - [Delete Slack integration mapping](https://developer.box.com/reference/delete-integration-mappings-slack-id.md) - [Delete Teams integration mapping](https://developer.box.com/reference/delete-integration-mappings-teams-id.md) - [Delete user](https://developer.box.com/reference/delete-users-id.md) - [Delete user avatar](https://developer.box.com/reference/delete-users-id-avatar.md) - [Device pinner](): Device pins allow enterprises to control what devices can use native Box applications. - [Device pinners](): A list of device pins. - [Download file](https://developer.box.com/reference/get-files-id-content.md) - [Download zip archive](https://developer.box.com/reference/get-zip-downloads-id-content.md) - [Email alias](): An email alias for a user. - [Email aliases](): A list of email aliases. - [Enterprise (Base)](): A mini representation of a enterprise, used when nested within another resource. - [Event](): The description of an event that happened within Box. - [Event source](): The source file or folder that triggered an event in the event stream. - [Events](): A list of event objects. - [Extract metadata (freeform)](https://developer.box.com/reference/post-ai-extract.md) - [Extract metadata (structured)](https://developer.box.com/reference/post-ai-extract-structured.md) - [File](): A standard representation of a file, as returned from any file API endpoints by default. - [File (Base)](): The bare basic representation of a file, the minimal amount of fields returned when using the `fields` query parameter. - [File (Conflict)](): A representation of a file that is used to show. - [File (Full)](): A full representation of a file, as can be returned from any file API endpoints by default. - [File (Mini)](): A mini representation of a file, used when nested under another resource. - [File Request](): A standard representation of a file request, as returned from any file request API endpoints by default. - [File version](): A standard representation of a file version. - [File version (Base)](): The bare basic representation of a file version, the minimal amount of fields returned when using the `fields` query parameter. - [File version (Full)](): A full representation of a file version, as can be returned from any file version API endpoints by default. - [File version (Mini)](): A mini representation of a file version, used when nested within another resource. - [File version legal hold](): File version legal hold is an entity representing all holds on a File Version. - [File version legal holds](): A list of file versions with legal holds. - [File version retention](): A retention policy blocks permanent deletion of content for a specified amount of time. Admins can apply policies to specified folders, or an entire enterprise. A file version retention is a record for a retained file version. To use this feature, you must have the manage retention policies scope enabled for your API key in your application management console. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints. - [File version retentions](): A list of file version retentions. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints. - [File versions](): A list of file versions. - [File versions on hold](): A list of files on hold for legal policy assignment. - [Files](): A list of files. - [Files on hold](): A list of files on hold for legal policy assignment. - [Files under retention](): A list of files under retention. - [Find app item for shared link](https://developer.box.com/reference/get-shared-items--app-items.md) - [Find file for shared link](https://developer.box.com/reference/get-shared-items.md) - [Find folder for shared link](https://developer.box.com/reference/get-shared-items--folders.md) - [Find metadata template by instance ID](https://developer.box.com/reference/get-metadata-templates.md) - [Find web link for shared link](https://developer.box.com/reference/get-shared-items--web-links.md) - [Folder](): A standard representation of a folder, as returned from any folder API endpoints by default. - [Folder (Base)](): The bare basic representation of a folder, the minimal amount of fields returned when using the `fields` query parameter. - [Folder (Full)](): A full representation of a folder, as can be returned from any folder API endpoints by default. - [Folder (Mini)](): A mini representation of a file version, used when nested under another resource. - [Folder Lock](): Folder locks define access restrictions placed by folder owners to prevent specific folders from being moved or deleted. - [Folder Locks](): A list of folder locks. - [Force-apply metadata cascade policy to folder](https://developer.box.com/reference/post-metadata-cascade-policies-id-apply.md) - [Generate document using Box Doc Gen template](https://developer.box.com/reference/v2025.0/post-docgen-batches.md) - [Generate text](https://developer.box.com/reference/post-ai-text-gen.md) - [Generic source](): A generic event source type. - [Get AI agent by agent ID](https://developer.box.com/reference/get-ai-agents-id.md) - [Get AI agent default configuration](https://developer.box.com/reference/get-ai-agent-default.md) - [Get all shield lists in enterprise](https://developer.box.com/reference/v2025.0/get-shield-lists.md) - [Get allowed collaboration domain](https://developer.box.com/reference/get-collaboration-whitelist-entries-id.md) - [Get Box Doc Gen job by ID](https://developer.box.com/reference/v2025.0/get-docgen-jobs-id.md) - [Get Box Doc Gen jobs by batch ID](https://developer.box.com/reference/v2025.0/get-docgen-batch-jobs-id.md) - [Get Box Doc Gen template by ID](https://developer.box.com/reference/v2025.0/get-docgen-templates-id.md) - [Get Box Sign request by ID](https://developer.box.com/reference/get-sign-requests-id.md) - [Get Box Sign template by ID](https://developer.box.com/reference/get-sign-templates-id.md) - [Get classification on file](https://developer.box.com/reference/get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo.md) - [Get classification on folder](https://developer.box.com/reference/get-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo.md) - [Get collaboration](https://developer.box.com/reference/get-collaborations-id.md) - [Get collection by ID](https://developer.box.com/reference/get-collections-id.md) - [Get comment](https://developer.box.com/reference/get-comments-id.md) - [Get current user](https://developer.box.com/reference/get-users-me.md) - [Get device pin](https://developer.box.com/reference/get-device-pinners-id.md) - [Get events long poll endpoint](https://developer.box.com/reference/options-events.md) - [Get file information](https://developer.box.com/reference/get-files-id.md) - [Get file request](https://developer.box.com/reference/get-file-requests-id.md) - [Get file thumbnail](https://developer.box.com/reference/get-files-id-thumbnail-id.md) - [Get file version](https://developer.box.com/reference/get-files-id-versions-id.md) - [Get file version legal hold](https://developer.box.com/reference/get-file-version-legal-holds-id.md) - [Get file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention.md) - [Get files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention.md) - [Get folder information](https://developer.box.com/reference/get-folders-id.md) - [Get group](https://developer.box.com/reference/get-groups-id.md) - [Get group membership](https://developer.box.com/reference/get-group-memberships-id.md) - [Get hub collaboration by collaboration ID](https://developer.box.com/reference/v2025.0/get-hub-collaborations-id.md) - [Get hub collaborations](https://developer.box.com/reference/v2025.0/get-hub-collaborations.md) - [Get hub information by ID](https://developer.box.com/reference/v2025.0/get-hubs-id.md) - [Get hub items](https://developer.box.com/reference/v2025.0/get-hub-items.md) - [Get legal hold policy](https://developer.box.com/reference/get-legal-hold-policies-id.md) - [Get legal hold policy assignment](https://developer.box.com/reference/get-legal-hold-policy-assignments-id.md) - [Get list of all Box Doc Gen jobs for template](https://developer.box.com/reference/v2025.0/get-docgen-template-jobs-id.md) - [Get metadata cascade policy](https://developer.box.com/reference/get-metadata-cascade-policies-id.md) - [Get metadata instance on file](https://developer.box.com/reference/get-files-id-metadata-id-id.md) - [Get metadata instance on folder](https://developer.box.com/reference/get-folders-id-metadata-id-id.md) - [Get metadata template by ID](https://developer.box.com/reference/get-metadata-templates-id.md) - [Get metadata template by name](https://developer.box.com/reference/get-metadata-templates-id-id-schema.md) - [Get retention on file](https://developer.box.com/reference/get-file-version-retentions-id.md) - [Get retention policy](https://developer.box.com/reference/get-retention-policies-id.md) - [Get retention policy assignment](https://developer.box.com/reference/get-retention-policy-assignments-id.md) - [Get shared link for file](https://developer.box.com/reference/get-files-id--get-shared-link.md) - [Get shared link for folder](https://developer.box.com/reference/get-folders-id--get-shared-link.md) - [Get shared link for web link](https://developer.box.com/reference/get-web-links-id--get-shared-link.md) - [Get shield information barrier report by ID](https://developer.box.com/reference/get-shield-information-barrier-reports-id.md) - [Get shield information barrier segment member by ID](https://developer.box.com/reference/get-shield-information-barrier-segment-members-id.md) - [Get shield information barrier segment restriction by ID](https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions-id.md) - [Get shield information barrier segment with specified ID](https://developer.box.com/reference/get-shield-information-barrier-segments-id.md) - [Get shield information barrier with specified ID](https://developer.box.com/reference/get-shield-information-barriers-id.md) - [Get single shield list by shield list id](https://developer.box.com/reference/v2025.0/get-shield-lists-id.md) - [Get storage policy](https://developer.box.com/reference/get-storage-policies-id.md) - [Get storage policy assignment](https://developer.box.com/reference/get-storage-policy-assignments-id.md) - [Get task](https://developer.box.com/reference/get-tasks-id.md) - [Get task assignment](https://developer.box.com/reference/get-task-assignments-id.md) - [Get terms of service](https://developer.box.com/reference/get-terms-of-services-id.md) - [Get trashed file](https://developer.box.com/reference/get-files-id-trash.md) - [Get trashed folder](https://developer.box.com/reference/get-folders-id-trash.md) - [Get trashed web link](https://developer.box.com/reference/get-web-links-id-trash.md) - [Get upload session](https://developer.box.com/reference/get-files-upload-sessions-id.md) - [Get user](https://developer.box.com/reference/get-users-id.md) - [Get user avatar](https://developer.box.com/reference/get-users-id-avatar.md) - [Get user exempt from collaboration domain restrictions](https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets-id.md) - [Get user invite status](https://developer.box.com/reference/get-invites-id.md) - [Get watermark for folder](https://developer.box.com/reference/get-folders-id-watermark.md) - [Get watermark on file](https://developer.box.com/reference/get-files-id-watermark.md) - [Get web link](https://developer.box.com/reference/get-web-links-id.md) - [Get webhook](https://developer.box.com/reference/get-webhooks-id.md) - [Get zip download status](https://developer.box.com/reference/get-zip-downloads-id-status.md) - [Group](): A standard representation of a group, as returned from any group API endpoints by default. - [Group (Base)](): A base representation of a group. - [Group (Full)](): Groups contain a set of users, and can be used in place of users in some operations, such as collaborations. - [Group (Mini)](): Mini representation of a group, including id and name of group. - [Group membership](): Membership is used to signify that a user is part of a group. - [Group memberships](): A list of group memberships. - [Groups](): A list of groups. - [Hub](): A standard representation of a hub, as returned from any hubs API endpoints by default. - [Hub (Base)](): The bare basic representation of a hub. - [Hub Collaboration](): A hub collaboration object grants a user or group access to a hub with permissions defined by a specific role. - [Hub Collaborations](): A list of hub collaborations. - [Hub Item](): A Hub Item is a Box Item that is referenced in a Hub. - [Hub Items](): A list of Hub items. - [Hub Items Manage Response](): Response schema for the status of Hub items management operations. - [Hubs](): A paginated list of hubs. - [Integration mapping Slack](): A Slack specific representation of an integration mapping object. - [Integration mapping Teams](): A Microsoft Teams specific representation of an integration mapping object. - [Integration mappings Slack](): A list of integration mapping objects. - [Integration mappings Teams](): A list of integration mapping objects. - [Invite](): An invite for a user to an enterprise. - [Items](): A list of files, folders, and web links in their mini representation. - [Items](): A list of files, folders, and web links in their mini representation. - [Keyword Skill Card](): A skill card that contains a set of keywords. - [Legal hold policies](): A list of legal hold policies. - [Legal hold policy](): Legal Hold Policy information describes the basic characteristics of the Policy, such as name, description, and filter dates. - [Legal hold policy (Mini)](): A mini legal hold policy. - [Legal hold policy assignment](): Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the File-Versions that belong to the Assignment's 'apply-to' entity. - [Legal hold policy assignment (Base)](): Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the File-Versions that belong to the Assignment's 'apply-to' entity. - [Legal hold policy assignments](): A list of legal hold policies assignments. - [List AI agents](https://developer.box.com/reference/get-ai-agents.md) - [List all Box Doc Gen jobs](https://developer.box.com/reference/v2025.0/get-docgen-jobs.md) - [List all Box Doc Gen template tags in template](https://developer.box.com/reference/v2025.0/get-docgen-templates-id-tags.md) - [List all classifications](https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema.md) - [List all collections](https://developer.box.com/reference/get-collections.md) - [List all file versions](https://developer.box.com/reference/get-files-id-versions.md) - [List all global metadata templates](https://developer.box.com/reference/get-metadata-templates-global.md) - [List all hubs](https://developer.box.com/reference/v2025.0/get-hubs.md) - [List all hubs for requesting enterprise](https://developer.box.com/reference/v2025.0/get-enterprise-hubs.md) - [List all legal hold policies](https://developer.box.com/reference/get-legal-hold-policies.md) - [List all metadata templates for enterprise](https://developer.box.com/reference/get-metadata-templates-enterprise.md) - [List all webhooks](https://developer.box.com/reference/get-webhooks.md) - [List allowed collaboration domains](https://developer.box.com/reference/get-collaboration-whitelist-entries.md) - [List archives](https://developer.box.com/reference/v2025.0/get-archives.md) - [List Box Doc Gen templates](https://developer.box.com/reference/v2025.0/get-docgen-templates.md) - [List Box Sign requests](https://developer.box.com/reference/get-sign-requests.md) - [List Box Sign templates](https://developer.box.com/reference/get-sign-templates.md) - [List Box Skill cards on file](https://developer.box.com/reference/get-files-id-metadata-global-boxSkillsCards.md) - [List collection items](https://developer.box.com/reference/get-collections-id-items.md) - [List enterprise device pins](https://developer.box.com/reference/get-enterprises-id-device-pinners.md) - [List enterprise users](https://developer.box.com/reference/get-users.md) - [List file app item associations](https://developer.box.com/reference/get-files-id-app-item-associations.md) - [List file collaborations](https://developer.box.com/reference/get-files-id-collaborations.md) - [List file comments](https://developer.box.com/reference/get-files-id-comments.md) - [List file version legal holds](https://developer.box.com/reference/get-file-version-legal-holds.md) - [List file version retentions](https://developer.box.com/reference/get-file-version-retentions.md) - [List files with current file versions for legal hold policy assignment](https://developer.box.com/reference/get-legal-hold-policy-assignments-id-files-on-hold.md) - [List folder app item associations](https://developer.box.com/reference/get-folders-id-app-item-associations.md) - [List folder collaborations](https://developer.box.com/reference/get-folders-id-collaborations.md) - [List folder locks](https://developer.box.com/reference/get-folder-locks.md) - [List group collaborations](https://developer.box.com/reference/get-groups-id-collaborations.md) - [List groups for enterprise](https://developer.box.com/reference/get-groups.md) - [List items in folder](https://developer.box.com/reference/get-folders-id-items.md) - [List legal hold policy assignments](https://developer.box.com/reference/get-legal-hold-policy-assignments.md) - [List members of group](https://developer.box.com/reference/get-groups-id-memberships.md) - [List metadata cascade policies](https://developer.box.com/reference/get-metadata-cascade-policies.md) - [List metadata instances on file](https://developer.box.com/reference/get-files-id-metadata.md) - [List metadata instances on folder](https://developer.box.com/reference/get-folders-id-metadata.md) - [List of Shield Information Barrier Reports](): A list of shield barrier reports. - [List of Shield Information Barrier Segment Members](): List of Shield Information Barrier Member objects. - [List of Shield Information Barrier Segment Restrictions](): List of shield information barrier segment restriction objects. - [List of Shield Information Barrier Segments](): List of Shield Information Barrier Segment objects. - [List of Shield Information Barriers](): List of Shield Information Barrier objects. - [List of Shield Lists](): List of Shield List objects. - [List parts](https://developer.box.com/reference/get-files-upload-sessions-id-parts.md) - [List pending collaborations](https://developer.box.com/reference/get-collaborations.md) - [List previous file versions for legal hold policy assignment](https://developer.box.com/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold.md) - [List recently accessed items](https://developer.box.com/reference/get-recent-items.md) - [List retention policies](https://developer.box.com/reference/get-retention-policies.md) - [List retention policy assignments](https://developer.box.com/reference/get-retention-policies-id-assignments.md) - [List shield information barrier reports](https://developer.box.com/reference/get-shield-information-barrier-reports.md) - [List shield information barrier segment members](https://developer.box.com/reference/get-shield-information-barrier-segment-members.md) - [List shield information barrier segment restrictions](https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions.md) - [List shield information barrier segments](https://developer.box.com/reference/get-shield-information-barrier-segments.md) - [List shield information barriers](https://developer.box.com/reference/get-shield-information-barriers.md) - [List Slack integration mappings](https://developer.box.com/reference/get-integration-mappings-slack.md) - [List storage policies](https://developer.box.com/reference/get-storage-policies.md) - [List storage policy assignments](https://developer.box.com/reference/get-storage-policy-assignments.md) - [List task assignments](https://developer.box.com/reference/get-tasks-id-assignments.md) - [List tasks on file](https://developer.box.com/reference/get-files-id-tasks.md) - [List Teams integration mappings](https://developer.box.com/reference/get-integration-mappings-teams.md) - [List terms of service user statuses](https://developer.box.com/reference/get-terms-of-service-user-statuses.md) - [List terms of services](https://developer.box.com/reference/get-terms-of-services.md) - [List trashed items](https://developer.box.com/reference/get-folders-trash-items.md) - [List user and enterprise events](https://developer.box.com/reference/get-events.md) - [List user's email aliases](https://developer.box.com/reference/get-users-id-email-aliases.md) - [List user's groups](https://developer.box.com/reference/get-users-id-memberships.md) - [List users exempt from collaboration domain restrictions](https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets.md) - [List workflows](https://developer.box.com/reference/get-workflows.md) - [Manage hub items](https://developer.box.com/reference/v2025.0/post-hubs-id-manage-items.md) - [Metadata cascade policies](): A list of metadata cascade policies. - [Metadata cascade policy](): A metadata cascade policy automatically applies a metadata template instance to all the files and folders within the targeted folder. - [Metadata Error](): A generic metadata operation error. - [Metadata field filter (date range)](): Specifies which `date` field on the template to filter the search results by, specifying a range of dates that can match. - [Metadata field filter (float range)](): Specifies which `float` field on the template to filter the search results by, specifying a range of values that can match. - [Metadata filter](): A metadata template used to filter the search results. - [Metadata instance](): An instance of a metadata template, which has been applied to a file or folder. - [Metadata instance (Base)](): The base representation of a metadata instance. - [Metadata instance (Full)](): An instance of a metadata template, which has been applied to a file or folder. - [Metadata instances](): A list of metadata instances that have been applied to a file or folder. - [Metadata query search results](): A page of files and folders that matched the metadata query. - [Metadata template](): A template for metadata that can be applied to files and folders. - [Metadata templates](): A list of metadata templates. - [OAuth 2.0 error](): An OAuth 2.0 error. - [Permanently remove file](https://developer.box.com/reference/delete-files-id-trash.md) - [Permanently remove folder](https://developer.box.com/reference/delete-folders-id-trash.md) - [Permanently remove web link](https://developer.box.com/reference/delete-web-links-id-trash.md) - [Preflight check before upload](https://developer.box.com/reference/options-files-content.md) - [Promote file version](https://developer.box.com/reference/post-files-id-versions-current.md) - [Query files/folders by metadata](https://developer.box.com/reference/post-metadata-queries-execute-read.md) - [Real-time server](): A real-time server that can be used for long polling user events. - [Real-time servers](): A list of real-time servers that can be used for long-polling. - [Recent item](): A recent item accessed by a user. - [Recent items](): A list of recent items. - [Refresh access token](https://developer.box.com/reference/post-oauth2-token--refresh.md) - [Remove Box Skill cards from file](https://developer.box.com/reference/delete-files-id-metadata-global-boxSkillsCards.md) - [Remove classification from file](https://developer.box.com/reference/delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo.md) - [Remove classification from folder](https://developer.box.com/reference/delete-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo.md) - [Remove collaboration](https://developer.box.com/reference/delete-collaborations-id.md) - [Remove comment](https://developer.box.com/reference/delete-comments-id.md) - [Remove device pin](https://developer.box.com/reference/delete-device-pinners-id.md) - [Remove domain from list of allowed collaboration domains](https://developer.box.com/reference/delete-collaboration-whitelist-entries-id.md) - [Remove email alias](https://developer.box.com/reference/delete-users-id-email-aliases-id.md) - [Remove file version](https://developer.box.com/reference/delete-files-id-versions-id.md) - [Remove group](https://developer.box.com/reference/delete-groups-id.md) - [Remove hub collaboration](https://developer.box.com/reference/v2025.0/delete-hub-collaborations-id.md) - [Remove legal hold policy](https://developer.box.com/reference/delete-legal-hold-policies-id.md) - [Remove metadata cascade policy](https://developer.box.com/reference/delete-metadata-cascade-policies-id.md) - [Remove metadata instance from file](https://developer.box.com/reference/delete-files-id-metadata-id-id.md) - [Remove metadata instance from folder](https://developer.box.com/reference/delete-folders-id-metadata-id-id.md) - [Remove metadata template](https://developer.box.com/reference/delete-metadata-templates-id-id-schema.md) - [Remove retention policy assignment](https://developer.box.com/reference/delete-retention-policy-assignments-id.md) - [Remove shared link from file](https://developer.box.com/reference/put-files-id--remove-shared-link.md) - [Remove shared link from folder](https://developer.box.com/reference/put-folders-id--remove-shared-link.md) - [Remove shared link from web link](https://developer.box.com/reference/put-web-links-id--remove-shared-link.md) - [Remove task](https://developer.box.com/reference/delete-tasks-id.md) - [Remove upload session](https://developer.box.com/reference/delete-files-upload-sessions-id.md) - [Remove user from group](https://developer.box.com/reference/delete-group-memberships-id.md) - [Remove user from list of users exempt from domain restrictions](https://developer.box.com/reference/delete-collaboration-whitelist-exempt-targets-id.md) - [Remove watermark from file](https://developer.box.com/reference/delete-files-id-watermark.md) - [Remove watermark from folder](https://developer.box.com/reference/delete-folders-id-watermark.md) - [Remove web link](https://developer.box.com/reference/delete-web-links-id.md) - [Remove webhook](https://developer.box.com/reference/delete-webhooks-id.md) - [Request access token](https://developer.box.com/reference/post-oauth2-token.md) - [Resend Box Sign request](https://developer.box.com/reference/post-sign-requests-id-resend.md) - [Restore file](https://developer.box.com/reference/post-files-id.md) - [Restore file version](https://developer.box.com/reference/put-files-id-versions-id.md) - [Restore folder](https://developer.box.com/reference/post-folders-id.md) - [Restore web link](https://developer.box.com/reference/post-web-links-id.md) - [Retention policies](): A list of retention policies. - [Retention policy](): A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention policies and then later assign them to specific folders, metadata templates, or their entire enterprise. To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console. - [Retention policy (Base)](): A base representation of a retention policy. - [Retention policy (Mini)](): A mini representation of a retention policy, used when nested within another resource. - [Retention policy assignment](): A retention assignment represents a rule specifying the files a retention policy retains. Assignments can retain files based on their folder or metadata, or hold all files in the enterprise. - [Retention policy assignments](): A list of retention policy assignments. - [Revoke access token](https://developer.box.com/reference/post-oauth2-revoke.md) - [Search for content](https://developer.box.com/reference/get-search.md) - [Search Result (including Shared Link)](): A single of files, folder or web link that matched the search query, including the additional information about the shared link through which the item has been shared with the user. This response format is only returned when the `include_recent_shared_links` query parameter has been set to `true`. - [Search Results](): A list of files, folders and web links that matched the search query. - [Search Results (including Shared Links)](): A list of files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user. This response format is only returned when the `include_recent_shared_links` query parameter has been set to `true`. - [Session termination message](): A message informing about the termination job status. - [Shield information barrier](): A standard representation of a shield information barrier object. - [Shield information barrier (Base)](): A base representation of a shield information barrier object. - [Shield information barrier reference](): A shield information barrier reference for requests and responses. - [Shield information barrier report](): A standard representation of a shield information barrier report object. - [Shield information barrier report (Base)](): A base representation of a shield information barrier report object. - [Shield information barrier report details](): Indicates which folder the report file is located and any errors when generating the report. - [Shield information barrier segment](): A shield information barrier segment object. - [Shield information barrier segment member](): A standard representation of a shield information barrier segment member object. - [Shield information barrier segment member (Base)](): A base representation of a shield information barrier segment member object. - [Shield information barrier segment member (Mini)](): A mini representation of a shield information barrier segment member object. - [Shield information barrier segment restriction](): A standard representation of a segment restriction of a shield information barrier object. - [Shield information barrier segment restriction (Base)](): A base representation of a segment restriction object for the shield information barrier. - [Shield information barrier segment restriction (Mini)](): A mini representation of a segment restriction object for the shield information barrier. - [Shield List](): A standard representation of a Shield List. - [Shield List (Mini)](): A mini representation of a Shield List. - [Shield List Content (Country)](): Representation of content of a Shield List that contains countries data. - [Shield List Content (Domain)](): Representation of content of a Shield List that contains domains data. - [Shield List Content (Email)](): Representation of content of a Shield List that contains email addresses data. - [Shield List Content (Integration)](): Representation of content of a Shield List that contains integrations data. - [Shield List Content (IP)](): Representation of content of a Shield List that contains ip addresses data. - [Skills metadata instance](): The metadata assigned to a using for Box skills. - [Starts workflow based on request body](https://developer.box.com/reference/post-workflows-id-start.md) - [Status Skill Card](): A Box Skill metadata card that puts a status message in the metadata sidebar. - [Storage policies](): A list of storage policies. - [Storage policy](): The Storage Policy object describes the storage zone. - [Storage policy (Mini)](): A mini description of a Storage Policy object. - [Storage policy assignment](): The assignment of a storage policy to a user or enterprise. - [Storage policy assignments](): A list of storage policy assignments. - [Task](): A task allows for file-centric workflows within Box. Users can create tasks on files and assign them to other users for them to complete the tasks. - [Task assignment](): A task assignment defines which task is assigned to which user to complete. - [Task assignments](): A list of task assignments. - [Tasks](): A list of tasks. - [Terms of service](): The root-level record that is supposed to represent a single Terms of Service. - [Terms of service (Base)](): The root-level record that is supposed to represent a single Terms of Service. - [Terms of service user status](): The association between a Terms of Service and a user. - [Terms of service user statuses](): A list of terms of service user statuses. - [Terms of services](): A list of terms of services. - [The entity with type and ID](): The entity with type and ID. - [Timeline Skill Card](): A Box Skill metadata card that places a list of images on a timeline. - [Transcript Skill Card.](): A Box Skill metadata card that adds a transcript to a file. - [Transfer owned folders](https://developer.box.com/reference/put-users-id-folders-0.md) - [Trashed File](): Represents a trashed file. - [Trashed File (Restored)](): Represents a file restored from the trash. - [Trashed Folder](): Represents a trashed folder. - [Trashed Folder (Restored)](): Represents a folder restored from the trash. - [Trashed Web Link](): Represents a trashed web link. - [Trashed Web Link (Restored)](): Represents a web link restored from the trash. - [Unassign legal hold policy](https://developer.box.com/reference/delete-legal-hold-policy-assignments-id.md) - [Unassign storage policy](https://developer.box.com/reference/delete-storage-policy-assignments-id.md) - [Unassign task](https://developer.box.com/reference/delete-task-assignments-id.md) - [Update AI agent](https://developer.box.com/reference/put-ai-agents-id.md) - [Update all Box Skill cards on file](https://developer.box.com/reference/put-skill-invocations-id.md) - [Update Box Skill cards on file](https://developer.box.com/reference/put-files-id-metadata-global-boxSkillsCards.md) - [Update classification](https://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--update.md) - [Update classification on file](https://developer.box.com/reference/put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo.md) - [Update classification on folder](https://developer.box.com/reference/put-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo.md) - [Update collaboration](https://developer.box.com/reference/put-collaborations-id.md) - [Update comment](https://developer.box.com/reference/put-comments-id.md) - [Update file](https://developer.box.com/reference/put-files-id.md) - [Update file request](https://developer.box.com/reference/put-file-requests-id.md) - [Update folder](https://developer.box.com/reference/put-folders-id.md) - [Update group](https://developer.box.com/reference/put-groups-id.md) - [Update group membership](https://developer.box.com/reference/put-group-memberships-id.md) - [Update hub collaboration](https://developer.box.com/reference/v2025.0/put-hub-collaborations-id.md) - [Update hub information by ID](https://developer.box.com/reference/v2025.0/put-hubs-id.md) - [Update legal hold policy](https://developer.box.com/reference/put-legal-hold-policies-id.md) - [Update metadata instance on file](https://developer.box.com/reference/put-files-id-metadata-id-id.md) - [Update metadata instance on folder](https://developer.box.com/reference/put-folders-id-metadata-id-id.md) - [Update metadata template](https://developer.box.com/reference/put-metadata-templates-id-id-schema.md) - [Update retention policy](https://developer.box.com/reference/put-retention-policies-id.md) - [Update shared link on file](https://developer.box.com/reference/put-files-id--update-shared-link.md) - [Update shared link on folder](https://developer.box.com/reference/put-folders-id--update-shared-link.md) - [Update shared link on web link](https://developer.box.com/reference/put-web-links-id--update-shared-link.md) - [Update shield information barrier segment with specified ID](https://developer.box.com/reference/put-shield-information-barrier-segments-id.md) - [Update shield list](https://developer.box.com/reference/v2025.0/put-shield-lists-id.md) - [Update Slack integration mapping](https://developer.box.com/reference/put-integration-mappings-slack-id.md) - [Update storage policy assignment](https://developer.box.com/reference/put-storage-policy-assignments-id.md) - [Update task](https://developer.box.com/reference/put-tasks-id.md) - [Update task assignment](https://developer.box.com/reference/put-task-assignments-id.md) - [Update Teams integration mapping](https://developer.box.com/reference/put-integration-mappings-teams-id.md) - [Update terms of service](https://developer.box.com/reference/put-terms-of-services-id.md) - [Update terms of service status for existing user](https://developer.box.com/reference/put-terms-of-service-user-statuses-id.md) - [Update user](https://developer.box.com/reference/put-users-id.md) - [Update web link](https://developer.box.com/reference/put-web-links-id.md) - [Update webhook](https://developer.box.com/reference/put-webhooks-id.md) - [Upload file](https://developer.box.com/reference/post-files-content.md) - [Upload file version](https://developer.box.com/reference/post-files-id-content.md) - [Upload part](): The representation of an upload session chunk. - [Upload part (Mini)](): The basic representation of an upload session chunk. - [Upload part of file](https://developer.box.com/reference/put-files-upload-sessions-id.md) - [Upload parts](): A list of uploaded chunks for an upload session. - [Upload session](): An upload session for chunk uploading a file. - [Upload URL](): The details for the upload session for the file. - [Uploaded part](): A chunk of a file uploaded as part of an upload session, as returned by some endpoints. - [User](): A standard representation of a user, as returned from any user API endpoints by default. - [User (Base)](): A mini representation of a user, used when nested within another resource. - [User (Collaborations)](): A mini representation of a user, can be returned only when the status is `pending`. - [User (Full)](): A full representation of a user, as can be returned from any user API endpoint. - [User (Integration Mappings)](): A user representation for integration mappings API purposes. Fields name and login are not required. - [User (Mini)](): A mini representation of a user, as can be returned when nested within other resources. - [User avatar](): A resource holding URLs to the avatar uploaded to a Box application. - [Users](): A list of users. - [Watermark](): A watermark is a semi-transparent overlay on an embedded file preview that displays a viewer's email address or user ID and the time of access over a file's content. - [Web link](): Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. - [Web link (Base)](): Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. - [Web link (Mini)](): Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. - [Webhook](): Represents a configured webhook. - [Webhook (Mini)](): Represents a configured webhook. - [Webhooks](): A list of webhooks. - [Workflow](): Box Relay Workflows are objects that represent a named collection of flows. Your application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. - [Workflow (Mini)](): Box Relay Workflows are objects that represent a named collection of flows. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. - [Workflows](): A list of workflows. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. - [Zip download](): Represents a successful request to create a `zip` archive of a list of files and folders. - [Zip download status](): The status of a `zip` archive being downloaded. ## Box AI Developer Zone - [Box AI Developer Zone](https://developer.box.com/ai-dev-zone.md): Box AI Developer Zone Box AI Developer Zone Box AI Developer Zone features interactive demos, sample code, and tools for building AI agents… ## Optional - [`Google PaLM` deprecation and removal](https://developer.box.com/changelog/2025-01-09-google-palm-deprecation-and-removal.md): Google PaLM deprecation and removal - [`multiSelect` field type added to metadata templates](https://developer.box.com/changelog/2018-03-29-multiselect-field-type-added-to-metadata-templates.md): multiSelect field type added to metadata templates We have introduced a new attribute type to Metadata Templates called multiSelect, which… - [`PDF.js` vulnerability affecting Box Preview SDK](https://developer.box.com/changelog/2024-05-23-pdf-js-vulnerability.md): PDF.js vulnerability affecting Box Preview SDK A CVE-2024-4367 vulnerability has been identified in the PDF.js library used by Box Preview SDK. The vulnerability exposes a gap in the PDF.js type, checking code that allows for arbitrary JavaScript to run when opened in Preview. - [Add more details to Custom Apps](https://developer.box.com/changelog/2023-04-17-new-custom-app-modal.md): Add more details to Custom Apps To clarify Custom Apps' purpose and add the value for the enterprise, we now offer a possibility of describing the Custom App in a more granular way. When setting up a Custom App with OAuth, JWT or Client Credentials, you can now specify the purpose of the app and the app's creator. Additionally, if you intend to integrate your app with an external system, you can define the integration category and provide details of the external system. - [Add new `action_by` field to enterprise events](https://developer.box.com/changelog/2018-08-21-add-new-action_by-field-to-enterprise-events.md): Add new action_by field to enterprise events To better document admin actions taken on user accounts, we have added an action_by mini-user… - [Add new `uploader_display_name` field to file and file versions](https://developer.box.com/changelog/2020-04-23-add-new-uploader_display_name-field-to-file-and-file-versions.md): Add new uploader_display_name field to file and file versions A new field, uploader_display_name has been added to both file and file version resources. This field provides the name of the user at the time of upload. - [Add new fields to folder update and get info endpoints](https://developer.box.com/changelog/2018-08-21-add-new-fields-to-folder-update-and-get-info-endpoints.md): Add new fields to folder update and get info endpoints Two major releases have been added to the update folder API endpoint, is… - [Added Retention Policy Marker Based Pagination](https://developer.box.com/changelog/2021-11-16-added-retention-policy-marker-based-pagination.md): Added Retention Policy Marker Based Pagination Our OpenAPI specification has been updated for retention policy and retention policy assignment endpoints to show use of marker based pagination and fields query parameters. - [AI Studio v2](https://developer.box.com/changelog/2025-06-24-AI-studio-v2.md): AI Studio v2 With the release of the newest version of the AI Studio functionality, we introduced the enhancements listed below. Users receive a notification in case of any issues with an agent directly in the AI Studio UI. Agents are validated in real time. The ones that don't pass validation are not visible for the users. Admins can: Control the suggested questions displayed when the user starts interacting with a custom AI agent. See the details of a request and response of a LLM, for example the system prompt, model, custom instructions. Control the parameters of a Box AI image processor in a custom agent. The parameters are necessary to ask a LLM about a specific image. - [Annotations available for Excel files in preview](https://developer.box.com/changelog/2018-09-05-annotations-available-for-excel-files-in-preview.md): Annotations available for Excel files in preview Currently, annotations capabilities don't appear within Excel files in preview, either via… - [AI](): AI AI allows to send an intelligence request to supported large language models and returns an answer based on the provided prompt and items… - [AI](): AI AI allows to send an intelligence request to supported large language models and returns an answer based on the provided prompt and items… - [AI](): AI AI allows to send an intelligence request to supported large language models and returns an answer based on the provided prompt and items… - [AI](): AI AI allows to send an intelligence request to supported large language models and returns an answer based on the provided prompt and items… - [AiManager](): AiManager Ask question Generate text Get AI agent default configuration Extract metadata (freeform) Extract metadata (structured) Ask… - [AiManager](): AiManager Ask question Generate text Get AI agent default configuration Extract metadata (freeform) Extract metadata (structured) Ask… - [AiManager](): AiManager Ask question Generate text Get AI agent default configuration Extract metadata (freeform) Extract metadata (structured) Ask… - [AiManager](): AiManager Ask question Generate text Get AI agent default configuration Extract metadata (freeform) Extract metadata (structured) Ask… - [AiStudioManager](): AiStudioManager List AI agents Create AI agent Update AI agent Get AI agent by agent ID Delete AI agent List AI agents Lists AI agents based… - [AiStudioManager](): AiStudioManager List AI agents Create AI agent Update AI agent Get AI agent by agent ID Delete AI agent List AI agents Lists AI agents based… - [AiStudioManager](): AiStudioManager List AI agents Create AI agent Update AI agent Get AI agent by agent ID Delete AI agent List AI agents Lists AI agents based… - [AiStudioManager](): AiStudioManager List AI agents Create AI agent Update AI agent Get AI agent by agent ID Delete AI agent List AI agents Lists AI agents based… - [Android](): Android The Java SDK should be compatible with modern Android applications written in both Java and Kotlin. To use the Java SDK in an… - [API Basics](https://developer.box.com/sign/quick-start/api-basics.md): API Basics Sign API The Sign request endpoint is used to create and manage signature requests. You can create, resend, and cancel signature… - [App Auth Sample App](): App Auth Sample App To get started: Clone the SDK repo Edit examples/app-auth/index.js with your app credentials Run the sample app: - [AppItemAssociationsManager](): AppItemAssociationsManager List file app item associations List folder app item associations List file app item associations This is a beta… - [AppItemAssociationsManager](): AppItemAssociationsManager List file app item associations List folder app item associations List file app item associations This is a beta… - [AppItemAssociationsManager](): AppItemAssociationsManager List file app item associations List folder app item associations List file app item associations This is a beta… - [AppItemAssociationsManager](): AppItemAssociationsManager List file app item associations List folder app item associations List file app item associations This is a beta… - [ArchivesManager](): ArchivesManager List archives Create archive Delete archive List archives Retrieves archives for an enterprise. This operation is performed… - [ArchivesManager](): ArchivesManager List archives Create archive Delete archive List archives Retrieves archives for an enterprise. This operation is performed… - [ArchivesManager](): ArchivesManager List archives Create archive Delete archive List archives Retrieves archives for an enterprise. This operation is performed… - [ArchivesManager](): ArchivesManager List archives Create archive Delete archive List archives Retrieves archives for an enterprise. This operation is performed… - [Authentication](): Authentication The Box API uses OAuth2 for authentication, which can be difficult to implement. The SDK makes it easier by providing classes… - [Authentication](): Authentication The Box API uses OAuth2 for authentication, which can be difficult to implement. The SDK makes it easier by providing classes… - [Authentication](): Authentication The Box API uses OAuth2 for authentication, which can be difficult to implement. The SDK makes it easier by providing classes… - [Authentication](): Authentication Authentication Ways to Authenticate Developer Token Server Auth with JWT Traditional 3-Legged OAuth2 Client Credentials Grant… - [Authentication](): Authentication Authentication Ways to Authenticate Developer Token Server Auth with JWT Traditional 3-Legged OAuth2 Client Credentials Grant… - [Authentication](): Authentication Authentication Authentication methods Developer Token JWT Auth Authenticate Enterprise Authenticate user Client Credentials… - [Authentication](): Authentication Authentication Authentication methods Developer Token JWT Auth Authenticate Enterprise Authenticate user Client Credentials… - [Authentication](): Authentication Authentication Authentication methods Developer Token JWT Auth Authenticate Enterprise Authenticate User Client Credentials… - [Authentication](): Authentication Authentication Authentication methods Developer Token Client Credentials Grant Obtaining Service Account token Obtaining User… - [Authentication](): Authentication Authentication Authentication methods Developer Token JWT Auth Authenticate Enterprise Authenticate user Client Credentials… - [AuthorizationManager](): AuthorizationManager Authorize user Request access token Refresh access token Revoke access token Authorize user Authorize a user by sending… - [AuthorizationManager](): AuthorizationManager Authorize user Request access token Refresh access token Revoke access token Authorize user Authorize a user by sending… - [AuthorizationManager](): AuthorizationManager Authorize user Request access token Refresh access token Revoke access token Authorize user Authorize a user by sending… - [AuthorizationManager](): AuthorizationManager Authorize user Request access token Refresh access token Revoke access token Authorize user Authorize a user by sending… - [AvatarsManager](): AvatarsManager Get user avatar Add or update user avatar Delete user avatar Get user avatar Retrieves an image of a the user's avatar. This… - [AvatarsManager](): AvatarsManager Get user avatar Add or update user avatar Delete user avatar Get user avatar Retrieves an image of a the user's avatar. This… - [AvatarsManager](): AvatarsManager Get user avatar Add or update user avatar Delete user avatar Get user avatar Retrieves an image of a the user's avatar. This… - [AvatarsManager](): AvatarsManager Get user avatar Add or update user avatar Delete user avatar Get user avatar Retrieves an image of a the user's avatar. This… - [Box cURL samples](): Box cURL samples Authorize a user Authorize a user by sending them through the Box website and request their permission to act on their… - [Box Dotnet SDK Gen](): Box Dotnet SDK Gen Project Status build nuget version image Platform Coverage We are excited to introduce the stable release of the latest… - [Box iOS SDK](): Box iOS SDK Project Status Platforms License Swift Package Manager Carthage compatible CocoaPods compatible Build Status Coverage Getting… - [Box Java SDK](): Box Java SDK Project Status Platform License Build main Coverage The Box Java SDK for interacting with the Box Content API. Latest Release… - [Box Java SDK Gen](): Box Java SDK Gen Project Status build Maven Central Version Platform Coverage We are excited to introduce the Beta Release of the latest… - [Box Platform](https://developer.box.com//index.md): Box Platform Start building with Box Platform Manage users with Box Platform Build experiences with Box Platform Integrate apps with Box… - [Box Python SDK Gen](): Box Python SDK Gen Project Status build PyPI version image Platform Coverage We are excited to introduce the stable release of the latest… - [Box Swift SDK GENERATED](): Box Swift SDK GENERATED Project Status build Platforms Coverage Swift Package Manager Carthage compatible CocoaPods compatible We are… - [Box TypeScript SDK Gen](): Box TypeScript SDK Gen Project Status build npm version image Platform Coverage We are excited to introduce the stable release of the latest… - [Box TypeScript SDK Gen Browser Test Runner](): Box TypeScript SDK Gen Browser Test Runner A browser-based test runner for Box TypeScript SDK, built with Next.js and Cypress. Features Run… - [Box UI Elements](https://developer.box.com/box-ui-elements.md): Box UI Elements Create experiences with Box UI Elements Box UI Elements are pre-built UI components that allow you to extend custom portals… - [Box UI Elements](https://developer.box.com/agent-configurator.md): Box UI Elements Box AI API agent configurator Choose from multiple AI models from leading providers, all accessible through a single, easy… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 3.8.2 (2025-07-2… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 4.16.3 (2025-0… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 3.14.0 (2025-0… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 5.8.0 (2024-07-2… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 5.6.0 (2024-04-0… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 1.17.1 (2025-0… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 1.16.0 (2025-0… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 1.11.0 (2025-0… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 0.6.2 (2025-08-1… - [Changelog](): Changelog All notable changes to this project will be documented in this file. See standard-version for commit guidelines. 0.8.0 (2025-08-0… - [ChunkedUploadsManager](): ChunkedUploadsManager This is a manager for chunked uploads (allowed for files at least 20MB). Create upload session Create upload session… - [ChunkedUploadsManager](): ChunkedUploadsManager This is a manager for chunked uploads (allowed for files at least 20MB). Create upload session Create upload session… - [ChunkedUploadsManager](): ChunkedUploadsManager This is a manager for chunked uploads (allowed for files at least 20MB). Create upload session Create upload session… - [ChunkedUploadsManager](): ChunkedUploadsManager This is a manager for chunked uploads (allowed for files at least 20MB). Create upload session Create upload session… - [Classifications](): Classifications Classfications are a type of metadata that allows users and applications to define and assign a content classification to… - [Classifications](): Classifications Classfications are a type of metadata that allows users and applications to define and assign a content classification to… - [Classifications](): Classifications Classifications are a type of metadata that allows users and applications to define and assign a content classification to… - [Classifications](): Classifications Classifications are a type of metadata that allows users and applications to define and assign a content classification to… - [ClassificationsManager](): ClassificationsManager List all classifications Add classification Update classification Add initial classifications List all… - [ClassificationsManager](): ClassificationsManager List all classifications Add classification Update classification Add initial classifications List all… - [ClassificationsManager](): ClassificationsManager List all classifications Add classification Update classification Add initial classifications List all… - [ClassificationsManager](): ClassificationsManager List all classifications Add classification Update classification Add initial classifications List all… - [Client](): Client The client object is the primary interface for making API calls through the SDK. It automatically manages API access token upkeep… - [Client](): Client This is the central entrypoint for all SDK interaction. The BoxClient houses all the API endpoints divided across resource managers… - [Client](): Client This is the central entrypoint for all SDK interaction. The BoxClient houses all the API endpoints divided across resource managers… - [Client](): Client This is the central entrypoint for all SDK interaction. The BoxClient houses all the API endpoints divided across resource managers… - [Client](): Client This is the central entrypoint for all SDK interaction. The BoxClient houses all the API endpoints divided across resource managers… - [Client](): Client This is the central entrypoint for all SDK interaction. The BoxClient houses all the API endpoints divided across resource managers… - [Collaboration Allowlist](): Collaboration Allowlist The Collaboration Allowlist API allows you to manage a set of approved domains (i.e. a allowlist) that can… - [Collaboration Allowlists](): Collaboration Allowlists Collaboration Allowlists are used to determine specific email domains that can collaborate with a Box Enterprise… - [Collaboration Allowlists](): Collaboration Allowlists Collaboration Allowlists are used to manage a set of approved domains or Box users that an enterprise can… - [Collaboration Whitelists](): Collaboration Whitelists Collaboration Whitelists are used to determine specific email domains that can collaborate with a Box Enterprise… - [CollaborationAllowlistEntriesManager](): CollaborationAllowlistEntriesManager List allowed collaboration domains Add domain to list of allowed collaboration domains Get allowed… - [CollaborationAllowlistEntriesManager](): CollaborationAllowlistEntriesManager List allowed collaboration domains Add domain to list of allowed collaboration domains Get allowed… - [CollaborationAllowlistEntriesManager](): CollaborationAllowlistEntriesManager List allowed collaboration domains Add domain to list of allowed collaboration domains Get allowed… - [CollaborationAllowlistEntriesManager](): CollaborationAllowlistEntriesManager List allowed collaboration domains Add domain to list of allowed collaboration domains Get allowed… - [CollaborationAllowlistExemptTargetsManager](): CollaborationAllowlistExemptTargetsManager List users exempt from collaboration domain restrictions Create user exemption from collaboration… - [CollaborationAllowlistExemptTargetsManager](): CollaborationAllowlistExemptTargetsManager List users exempt from collaboration domain restrictions Create user exemption from collaboration… - [CollaborationAllowlistExemptTargetsManager](): CollaborationAllowlistExemptTargetsManager List users exempt from collaboration domain restrictions Create user exemption from collaboration… - [CollaborationAllowlistExemptTargetsManager](): CollaborationAllowlistExemptTargetsManager List users exempt from collaboration domain restrictions Create user exemption from collaboration… - [Collaborations](): Collaborations Collaborations are used to share folders and files between users or groups. They also define what permissions a user has for… - [Collaborations](): Collaborations Collaborations are used to share folders between users or groups. They also define what permissions a user has for a folder… - [Collaborations](): Collaborations Collaborations are used to share folders between users or groups. They also define what permissions a user has for a folder… - [Collaborations](): Collaborations Collaborations are used to share folders and files between users or groups. They also define what permissions a user has for… - [Collaborations](): Collaborations Collaborations are used to share folders and files between users or groups. They also define what permissions a user has for… - [Collaborations](): Collaborations Collaborations are used to share folders and files between users or groups. They also define what permissions a user has for… - [Collections](): Collections Collections are used to store a custom user-defined set of items that may not all be in the same folder. Currently, the only… - [Collections](): Collections Collections contain information about the items contained inside of them, including files and folders. The only collection… - [Collections](): Collections Collections allow users to mark specific files, folders and web links to make it easier to find them. Get a User's Collections… - [Collections](): Collections Collections are used to store a custom user-defined set of items that may not all be in the same folder. Get a User's… - [CollectionsManager](): CollectionsManager List all collections List collection items Get collection by ID List all collections Retrieves all collections for a… - [CollectionsManager](): CollectionsManager List all collections List collection items Get collection by ID List all collections Retrieves all collections for a… - [CollectionsManager](): CollectionsManager List all collections List collection items Get collection by ID List all collections Retrieves all collections for a… - [CollectionsManager](): CollectionsManager List all collections List collection items Get collection by ID List all collections Retrieves all collections for a… - [Comments](): Comments Comment objects represent a user-created comment on a file. They can be added directly to a file. Get a Comment's Information Get… - [Comments](): Comments Comment objects represent a user-created comment on a file. They can be added directly to a file or they can be a reply to another… - [Comments](): Comments Comment objects represent a user-created comment on a file. They can be added directly to a file. Get Information About a Comment… - [Comments](): Comments Comment objects represent a user-created comment on a file. They can be added directly to a file. Get a Comment's Information Get… - [Comments](): Comments Comment objects represent a user-created comment on a file. They can be added directly to a file. Get Comment Create Comment Update… - [Comments](): Comments Comment objects represent a user-created comment on a file. They can be added directly to a file. Get Comment Create Comment Update… - [CommentsManager](): CommentsManager List file comments Get comment Update comment Remove comment Create comment List file comments Retrieves a list of comments… - [CommentsManager](): CommentsManager List file comments Get comment Update comment Remove comment Create comment List file comments Retrieves a list of comments… - [CommentsManager](): CommentsManager List file comments Get comment Update comment Remove comment Create comment List file comments Retrieves a list of comments… - [CommentsManager](): CommentsManager List file comments Get comment Update comment Remove comment Create comment List file comments Retrieves a list of comments… - [Community Projects](https://developer.box.com/support/community-projects.md): Community Projects The community projects list publicly available tools and services that have been generated by the Box developer community… - [Configuration](): Configuration The BoxSDKNode is the base object used to configure client. Configure Proxy To set up your proxy, add your proxy settings to… - [Configuration](): Configuration Proxy configuration Custom proxy authenticator Example: NTLM authenticator Configure retries of calls and timeouts Maximum… - [Configuration](): Configuration The Python SDK has helpful custom config that you can set for a variety of use cases. Proxy Unauthenticated Proxy Basic… - [Configuration](): Configuration URLs configuration Base URL Account URL Upload URL Timeout Proxy Supress notifications Make API calls As-User Custom private… - [Configuration](): Configuration The iOS SDK provides dedicated method, that helps you to customize SDK configuration. All you need is to call sdk… - [Configuration](): Configuration The iOS SDK provides dedicated method, that helps you to customize SDK configuration. All you need is to call sdk… - [Configuration](): Configuration Max retry attempts Custom retry strategy Max retry attempts The default maximum number of retries in case of failed API call… - [Configuration](): Configuration Max retry attempts Custom retry strategy Max retry attempts The default maximum number of retries in case of failed API call… - [Configuration](): Configuration Configuration Max retry attempts Custom retry strategy Max retry attempts The default maximum number of retries in case of… - [Constructing API Calls Manually](): Constructing API Calls Manually The SDK also exposes low-level request methods for constructing your own API calls. These can be useful for… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributing](): Contributing All contributions are welcome to this project. Contributor License Agreement Before a contribution can be merged into this… - [Contributor Covenant Code of Conduct](): Contributor Covenant Code of Conduct Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and… - [Custom API Calls](): Custom API Calls There are a few situations, where a user might want to make a custom API call — utilizing the SDK's authentication handling… - [Custom API Calls](): Custom API Calls There are a few situations, where a user might want to make a custom API call — utilizing the SDK's authentication handling… - [Custom email and notifications](https://developer.box.com/sign/request-options/custom-email.md): Custom email and notifications Email subject and body By default, the email sent to the signers contains a link to the document, a generic… - [Deprecation notice](): Deprecation notice This version of the Box Node SDK is under maintenance mode, and will be deprecated soon, only critical security updates… - [Deprecation notice](): Deprecation notice This version of the Box Python SDK is under maintenance mode, and will be deprecated soon, only critical security updates… - [Deprecation notice](): Deprecation notice This version of the Box .NET SDK is under maintenance mode, and will be deprecated soon, only critical security updates… - [Developer Newsletter](https://developer.box.com/newsletter.md): Developer Newsletter Throughout the year, we send out a newsletter to our community with the top developer events, product releases, and… - [Device Pins](): Device Pins Device pins allow enterprises to control what devices can use native Box applications. To learn more about device pinning… - [Device Pins](): Device Pins Device pinning is a feature that allows enterprise admins to pin their user’s corporate-managed Box account to a particular… - [Device Pins](): Device Pins Device pins allow enterprises to control what devices can use native Box applications. To learn more about device pinning… - [Device Pins](): Device Pins Get Device Pin Info Get Device Pins for Enterprise Delete Device Pin Get Device Pin Info To retrieve information about a device… - [Device Pins](): Device Pins Get Device Pin Info Get Device Pins for Enterprise Delete Device Pin Get Device Pin Info To retrieve information about a device… - [DevicePinnersManager](): DevicePinnersManager Get device pin Remove device pin List enterprise device pins Get device pin Retrieves information about an individual… - [DevicePinnersManager](): DevicePinnersManager Get device pin Remove device pin List enterprise device pins Get device pin Retrieves information about an individual… - [DevicePinnersManager](): DevicePinnersManager Get device pin Remove device pin List enterprise device pins Get device pin Retrieves information about an individual… - [DevicePinnersManager](): DevicePinnersManager Get device pin Remove device pin List enterprise device pins Get device pin Retrieves information about an individual… - [Devices](): Devices Device pinning is a feature that allows enterprise admins to pin their user’s corporate-managed Box account to a particular mobile… - [DocgenManager](): DocgenManager Get Box Doc Gen job by ID List all Box Doc Gen jobs Get Box Doc Gen jobs by batch ID Generate document using Box Doc Gen… - [DocgenManager](): DocgenManager Get Box Doc Gen job by ID List all Box Doc Gen jobs Get Box Doc Gen jobs by batch ID Generate document using Box Doc Gen… - [DocgenManager](): DocgenManager Get Box Doc Gen job by ID List all Box Doc Gen jobs Get Box Doc Gen jobs by batch ID Generate document using Box Doc Gen… - [DocgenManager](): DocgenManager Get Box Doc Gen job by ID List all Box Doc Gen jobs Get Box Doc Gen jobs by batch ID Generate document using Box Doc Gen… - [DocgenTemplateManager](): DocgenTemplateManager Create Box Doc Gen template List Box Doc Gen templates Delete Box Doc Gen template Get Box Doc Gen template by ID List… - [DocgenTemplateManager](): DocgenTemplateManager Create Box Doc Gen template List Box Doc Gen templates Delete Box Doc Gen template Get Box Doc Gen template by ID List… - [DocgenTemplateManager](): DocgenTemplateManager Create Box Doc Gen template List Box Doc Gen templates Delete Box Doc Gen template Get Box Doc Gen template by ID List… - [DocgenTemplateManager](): DocgenTemplateManager Create Box Doc Gen template List Box Doc Gen templates Delete Box Doc Gen template Get Box Doc Gen template by ID List… - [Documentation](): Documentation High-level Documentation General explanations of the available functionality and examples of how to use the SDK are available… - [Documentation](): Documentation Under this directory you can find documentation and samples for available SDK functionalities. You can read more about… - [Documentation](): Documentation High-level Documentation General explanations of the available functionality and examples of how to use the SDK are available… - [Documentation](): Documentation High-level Documentation General explanations of the available functionality and examples of how to use the SDK are available… - [Documentation](): Documentation High-level Documentation General explanations of the available functionality and examples of how to use the SDK are available… - [Documentation](): Documentation High-level Documentation General explanations of the available functionality and examples of how to use the SDK are available… - [Documentation](): Documentation High-level Documentation General explanations of the available functionality and examples of how to use the SDK are available… - [Downloads](): Downloads Downloads module is used to download files from Box. Downloads Download a File Get download URL Arguments Returns Download a File… - [Downloads](): Downloads Downloads module is used to download files from Box. Download a File Download a File To download a file to your device(local disk… - [DownloadsManager](): DownloadsManager Download file URL Download file Download file Download file URL Get the download URL without downloading the content. This… - [DownloadsManager](): DownloadsManager Download file URL Download file Download file Download file URL Get the download URL without downloading the content. This… - [EmailAliasesManager](): EmailAliasesManager List user's email aliases Create email alias Remove email alias List user's email aliases Retrieves all email aliases… - [EmailAliasesManager](): EmailAliasesManager List user's email aliases Create email alias Remove email alias List user's email aliases Retrieves all email aliases… - [EmailAliasesManager](): EmailAliasesManager List user's email aliases Create email alias Remove email alias List user's email aliases Retrieves all email aliases… - [EmailAliasesManager](): EmailAliasesManager List user's email aliases Create email alias Remove email alias List user's email aliases Retrieves all email aliases… - [Enterprise](): Enterprise Get Enterprise Users Invite User to Enterprise Add New User Add New App User Transfer User Content Get Enterprise Users Get a… - [Events](): Events The Box API supports two types of event streams -- one for the events specific to a particular user and one for all of the events in… - [Events](): Events The Box API provides an events endpoint that utilizes long-polling to send user events in real-time. The SDK provides an EventStream… - [Events](): Events It is possible to poll the Box API for events, in order to get information about activity within Box as it happens. The Box API… - [Events](): Events The event feed provides a way for an application to subscribe to any actions performed by any user, users, or service in an… - [EventsManager](): EventsManager Get events long poll endpoint List user and enterprise events Get events long poll endpoint Returns a list of real-time… - [EventsManager](): EventsManager Get events long poll endpoint List user and enterprise events Get events long poll endpoint Returns a list of real-time… - [EventsManager](): EventsManager Get events long poll endpoint List user and enterprise events Get events long poll endpoint Returns a list of real-time… - [EventsManager](): EventsManager Get events long poll endpoint List user and enterprise events Get events long poll endpoint Returns a list of real-time… - [Extra security (2FA)](https://developer.box.com/sign/request-options/extra-security.md): Extra security (2FA) Imagine you want an additional layer of security for your signature requests, by requesting the signer to use a… - [File Requests](): File Requests File request objects represent a file request associated with a folder. Get a File Request's Information Copy a File Request's… - [File Requests](): File Requests File request objects represent a file request associated with a folder. Get a File Request's Information Copy a File Request's… - [File Requests](): File Requests File request objects represent a file request associated with a folder. Get a File Request's Information Copy a File Request's… - [File Requests](): File Requests File request objects represent a file request associated with a folder. Get a File Request's Information Copy a File Request's… - [File Requests](): File Requests File request objects represent a file request associated with a folder. Get a File Request's Information Copy a File Request's… - [File Requests](): File Requests File request objects represent a file request associated with a folder. Get a File Request's Information Copy a File Request's… - [FileClassificationsManager](): FileClassificationsManager Get classification on file Add classification to file Update classification on file Remove classification from… - [FileClassificationsManager](): FileClassificationsManager Get classification on file Add classification to file Update classification on file Remove classification from… - [FileClassificationsManager](): FileClassificationsManager Get classification on file Add classification to file Update classification on file Remove classification from… - [FileClassificationsManager](): FileClassificationsManager Get classification on file Add classification to file Update classification on file Remove classification from… - [FileMetadataManager](): FileMetadataManager List metadata instances on file Get metadata instance on file Create metadata instance on file Update metadata instance… - [FileMetadataManager](): FileMetadataManager List metadata instances on file Get metadata instance on file Create metadata instance on file Update metadata instance… - [FileMetadataManager](): FileMetadataManager List metadata instances on file Get metadata instance on file Create metadata instance on file Update metadata instance… - [FileMetadataManager](): FileMetadataManager List metadata instances on file Get metadata instance on file Create metadata instance on file Update metadata instance… - [FileRequestsManager](): FileRequestsManager Get file request Update file request Delete file request Copy file request Get file request Retrieves the information… - [FileRequestsManager](): FileRequestsManager Get file request Update file request Delete file request Copy file request Get file request Retrieves the information… - [FileRequestsManager](): FileRequestsManager Get file request Update file request Delete file request Copy file request Get file request Retrieves the information… - [FileRequestsManager](): FileRequestsManager Get file request Update file request Delete file request Copy file request Get file request Retrieves the information… - [Files](): Files File objects represent individual files in Box. They can be used to download a file's contents, upload new versions, and perform other… - [Files](): Files File objects represent individual files in Box. They can be used to download a file's contents, upload new versions, and perform other… - [Files](): Files File objects represent individual files in Box. They can be used to download a file's contents, upload new versions, and perform other… - [Files](): Files File objects represent individual files in Box. They can be used to download a file's contents, upload new versions, and perform other… - [Files](): Files File objects represent individual files in Box. They can be used to download a file's contents, upload new versions, and perform other… - [FilesManager](): FilesManager Get file information Update file Delete file Copy file Get file thumbnail URL Get file thumbnail Get file information Retrieves… - [FilesManager](): FilesManager Get file information Update file Delete file Copy file Get file thumbnail URL Get file thumbnail Get file information Retrieves… - [FilesManager](): FilesManager Get file information Update file Delete file Copy file Get file thumbnail URL Get file thumbnail Get file information Retrieves… - [FilesManager](): FilesManager Get file information Update file Delete file Copy file Get file thumbnail URL Get file thumbnail Get file information Retrieves… - [FileVersionLegalHoldsManager](): FileVersionLegalHoldsManager Get file version legal hold List file version legal holds Get file version legal hold Retrieves information… - [FileVersionLegalHoldsManager](): FileVersionLegalHoldsManager Get file version legal hold List file version legal holds Get file version legal hold Retrieves information… - [FileVersionLegalHoldsManager](): FileVersionLegalHoldsManager Get file version legal hold List file version legal holds Get file version legal hold Retrieves information… - [FileVersionLegalHoldsManager](): FileVersionLegalHoldsManager Get file version legal hold List file version legal holds Get file version legal hold Retrieves information… - [FileVersionRetentionsManager](): FileVersionRetentionsManager List file version retentions Get retention on file List file version retentions Retrieves all file version… - [FileVersionRetentionsManager](): FileVersionRetentionsManager List file version retentions Get retention on file List file version retentions Retrieves all file version… - [FileVersionRetentionsManager](): FileVersionRetentionsManager List file version retentions Get retention on file List file version retentions Retrieves all file version… - [FileVersionRetentionsManager](): FileVersionRetentionsManager List file version retentions Get retention on file List file version retentions Retrieves all file version… - [FileVersionsManager](): FileVersionsManager List all file versions Get file version Remove file version Restore file version Promote file version List all file… - [FileVersionsManager](): FileVersionsManager List all file versions Get file version Remove file version Restore file version Promote file version List all file… - [FileVersionsManager](): FileVersionsManager List all file versions Get file version Remove file version Restore file version Promote file version List all file… - [FileVersionsManager](): FileVersionsManager List all file versions Get file version Remove file version Restore file version Promote file version List all file… - [FileWatermarksManager](): FileWatermarksManager Get watermark on file Apply watermark to file Remove watermark from file Get watermark on file Retrieve the watermark… - [FileWatermarksManager](): FileWatermarksManager Get watermark on file Apply watermark to file Remove watermark from file Get watermark on file Retrieve the watermark… - [FileWatermarksManager](): FileWatermarksManager Get watermark on file Apply watermark to file Remove watermark from file Get watermark on file Retrieve the watermark… - [FileWatermarksManager](): FileWatermarksManager Get watermark on file Apply watermark to file Remove watermark from file Get watermark on file Retrieve the watermark… - [FolderClassificationsManager](): FolderClassificationsManager Get classification on folder Add classification to folder Update classification on folder Remove classification… - [FolderClassificationsManager](): FolderClassificationsManager Get classification on folder Add classification to folder Update classification on folder Remove classification… - [FolderClassificationsManager](): FolderClassificationsManager Get classification on folder Add classification to folder Update classification on folder Remove classification… - [FolderClassificationsManager](): FolderClassificationsManager Get classification on folder Add classification to folder Update classification on folder Remove classification… - [FolderLocksManager](): FolderLocksManager List folder locks Create folder lock Delete folder lock List folder locks Retrieves folder lock details for a given… - [FolderLocksManager](): FolderLocksManager List folder locks Create folder lock Delete folder lock List folder locks Retrieves folder lock details for a given… - [FolderLocksManager](): FolderLocksManager List folder locks Create folder lock Delete folder lock List folder locks Retrieves folder lock details for a given… - [FolderLocksManager](): FolderLocksManager List folder locks Create folder lock Delete folder lock List folder locks Retrieves folder lock details for a given… - [FolderMetadataManager](): FolderMetadataManager List metadata instances on folder Get metadata instance on folder Create metadata instance on folder Update metadata… - [FolderMetadataManager](): FolderMetadataManager List metadata instances on folder Get metadata instance on folder Create metadata instance on folder Update metadata… - [FolderMetadataManager](): FolderMetadataManager List metadata instances on folder Get metadata instance on folder Create metadata instance on folder Update metadata… - [FolderMetadataManager](): FolderMetadataManager List metadata instances on folder Get metadata instance on folder Create metadata instance on folder Update metadata… - [Folders](): Folders Folder objects represent a folder from a user's account. They can be used to iterate through a folder's contents, collaborate a… - [Folders](): Folders Folder objects represent a folder from a user's account. They can be used to iterate through a folder's contents, collaborate a… - [Folders](): Folders Folder objects represent a folder from a user's account. They can be used to iterate through a folder's contents, collaborate a… - [Folders](): Folders Folder objects represent a folder from a user's account. They can be used to iterate through a folder's contents, collaborate a… - [Folders](): Folders Folder objects represent a folder from a user's account. They can be used to iterate through a folder's contents, collaborate a… - [Folders](): Folders Folder objects represent a folder from a user's account. They can be used to iterate through a folder's contents, collaborate a… - [FoldersManager](): FoldersManager Get folder information Update folder Delete folder List items in folder Create folder Copy folder Get folder information… - [FoldersManager](): FoldersManager Get folder information Update folder Delete folder List items in folder Create folder Copy folder Get folder information… - [FoldersManager](): FoldersManager Get folder information Update folder Delete folder List items in folder Create folder Copy folder Get folder information… - [FoldersManager](): FoldersManager Get folder information Update folder Delete folder List items in folder Create folder Copy folder Get folder information… - [FolderWatermarksManager](): FolderWatermarksManager Get watermark for folder Apply watermark to folder Remove watermark from folder Get watermark for folder Retrieve… - [FolderWatermarksManager](): FolderWatermarksManager Get watermark for folder Apply watermark to folder Remove watermark from folder Get watermark for folder Retrieve… - [FolderWatermarksManager](): FolderWatermarksManager Get watermark for folder Apply watermark to folder Remove watermark from folder Get watermark for folder Retrieve… - [FolderWatermarksManager](): FolderWatermarksManager Get watermark for folder Apply watermark to folder Remove watermark from folder Get watermark for folder Retrieve… - [Getting raw json response](): Getting raw json response The response returned by an API endpoint is being automatically translated to the corresponding object basing on… - [Groups](): Groups Groups contain a set of users, and can be used in place of individual users in some operations, such as collaborations. Create Group… - [Groups](): Groups Groups are sets of users that can be used in collaborations. Get All Groups Create a Group Get Information About a Group Update a… - [Groups](): Groups Groups are sets of users that can be used in collaborations. List Groups Create a Group Get Information about a Group Update a Group… - [Groups](): Groups Groups contain a set of users, and can be used in place of individual users in some operations, such as collaborations. Create Group… - [Groups](): Groups Groups contain a set of users and can be used in place of users in some operations such as collaborations. Create Group Update Group… - [Groups](): Groups Groups contain a set of users and can be used in place of users in some operations such as collaborations. Create Group Update Group… - [GroupsManager](): GroupsManager List groups for enterprise Create group Get group Update group Remove group List groups for enterprise Retrieves all of the… - [GroupsManager](): GroupsManager List groups for enterprise Create group Get group Update group Remove group List groups for enterprise Retrieves all of the… - [GroupsManager](): GroupsManager List groups for enterprise Create group Get group Update group Remove group List groups for enterprise Retrieves all of the… - [GroupsManager](): GroupsManager List groups for enterprise Create group Get group Update group Remove group List groups for enterprise Retrieves all of the… - [Handling null values in Box Dotnet SDK Gen](): Handling null values in Box Dotnet SDK Gen While using Box Dotnet SDK it's important to understand how null values behave. This document… - [Handling null values in Box Python SDK Gen](): Handling null values in Box Python SDK Gen While using Box Python SDK it's important to understand how null values behave. This document… - [Handling null values in Box Swift SDK Gen](): Handling null values in Box Swift SDK Gen While using Box Swift SDK it's important to understand how null values behave. This document… - [Handling null values in Box Typescript SDK Gen](): Handling null values in Box Typescript SDK Gen While using Box Typescript SDK it's important to understand how null values behave. This… - [HubCollaborationsManager](): HubCollaborationsManager Get hub collaborations Create hub collaboration Get hub collaboration by collaboration ID Update hub collaboration… - [HubCollaborationsManager](): HubCollaborationsManager Get hub collaborations Create hub collaboration Get hub collaboration by collaboration ID Update hub collaboration… - [HubCollaborationsManager](): HubCollaborationsManager Get hub collaborations Create hub collaboration Get hub collaboration by collaboration ID Update hub collaboration… - [HubCollaborationsManager](): HubCollaborationsManager Get hub collaborations Create hub collaboration Get hub collaboration by collaboration ID Update hub collaboration… - [HubItemsManager](): HubItemsManager Get hub items Manage hub items Get hub items Retrieves all items associated with a Hub. This operation is performed by… - [HubItemsManager](): HubItemsManager Get hub items Manage hub items Get hub items Retrieves all items associated with a Hub. This operation is performed by… - [HubItemsManager](): HubItemsManager Get hub items Manage hub items Get hub items Retrieves all items associated with a Hub. This operation is performed by… - [HubItemsManager](): HubItemsManager Get hub items Manage hub items Get hub items Retrieves all items associated with a Hub. This operation is performed by… - [HubsManager](): HubsManager List all hubs Create hub List all hubs for requesting enterprise Get hub information by ID Update hub information by ID Delete… - [HubsManager](): HubsManager List all hubs Create hub List all hubs for requesting enterprise Get hub information by ID Update hub information by ID Delete… - [HubsManager](): HubsManager List all hubs Create hub List all hubs for requesting enterprise Get hub information by ID Update hub information by ID Delete… - [HubsManager](): HubsManager List all hubs Create hub List all hubs for requesting enterprise Get hub information by ID Update hub information by ID Delete… - [IAiManager](): IAiManager Ask question Generate text Get AI agent default configuration Extract metadata (freeform) Extract metadata (structured) Ask… - [IAiStudioManager](): IAiStudioManager List AI agents Create AI agent Update AI agent Get AI agent by agent ID Delete AI agent List AI agents Lists AI agents… - [IAppItemAssociationsManager](): IAppItemAssociationsManager List file app item associations List folder app item associations List file app item associations This is a beta… - [IArchivesManager](): IArchivesManager List archives Create archive Delete archive List archives Retrieves archives for an enterprise. This operation is performed… - [IAuthorizationManager](): IAuthorizationManager Authorize user Request access token Refresh access token Revoke access token Authorize user Authorize a user by… - [IAvatarsManager](): IAvatarsManager Get user avatar Add or update user avatar Delete user avatar Get user avatar Retrieves an image of a the user's avatar. This… - [IChunkedUploadsManager](): IChunkedUploadsManager Create upload session Create upload session for existing file Get upload session by URL Get upload session Upload… - [IClassificationsManager](): IClassificationsManager List all classifications Add classification Update classification Add initial classifications List all… - [ICollaborationAllowlistEntriesManager](): ICollaborationAllowlistEntriesManager List allowed collaboration domains Add domain to list of allowed collaboration domains Get allowed… - [ICollaborationAllowlistExemptTargetsManager](): ICollaborationAllowlistExemptTargetsManager List users exempt from collaboration domain restrictions Create user exemption from… - [ICollectionsManager](): ICollectionsManager List all collections List collection items Get collection by ID List all collections Retrieves all collections for a… - [ICommentsManager](): ICommentsManager List file comments Get comment Update comment Remove comment Create comment List file comments Retrieves a list of comments… - [IDevicePinnersManager](): IDevicePinnersManager Get device pin Remove device pin List enterprise device pins Get device pin Retrieves information about an individual… - [IDocgenManager](): IDocgenManager Get Box Doc Gen job by ID List all Box Doc Gen jobs Get Box Doc Gen jobs by batch ID Generate document using Box Doc Gen… - [IDocgenTemplateManager](): IDocgenTemplateManager Create Box Doc Gen template List Box Doc Gen templates Delete Box Doc Gen template Get Box Doc Gen template by ID… - [IDownloadsManager](): IDownloadsManager Download file URL Download file Download file URL Get the download URL without downloading the content. This operation is… - [IEmailAliasesManager](): IEmailAliasesManager List user's email aliases Create email alias Remove email alias List user's email aliases Retrieves all email aliases… - [IEventsManager](): IEventsManager Get events long poll endpoint List user and enterprise events Get events long poll endpoint Returns a list of real-time… - [IFileClassificationsManager](): IFileClassificationsManager Get classification on file Add classification to file Update classification on file Remove classification from… - [IFileMetadataManager](): IFileMetadataManager List metadata instances on file Get metadata instance on file Create metadata instance on file Update metadata instance… - [IFileRequestsManager](): IFileRequestsManager Get file request Update file request Delete file request Copy file request Get file request Retrieves the information… - [IFilesManager](): IFilesManager Get file information Update file Delete file Copy file Get file thumbnail URL Get file thumbnail Get file information… - [IFileVersionLegalHoldsManager](): IFileVersionLegalHoldsManager Get file version legal hold List file version legal holds Get file version legal hold Retrieves information… - [IFileVersionRetentionsManager](): IFileVersionRetentionsManager List file version retentions Get retention on file List file version retentions Retrieves all file version… - [IFileVersionsManager](): IFileVersionsManager List all file versions Get file version Remove file version Restore file version Promote file version List all file… - [IFileWatermarksManager](): IFileWatermarksManager Get watermark on file Apply watermark to file Remove watermark from file Get watermark on file Retrieve the watermark… - [IFolderClassificationsManager](): IFolderClassificationsManager Get classification on folder Add classification to folder Update classification on folder Remove… - [IFolderLocksManager](): IFolderLocksManager List folder locks Create folder lock Delete folder lock List folder locks Retrieves folder lock details for a given… - [IFolderMetadataManager](): IFolderMetadataManager List metadata instances on folder Get metadata instance on folder Create metadata instance on folder Update metadata… - [IFoldersManager](): IFoldersManager Get folder information Update folder Delete folder List items in folder Create folder Copy folder Get folder information… - [IFolderWatermarksManager](): IFolderWatermarksManager Get watermark for folder Apply watermark to folder Remove watermark from folder Get watermark for folder Retrieve… - [IGroupsManager](): IGroupsManager List groups for enterprise Create group Get group Update group Remove group List groups for enterprise Retrieves all of the… - [IHubCollaborationsManager](): IHubCollaborationsManager Get hub collaborations Create hub collaboration Get hub collaboration by collaboration ID Update hub collaboration… - [IHubItemsManager](): IHubItemsManager Get hub items Manage hub items Get hub items Retrieves all items associated with a Hub. This operation is performed by… - [IHubsManager](): IHubsManager List all hubs Create hub List all hubs for requesting enterprise Get hub information by ID Update hub information by ID Delete… - [IIntegrationMappingsManager](): IIntegrationMappingsManager List Slack integration mappings Create Slack integration mapping Update Slack integration mapping Delete Slack… - [IInvitesManager](): IInvitesManager Create user invite Get user invite status Create user invite Invites an existing external user to join an enterprise. The… - [ILegalHoldPoliciesManager](): ILegalHoldPoliciesManager List all legal hold policies Create legal hold policy Get legal hold policy Update legal hold policy Remove legal… - [ILegalHoldPolicyAssignmentsManager](): ILegalHoldPolicyAssignmentsManager List legal hold policy assignments Assign legal hold policy Get legal hold policy assignment Unassign… - [IListCollaborationsManager](): IListCollaborationsManager List file collaborations List folder collaborations List pending collaborations List group collaborations List… - [IMembershipsManager](): IMembershipsManager List user's groups List members of group Add user to group Get group membership Update group membership Remove user from… - [IMetadataCascadePoliciesManager](): IMetadataCascadePoliciesManager List metadata cascade policies Create metadata cascade policy Get metadata cascade policy Remove metadata… - [IMetadataTemplatesManager](): IMetadataTemplatesManager Find metadata template by instance ID Get metadata template by name Update metadata template Remove metadata… - [In person signatures](https://developer.box.com/sign/request-options/in-person.md): In person signatures Imagine your application is used by a salesperson when they are face to face with a customer and an immediate signature… - [Information Barrier Reports](): Information Barrier Reports Information Barrier Reports Get shield information barrier report by ID List shield information barrier reports… - [Information Barrier Segment Members](): Information Barrier Segment Members Information Barrier Segment Members Get shield information barrier segment member by ID List shield… - [Information Barrier Segment Restrictions](): Information Barrier Segment Restrictions Information Barrier Segment Restrictions Get shield information barrier segment restriction by ID… - [Information Barrier Segments](): Information Barrier Segments Information barrier segments (or just segments) are defined groups of users. They are different from user… - [Information Barriers](): Information Barriers Get shield information barrier with specified ID Get all shield information barriers Update shield information barrier… - [Installation](): fastlane documentation Installation Make sure you have the latest version of the Xcode command line tools installed: For fastlane… - [Integration mappings](): Integration mappings With integration mappings, you can manage where content from partner apps is stored in Box. It is well suited for… - [Integration tests](): Integration tests Setup To run the integration tests locally, you need an existing Box app. Create a platform app in https://cloud.app.box… - [Integration Tests](): Integration Tests Running integration tests locally Create Platform Application To run integration tests locally you will need a Custom App… - [Integration Tests](): Integration Tests Running integration tests locally Create Platform Application To run integration tests locally you will need a Custom App… - [Integration Tests](): Integration Tests Running integration tests locally Create Platform Application To run integration tests locally you will need a Custom App… - [Integration Tests](): Integration Tests Running integration tests locally Create Platform Application To run integration tests locally you will need a Custom App… - [IntegrationMappingsManager](): IntegrationMappingsManager List Slack integration mappings Create Slack integration mapping Update Slack integration mapping Delete Slack… - [IntegrationMappingsManager](): IntegrationMappingsManager List Slack integration mappings Create Slack integration mapping Update Slack integration mapping Delete Slack… - [IntegrationMappingsManager](): IntegrationMappingsManager List Slack integration mappings Create Slack integration mapping Update Slack integration mapping Delete Slack… - [IntegrationMappingsManager](): IntegrationMappingsManager List Slack integration mappings Create Slack integration mapping Update Slack integration mapping Delete Slack… - [InvitesManager](): InvitesManager Create user invite Get user invite status Create user invite Invites an existing external user to join an enterprise. The… - [InvitesManager](): InvitesManager Create user invite Get user invite status Create user invite Invites an existing external user to join an enterprise. The… - [InvitesManager](): InvitesManager Create user invite Get user invite status Create user invite Invites an existing external user to join an enterprise. The… - [InvitesManager](): InvitesManager Create user invite Get user invite status Create user invite Invites an existing external user to join an enterprise. The… - [IRecentItemsManager](): IRecentItemsManager List recently accessed items List recently accessed items Returns information about the recent items accessed by a user… - [IRetentionPoliciesManager](): IRetentionPoliciesManager List retention policies Create retention policy Get retention policy Update retention policy Delete retention… - [IRetentionPolicyAssignmentsManager](): IRetentionPolicyAssignmentsManager List retention policy assignments Assign retention policy Get retention policy assignment Remove… - [ISearchManager](): ISearchManager Query files/folders by metadata Search for content Query files/folders by metadata Create a search using SQL-like syntax to… - [ISessionTerminationManager](): ISessionTerminationManager Create jobs to terminate users session Create jobs to terminate user group session Create jobs to terminate users… - [ISharedLinksAppItemsManager](): ISharedLinksAppItemsManager Find app item for shared link Find app item for shared link Returns the app item represented by a shared link… - [ISharedLinksFilesManager](): ISharedLinksFilesManager Find file for shared link Get shared link for file Add shared link to file Update shared link on file Remove shared… - [ISharedLinksFoldersManager](): ISharedLinksFoldersManager Find folder for shared link Get shared link for folder Add shared link to folder Update shared link on folder… - [ISharedLinksWebLinksManager](): ISharedLinksWebLinksManager Find web link for shared link Get shared link for web link Add shared link to web link Update shared link on web… - [IShieldInformationBarrierReportsManager](): IShieldInformationBarrierReportsManager List shield information barrier reports Create shield information barrier report Get shield… - [IShieldInformationBarrierSegmentMembersManager](): IShieldInformationBarrierSegmentMembersManager Get shield information barrier segment member by ID Delete shield information barrier segment… - [IShieldInformationBarrierSegmentRestrictionsManager](): IShieldInformationBarrierSegmentRestrictionsManager Get shield information barrier segment restriction by ID Delete shield information… - [IShieldInformationBarrierSegmentsManager](): IShieldInformationBarrierSegmentsManager Get shield information barrier segment with specified ID Delete shield information barrier segment… - [IShieldInformationBarriersManager](): IShieldInformationBarriersManager Get shield information barrier with specified ID Add changed status of shield information barrier with… - [IShieldListsManager](): IShieldListsManager Get all shield lists in enterprise Create shield list Get single shield list by shield list id Delete single shield list… - [ISignRequestsManager](): ISignRequestsManager Cancel Box Sign request Resend Box Sign request Get Box Sign request by ID List Box Sign requests Create Box Sign… - [ISignTemplatesManager](): ISignTemplatesManager List Box Sign templates Get Box Sign template by ID List Box Sign templates Gets Box Sign templates created by a user… - [ISkillsManager](): ISkillsManager List Box Skill cards on file Create Box Skill cards on file Update Box Skill cards on file Remove Box Skill cards from file… - [IStoragePoliciesManager](): IStoragePoliciesManager List storage policies Get storage policy List storage policies Fetches all the storage policies in the enterprise… - [IStoragePolicyAssignmentsManager](): IStoragePolicyAssignmentsManager List storage policy assignments Assign storage policy Get storage policy assignment Update storage policy… - [ITaskAssignmentsManager](): ITaskAssignmentsManager List task assignments Assign task Get task assignment Update task assignment Unassign task List task assignments… - [ITasksManager](): ITasksManager List tasks on file Create task Get task Update task Remove task List tasks on file Retrieves a list of all the tasks for a… - [ITermsOfServicesManager](): ITermsOfServicesManager List terms of services Create terms of service Get terms of service Update terms of service List terms of services… - [ITermsOfServiceUserStatusesManager](): ITermsOfServiceUserStatusesManager List terms of service user statuses Create terms of service status for new user Update terms of service… - [ITransferManager](): ITransferManager Transfer owned folders Transfer owned folders Move all of the items (files, folders and workflows) owned by a user into… - [ITrashedFilesManager](): ITrashedFilesManager Restore file Get trashed file Permanently remove file Restore file Restores a file that has been moved to the trash. An… - [ITrashedFoldersManager](): ITrashedFoldersManager Restore folder Get trashed folder Permanently remove folder Restore folder Restores a folder that has been moved to… - [ITrashedItemsManager](): ITrashedItemsManager List trashed items List trashed items Retrieves the files and folders that have been moved to the trash. Any attribute… - [ITrashedWebLinksManager](): ITrashedWebLinksManager Restore web link Get trashed web link Permanently remove web link Restore web link Restores a web link that has been… - [IUploadsManager](): IUploadsManager Upload file version Preflight check before upload Upload file Upload a file with a preflight check Upload file version… - [IUserCollaborationsManager](): IUserCollaborationsManager Get collaboration Update collaboration Remove collaboration Create collaboration Get collaboration Retrieves a… - [IUsersManager](): IUsersManager List enterprise users Create user Get current user Get user Update user Delete user List enterprise users Returns a list of… - [IWebhooksManager](): IWebhooksManager List all webhooks Create webhook Get webhook Update webhook Remove webhook List all webhooks Returns all defined webhooks… - [IWebLinksManager](): IWebLinksManager Create web link Get web link Update web link Remove web link Create web link Creates a web link object within a folder… - [IWorkflowsManager](): IWorkflowsManager List workflows Starts workflow based on request body List workflows Returns list of workflows that act on a given folder… - [IZipDownloadsManager](): IZipDownloadsManager Create zip download Download zip archive Get zip download status Download ZIP Create zip download Creates a request to… - [Legal Hold Policies](): Legal Hold Policies A legal hold policy blocks permanent deletion of content during ongoing litigation. Admins can create legal hold… - [Legal Hold Policies](): Legal Hold Policies A legal hold policy blocks permanent deletion of content during ongoing litigation. Admins can create legal hold… - [Legal Hold Policies](): Legal Hold Policies A legal hold policy blocks permanent deletion of content during ongoing litigation. Admins can create legal hold… - [Legal Holds](): Legal Holds Get Legal Hold Policy Info Create Legal Hold Policy Update Legal Hold Policy Delete Legal Hold Policy Get Legal Hold Policies… - [Legal Holds](): Legal Holds Get Legal Hold Policy Info Create Legal Hold Policy Update Legal Hold Policy Delete Legal Hold Policy Get Legal Hold Policies… - [Legal Holds Policy](): Legal Holds Policy Legal Hold Policy information describes the basic characteristics of the Policy, such as name, description, and filter… - [LegalHoldPoliciesManager](): LegalHoldPoliciesManager List all legal hold policies Create legal hold policy Get legal hold policy Update legal hold policy Remove legal… - [LegalHoldPoliciesManager](): LegalHoldPoliciesManager List all legal hold policies Create legal hold policy Get legal hold policy Update legal hold policy Remove legal… - [LegalHoldPoliciesManager](): LegalHoldPoliciesManager List all legal hold policies Create legal hold policy Get legal hold policy Update legal hold policy Remove legal… - [LegalHoldPoliciesManager](): LegalHoldPoliciesManager List all legal hold policies Create legal hold policy Get legal hold policy Update legal hold policy Remove legal… - [LegalHoldPolicyAssignmentsManager](): LegalHoldPolicyAssignmentsManager List legal hold policy assignments Assign legal hold policy Get legal hold policy assignment Unassign… - [LegalHoldPolicyAssignmentsManager](): LegalHoldPolicyAssignmentsManager List legal hold policy assignments Assign legal hold policy Get legal hold policy assignment Unassign… - [LegalHoldPolicyAssignmentsManager](): LegalHoldPolicyAssignmentsManager List legal hold policy assignments Assign legal hold policy Get legal hold policy assignment Unassign… - [LegalHoldPolicyAssignmentsManager](): LegalHoldPolicyAssignmentsManager List legal hold policy assignments Assign legal hold policy Get legal hold policy assignment Unassign… - [ListCollaborationsManager](): ListCollaborationsManager List file collaborations List folder collaborations List pending collaborations List group collaborations List… - [ListCollaborationsManager](): ListCollaborationsManager List file collaborations List folder collaborations List pending collaborations List group collaborations List… - [ListCollaborationsManager](): ListCollaborationsManager List file collaborations List folder collaborations List pending collaborations List group collaborations List… - [ListCollaborationsManager](): ListCollaborationsManager List file collaborations List folder collaborations List pending collaborations List group collaborations List… - [Logging in SDK](): Logging in SDK We are using Java Util Logging within Box Java SDK. You can read about details of this approach here. Logging Levels We are… - [MembershipsManager](): MembershipsManager List user's groups List members of group Add user to group Get group membership Update group membership Remove user from… - [MembershipsManager](): MembershipsManager List user's groups List members of group Add user to group Get group membership Update group membership Remove user from… - [MembershipsManager](): MembershipsManager List user's groups List members of group Add user to group Get group membership Update group membership Remove user from… - [MembershipsManager](): MembershipsManager List user's groups List members of group Add user to group Get group membership Update group membership Remove user from… - [Metadata](): Metadata Metadata allows users and applications to define and store custom data associated with their files/folders. Metadata consists of… - [Metadata](): Metadata Metadata allows users and applications to define and store custom data associated with their files/folders. Metadata consists of… - [Metadata](): Metadata Metadata allows users and applications to define and store custom data associated with their files/folders. Metadata consists of… - [Metadata](): Metadata Metadata allows users and applications to define and store custom data associated with their files/folders. Metadata consists of… - [Metadata](): Metadata Metadata allows users and applications to define and store custom data associated with their files/folders. Metadata consists of… - [Metadata Cascade Policies](): Metadata Cascade Policies Metadata Cascade Policies allow the metadata values on a folder to be applied to the files within that folder. A… - [Metadata Cascade Policies](): Metadata Cascade Policies A metadata cascade policy indicates if a metadata instance value should be cascaded to files and subfolders in a… - [Metadata Templates](): Metadata Templates Metadata that belongs to a file is grouped by templates. Templates allow the metadata service to provide a multitude of… - [MetadataCascadePoliciesManager](): MetadataCascadePoliciesManager List metadata cascade policies Create metadata cascade policy Get metadata cascade policy Remove metadata… - [MetadataCascadePoliciesManager](): MetadataCascadePoliciesManager List metadata cascade policies Create metadata cascade policy Get metadata cascade policy Remove metadata… - [MetadataCascadePoliciesManager](): MetadataCascadePoliciesManager List metadata cascade policies Create metadata cascade policy Get metadata cascade policy Remove metadata… - [MetadataCascadePoliciesManager](): MetadataCascadePoliciesManager List metadata cascade policies Create metadata cascade policy Get metadata cascade policy Remove metadata… - [MetadataTemplatesManager](): MetadataTemplatesManager Find metadata template by instance ID Get metadata template by name Update metadata template Remove metadata… - [MetadataTemplatesManager](): MetadataTemplatesManager Find metadata template by instance ID Get metadata template by name Update metadata template Remove metadata… - [MetadataTemplatesManager](): MetadataTemplatesManager Find metadata template by instance ID Get metadata template by name Update metadata template Remove metadata… - [MetadataTemplatesManager](): MetadataTemplatesManager Find metadata template by instance ID Get metadata template by name Update metadata template Remove metadata… - [Migration guide for versions 2.x.x -> 3.x.x](): Migration guide for versions 2.x.x -> 3.x.x Runtime requirements Dependencies jsonwebtoken Removed deprecated methods and classes… - [Migration guide for versions 3.x.x -> 4.x.x](): Migration guide for versions 3.x.x -> 4.x.x Configuration changes BoxDeveloperEditionAPIConnection MaxRequestAttempts Removed deprecated… - [Migration guide from `box-java-sdk` to `box-java-sdk-gen`](): Migration guide from box-java-sdk to box-java-sdk-gen Introduction Installation Maven Gradle Key differences Manager approach Immutable… - [Migration guide from `boxsdk` to `box-sdk-gen`](): Migration guide from boxsdk to box-sdk-gen Introduction Installation Key differences Manager approach Explicitly defined schemas Immutable… - [Migration Guide: From `Box iOS SDK` to `Box Swift SDK`](): Migration Guide: From Box iOS SDK to Box Swift SDK Introduction Installation Swift Package Manager Carthage Highlighting the Key Differences… - [Migration Guide: From `Box Node SDK` to `Box TypeScript SDK`](): Migration Guide: From Box Node SDK to Box TypeScript SDK Migration Guide: From Box Node SDK to Box TypeScript SDK Introduction Installation… - [Migration Guide: From `Box Windows V2 SDK` to `Box Dotnet SDK`](): Migration Guide: From Box Windows V2 SDK to Box Dotnet SDK Introduction Installation Highlighting the Key Differences Nullable reference… - [Multiple signers and roles](https://developer.box.com/sign/request-options/multiple-signers.md): Multiple signers and roles Multiple signers What if you have a document that needs to be signed by multiple people? This is typical for… - [Quick start](https://developer.box.com/sign/quick-start.md): Quick start Get a sense of how the Box Sign API is structured and how to create your first signature request. The Sign API does not follow… - [Quick Starts](https://developer.box.com/get-started.md): Quick Starts - [Recent Items](): Recent Items Recent Items returns information about files that have been accessed by a user not long ago. It keeps track of items that were… - [Recent Items](): Recent Items Recent Items returns information about files that have been accessed by a user not long ago. It keeps track of items that were… - [Recent Items](): Recent Items Recent Items returns information about files that have been accessed by a user not long ago. It keeps track of items that were… - [Recent Items](): Recent Items A recent item object represents a file that has been recently accessed by a user. Items accessed either in the last 90 days or… - [Recent Items](): Recent Items A recent item object represents a file that has been recently accessed by a user. Items accessed either in the last 90 days or… - [RecentItemsManager](): RecentItemsManager List recently accessed items List recently accessed items Returns information about the recent items accessed by a user… - [RecentItemsManager](): RecentItemsManager List recently accessed items List recently accessed items Returns information about the recent items accessed by a user… - [RecentItemsManager](): RecentItemsManager List recently accessed items List recently accessed items Returns information about the recent items accessed by a user… - [RecentItemsManager](): RecentItemsManager List recently accessed items List recently accessed items Returns information about the recent items accessed by a user… - [Redirect URLs](https://developer.box.com/sign/request-options/custom-urls.md): Redirect URLs Often after signing a document your company might want to redirect the user to a specific web page like a thank you or an… - [Redirect user to auth_url, where they will enter their Box credentials](): Authentication The Box API uses OAuth2 for authentication, which can be difficult to implement. The SDK makes it easier by providing classes… - [Request expiration](https://developer.box.com/sign/request-options/request-expiration.md): Request expiration There are situations where you might need to set an expiration date for the signature request. For example, imagine a… - [Request options](https://developer.box.com/sign/request-options.md): Request options The Box Sign API offers a wide range of customization and configuration options when sending signature requests. These… - [Resend requests](https://developer.box.com/sign/request-options/resend-requests.md): Resend requests What if the signer did not receive the email, the email was lost, or the signer deleted the email by mistake? You can resend… - [Retention Policies](): Retention Policies A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention… - [Retention Policies](): Retention Policies A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention… - [Retention Policies](): Retention Policies A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention… - [Retention Policies](): Retention Policies A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention… - [Retention Policies](): Retention Policies A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention… - [Retention Policies](): Retention Policies A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention… - [RetentionPoliciesManager](): RetentionPoliciesManager List retention policies Create retention policy Get retention policy Update retention policy Delete retention… - [RetentionPoliciesManager](): RetentionPoliciesManager List retention policies Create retention policy Get retention policy Update retention policy Delete retention… - [RetentionPoliciesManager](): RetentionPoliciesManager List retention policies Create retention policy Get retention policy Update retention policy Delete retention… - [RetentionPoliciesManager](): RetentionPoliciesManager List retention policies Create retention policy Get retention policy Update retention policy Delete retention… - [RetentionPolicyAssignmentsManager](): RetentionPolicyAssignmentsManager List retention policy assignments Assign retention policy Get retention policy assignment Remove retention… - [RetentionPolicyAssignmentsManager](): RetentionPolicyAssignmentsManager List retention policy assignments Assign retention policy Get retention policy assignment Remove retention… - [RetentionPolicyAssignmentsManager](): RetentionPolicyAssignmentsManager List retention policy assignments Assign retention policy Get retention policy assignment Remove retention… - [RetentionPolicyAssignmentsManager](): RetentionPolicyAssignmentsManager List retention policy assignments Assign retention policy Get retention policy assignment Remove retention… - [SDK Overview](): SDK Overview This guide covers the basics behind the various components of the Box Java SDK. It's also recommended that you take a look at… - [SDKs & Tools](https://developer.box.com/sdks-and-tools.md): SDKs & Tools The following SDKs and tools are developed and supported by Box. SDKs Here you will find a list of SDKs you can use to build… - [Search](): Search Search for Content Search for Content To get a list of items matching a search query, call the search.query(searchQuery, options… - [Search](): Search Different examples of search which have been implemented in the example SearchExamplesAsAppUser.java For more information refer to… - [Search](): Search Search provides a powerful way of finding items that are accessible by a single user or an entire enterprise. Search for Content… - [Search](): Search Search for Content Search for Content with Shared Link Items Metadata Search Search for Content To get a list of items matching a… - [Search](): Search Content Search Content Search with Shared Link Items Metadata Search Content Search To get a list of items matching a search query… - [Search](): Search Content Search Content Search with Shared Link Items Metadata Search Content Search To get a list of items matching a search query… - [SearchManager](): SearchManager Query files/folders by metadata Search for content Query files/folders by metadata Create a search using SQL-like syntax to… - [SearchManager](): SearchManager Query files/folders by metadata Search for content Query files/folders by metadata Create a search using SQL-like syntax to… - [SearchManager](): SearchManager Query files/folders by metadata Search for content Query files/folders by metadata Create a search using SQL-like syntax to… - [SearchManager](): SearchManager Query files/folders by metadata Search for content Query files/folders by metadata Create a search using SQL-like syntax to… - [SessionTerminationManager](): SessionTerminationManager Create jobs to terminate users session Create jobs to terminate user group session Create jobs to terminate users… - [SessionTerminationManager](): SessionTerminationManager Create jobs to terminate users session Create jobs to terminate user group session Create jobs to terminate users… - [SessionTerminationManager](): SessionTerminationManager Create jobs to terminate users session Create jobs to terminate user group session Create jobs to terminate users… - [SessionTerminationManager](): SessionTerminationManager Create jobs to terminate users session Create jobs to terminate user group session Create jobs to terminate users… - [Shared Items](): Shared Items Shared Items represent files and folders on Box accessed via a shared link. Get a Shared Item Get a Shared Item To get the file… - [Shared Items](): Shared Items Shared Items represent files and folders on Box accessed via a shared link. Get a Shared Item Get a Shared Item To get the file… - [Shared Items](): Shared Items Shared Items represent files and folders on Box available via a shared link. Get Shared Item Get Shared Item To get the file or… - [Shared Items](): Shared Items Shared Items represent files and folders on Box available via a shared link. Get Shared Item Get Shared Item To get the file or… - [SharedLinksAppItemsManager](): SharedLinksAppItemsManager Find app item for shared link Find app item for shared link Returns the app item represented by a shared link… - [SharedLinksAppItemsManager](): SharedLinksAppItemsManager Find app item for shared link Find app item for shared link Returns the app item represented by a shared link… - [SharedLinksAppItemsManager](): SharedLinksAppItemsManager Find app item for shared link Find app item for shared link Returns the app item represented by a shared link… - [SharedLinksAppItemsManager](): SharedLinksAppItemsManager Find app item for shared link Find app item for shared link Returns the app item represented by a shared link… - [SharedLinksFilesManager](): SharedLinksFilesManager Find file for shared link Get shared link for file Add shared link to file Update shared link on file Remove shared… - [SharedLinksFilesManager](): SharedLinksFilesManager Find file for shared link Get shared link for file Add shared link to file Update shared link on file Remove shared… - [SharedLinksFilesManager](): SharedLinksFilesManager Find file for shared link Get shared link for file Add shared link to file Update shared link on file Remove shared… - [SharedLinksFilesManager](): SharedLinksFilesManager Find file for shared link Get shared link for file Add shared link to file Update shared link on file Remove shared… - [SharedLinksFoldersManager](): SharedLinksFoldersManager Find folder for shared link Get shared link for folder Add shared link to folder Update shared link on folder… - [SharedLinksFoldersManager](): SharedLinksFoldersManager Find folder for shared link Get shared link for folder Add shared link to folder Update shared link on folder… - [SharedLinksFoldersManager](): SharedLinksFoldersManager Find folder for shared link Get shared link for folder Add shared link to folder Update shared link on folder… - [SharedLinksFoldersManager](): SharedLinksFoldersManager Find folder for shared link Get shared link for folder Add shared link to folder Update shared link on folder… - [SharedLinksWebLinksManager](): SharedLinksWebLinksManager Find web link for shared link Get shared link for web link Add shared link to web link Update shared link on web… - [SharedLinksWebLinksManager](): SharedLinksWebLinksManager Find web link for shared link Get shared link for web link Add shared link to web link Update shared link on web… - [SharedLinksWebLinksManager](): SharedLinksWebLinksManager Find web link for shared link Get shared link for web link Add shared link to web link Update shared link on web… - [SharedLinksWebLinksManager](): SharedLinksWebLinksManager Find web link for shared link Get shared link for web link Add shared link to web link Update shared link on web… - [ShieldInformationBarrierReportsManager](): ShieldInformationBarrierReportsManager List shield information barrier reports Create shield information barrier report Get shield… - [ShieldInformationBarrierReportsManager](): ShieldInformationBarrierReportsManager List shield information barrier reports Create shield information barrier report Get shield… - [ShieldInformationBarrierReportsManager](): ShieldInformationBarrierReportsManager List shield information barrier reports Create shield information barrier report Get shield… - [ShieldInformationBarrierReportsManager](): ShieldInformationBarrierReportsManager List shield information barrier reports Create shield information barrier report Get shield… - [ShieldInformationBarrierSegmentMembersManager](): ShieldInformationBarrierSegmentMembersManager Get shield information barrier segment member by ID Delete shield information barrier segment… - [ShieldInformationBarrierSegmentMembersManager](): ShieldInformationBarrierSegmentMembersManager Get shield information barrier segment member by ID Delete shield information barrier segment… - [ShieldInformationBarrierSegmentMembersManager](): ShieldInformationBarrierSegmentMembersManager Get shield information barrier segment member by ID Delete shield information barrier segment… - [ShieldInformationBarrierSegmentMembersManager](): ShieldInformationBarrierSegmentMembersManager Get shield information barrier segment member by ID Delete shield information barrier segment… - [ShieldInformationBarrierSegmentRestrictionsManager](): ShieldInformationBarrierSegmentRestrictionsManager Get shield information barrier segment restriction by ID Delete shield information… - [ShieldInformationBarrierSegmentRestrictionsManager](): ShieldInformationBarrierSegmentRestrictionsManager Get shield information barrier segment restriction by ID Delete shield information… - [ShieldInformationBarrierSegmentRestrictionsManager](): ShieldInformationBarrierSegmentRestrictionsManager Get shield information barrier segment restriction by ID Delete shield information… - [ShieldInformationBarrierSegmentRestrictionsManager](): ShieldInformationBarrierSegmentRestrictionsManager Get shield information barrier segment restriction by ID Delete shield information… - [ShieldInformationBarrierSegmentsManager](): ShieldInformationBarrierSegmentsManager Get shield information barrier segment with specified ID Delete shield information barrier segment… - [ShieldInformationBarrierSegmentsManager](): ShieldInformationBarrierSegmentsManager Get shield information barrier segment with specified ID Delete shield information barrier segment… - [ShieldInformationBarrierSegmentsManager](): ShieldInformationBarrierSegmentsManager Get shield information barrier segment with specified ID Delete shield information barrier segment… - [ShieldInformationBarrierSegmentsManager](): ShieldInformationBarrierSegmentsManager Get shield information barrier segment with specified ID Delete shield information barrier segment… - [ShieldInformationBarriersManager](): ShieldInformationBarriersManager Get shield information barrier with specified ID Add changed status of shield information barrier with… - [ShieldInformationBarriersManager](): ShieldInformationBarriersManager Get shield information barrier with specified ID Add changed status of shield information barrier with… - [ShieldInformationBarriersManager](): ShieldInformationBarriersManager Get shield information barrier with specified ID Add changed status of shield information barrier with… - [ShieldInformationBarriersManager](): ShieldInformationBarriersManager Get shield information barrier with specified ID Add changed status of shield information barrier with… - [ShieldListsManager](): ShieldListsManager Get all shield lists in enterprise Create shield list Get single shield list by shield list id Delete single shield list… - [ShieldListsManager](): ShieldListsManager Get all shield lists in enterprise Create shield list Get single shield list by shield list id Delete single shield list… - [ShieldListsManager](): ShieldListsManager Get all shield lists in enterprise Create shield list Get single shield list by shield list id Delete single shield list… - [ShieldListsManager](): ShieldListsManager Get all shield lists in enterprise Create shield list Get single shield list by shield list id Delete single shield list… - [Sign Requests](): Sign Requests Get sign request by ID List sign requests Create sign request Cancel sign request Resend sign request Get sign request by ID… - [Sign Requests](): Sign Requests Sign Requests are used to request e-signatures on documents from signers. A Sign Request can refer to one or more Box Files… - [Sign Requests](): Sign Requests Sign Requests are used to request e-signatures on documents from signers. A Sign Request can refer to one or more Box Files… - [Sign Requests](): Sign Requests Sign Requests are used to request e-signatures on documents from signers. A Sign Request can refer to one or more Box Files… - [Sign Requests](): Sign Requests Sign Requests are used to request e-signatures on documents from signers. A Sign Request can refer to one or more Box Files… - [Sign Requests](): Sign Requests Sign Requests are used to request e-signatures on documents from signers. A Sign Request can refer to one or more Box Files… - [Sign Templates](): Sign Templates Get sign template by ID List sign templates Get sign template by ID Gets a sign template by ID signTemplates.getById(options… - [Sign Templates](): Sign Templates Box Sign enables you to create templates so you can automatically add the same fields and formatting to requests for… - [Sign Templates](): Sign Templates Sign Templates are reusable templates that can be used to create Sign Requests. For now, Sign Templates can only be created… - [Sign Templates](): Sign Templates Box Sign enables you to create templates so you can automatically add the same fields and formatting to requests for… - [Sign webhooks](https://developer.box.com/sign/webhooks.md): Sign webhooks Sign webhooks allow you to receive notifications about events that happen with Box Sign signature requests. You can use them… - [Signing structured docs](https://developer.box.com/sign/technical-use-cases/sign-structured-docs.md): Signing structured docs A structured document in the context of Box Sign is a document that includes specific tags that can be recognized by… - [Signing unstructured docs](https://developer.box.com/sign/technical-use-cases/sign-unstructured-docs.md): Signing unstructured docs Imagine a document management app, where users can upload a document and ask anyone to sign it. In this case your… - [Signing using templates](https://developer.box.com/sign/technical-use-cases/sign-template.md): Signing using templates A Box Sign template is a specific type of document that not only contains the text, but also the signature… - [SignRequestsManager](): SignRequestsManager Cancel Box Sign request Resend Box Sign request Get Box Sign request by ID List Box Sign requests Create Box Sign… - [SignRequestsManager](): SignRequestsManager Cancel Box Sign request Resend Box Sign request Get Box Sign request by ID List Box Sign requests Create Box Sign… - [SignRequestsManager](): SignRequestsManager Cancel Box Sign request Resend Box Sign request Get Box Sign request by ID List Box Sign requests Create Box Sign… - [SignRequestsManager](): SignRequestsManager Cancel Box Sign request Resend Box Sign request Get Box Sign request by ID List Box Sign requests Create Box Sign… - [SignTemplatesManager](): SignTemplatesManager List Box Sign templates Get Box Sign template by ID List Box Sign templates Gets Box Sign templates created by a user… - [SignTemplatesManager](): SignTemplatesManager List Box Sign templates Get Box Sign template by ID List Box Sign templates Gets Box Sign templates created by a user… - [SignTemplatesManager](): SignTemplatesManager List Box Sign templates Get Box Sign template by ID List Box Sign templates Gets Box Sign templates created by a user… - [SignTemplatesManager](): SignTemplatesManager List Box Sign templates Get Box Sign template by ID List Box Sign templates Gets Box Sign templates created by a user… - [SkillsManager](): SkillsManager List Box Skill cards on file Create Box Skill cards on file Update Box Skill cards on file Remove Box Skill cards from file… - [SkillsManager](): SkillsManager List Box Skill cards on file Create Box Skill cards on file Update Box Skill cards on file Remove Box Skill cards from file… - [SkillsManager](): SkillsManager List Box Skill cards on file Create Box Skill cards on file Update Box Skill cards on file Remove Box Skill cards from file… - [SkillsManager](): SkillsManager List Box Skill cards on file Create Box Skill cards on file Update Box Skill cards on file Remove Box Skill cards from file… - [Storage Policies](): Storage Policies Storage policies allow enterprise administrators to choose where their content is physically stored; different policies can… - [Storage Policies](): Storage Policies Allows the enterprise admin to manage the Storage Policies for users in their enterprise. Used for an enterprise to decide… - [Storage Policies](): Storage Policies Storage policies allow enterprise administrators to choose where their content is physically stored; different policies can… - [Storage Policies](): Storage Policies Get Storage Policy Info Get Storage Policies Get Storage Policy Assignment Info Get Storage Policy Assignments Create… - [Storage Policies](): Storage Policies Get Storage Policy Info Get Storage Policies Get Storage Policy Assignment Info Get Storage Policy Assignments Create… - [Storage Policy](): Storage Policy Allows the enterprise admin to manage the Storage Policies for users in their enterprise. Used for an enterprise to decide… - [StoragePoliciesManager](): StoragePoliciesManager List storage policies Get storage policy List storage policies Fetches all the storage policies in the enterprise… - [StoragePoliciesManager](): StoragePoliciesManager List storage policies Get storage policy List storage policies Fetches all the storage policies in the enterprise… - [StoragePoliciesManager](): StoragePoliciesManager List storage policies Get storage policy List storage policies Fetches all the storage policies in the enterprise… - [StoragePoliciesManager](): StoragePoliciesManager List storage policies Get storage policy List storage policies Fetches all the storage policies in the enterprise… - [StoragePolicyAssignmentsManager](): StoragePolicyAssignmentsManager List storage policy assignments Assign storage policy Get storage policy assignment Update storage policy… - [StoragePolicyAssignmentsManager](): StoragePolicyAssignmentsManager List storage policy assignments Assign storage policy Get storage policy assignment Update storage policy… - [StoragePolicyAssignmentsManager](): StoragePolicyAssignmentsManager List storage policy assignments Assign storage policy Get storage policy assignment Update storage policy… - [StoragePolicyAssignmentsManager](): StoragePolicyAssignmentsManager List storage policy assignments Assign storage policy Get storage policy assignment Update storage policy… - [Support & Community](https://developer.box.com/support.md): Support & Community Our community and support services are aimed to help ensure that your questions and integrations with Box Platform are… - [TaskAssignmentsManager](): TaskAssignmentsManager List task assignments Assign task Get task assignment Update task assignment Unassign task List task assignments… - [TaskAssignmentsManager](): TaskAssignmentsManager List task assignments Assign task Get task assignment Update task assignment Unassign task List task assignments… - [TaskAssignmentsManager](): TaskAssignmentsManager List task assignments Assign task Get task assignment Update task assignment Unassign task List task assignments… - [TaskAssignmentsManager](): TaskAssignmentsManager List task assignments Assign task Get task assignment Update task assignment Unassign task List task assignments… - [Tasks](): Tasks Tasks enable file-centric workflows in Box. User can create tasks on files and assign them to collaborators on Box. Create a Task Get… - [Tasks](): Tasks Task objects represent a user-created task on a file. Get a Task's Information Get the Tasks on a File Add a Task to a File Update a… - [Tasks](): Tasks Tasks enable file-centric workflows in Box. User can create tasks on files and assign them to collaborators on Box. Get a Task's… - [Tasks](): Tasks Tasks enable file-centric workflows in Box. User can create tasks on files and assign them to collaborators on Box. Get a Task's… - [TasksManager](): TasksManager List tasks on file Create task Get task Update task Remove task List tasks on file Retrieves a list of all the tasks for a file… - [TasksManager](): TasksManager List tasks on file Create task Get task Update task Remove task List tasks on file Retrieves a list of all the tasks for a file… - [TasksManager](): TasksManager List tasks on file Create task Get task Update task Remove task List tasks on file Retrieves a list of all the tasks for a file… - [TasksManager](): TasksManager List tasks on file Create task Get task Update task Remove task List tasks on file Retrieves a list of all the tasks for a file… - [Technical use cases](https://developer.box.com/sign/technical-use-cases.md): Technical use cases In your application you will be signing different documents from many sources. How can your application process such… - [Terms of Service](): Terms of Service Terms of Service are custom objects that the admin of an enterprise can configure. This will prompt the end user to accept… - [Terms of Service](): Terms of Service Terms of Service allows Box Admins to configure a custom Terms of Service for end users to accept/re-accept/decline for… - [Terms of Service](): Terms of Service Terms of Service allows Box Admins to configure a custom Terms of Service for end users to accept/re-accept/decline for… - [Terms of Service](): Terms of Service Terms of Service are custom objects that the admin of an enterprise can configure. This will prompt the end user to accept… - [Terms of Services](): Terms of Services Terms of Service are custom objects that the admin of an enterprise can configure. This will prompt the end user to accept… - [Terms of Services](): Terms of Services Terms of Service are custom objects that the admin of an enterprise can configure. This will prompt the end user to accept… - [TermsOfServicesManager](): TermsOfServicesManager List terms of services Create terms of service Get terms of service Update terms of service List terms of services… - [TermsOfServicesManager](): TermsOfServicesManager List terms of services Create terms of service Get terms of service Update terms of service List terms of services… - [TermsOfServicesManager](): TermsOfServicesManager List terms of services Create terms of service Get terms of service Update terms of service List terms of services… - [TermsOfServicesManager](): TermsOfServicesManager List terms of services Create terms of service Get terms of service Update terms of service List terms of services… - [TermsOfServiceUserStatusesManager](): TermsOfServiceUserStatusesManager List terms of service user statuses Create terms of service status for new user Update terms of service… - [TermsOfServiceUserStatusesManager](): TermsOfServiceUserStatusesManager List terms of service user statuses Create terms of service status for new user Update terms of service… - [TermsOfServiceUserStatusesManager](): TermsOfServiceUserStatusesManager List terms of service user statuses Create terms of service status for new user Update terms of service… - [TermsOfServiceUserStatusesManager](): TermsOfServiceUserStatusesManager List terms of service user statuses Create terms of service status for new user Update terms of service… - [TransferManager](): TransferManager Transfer owned folders Transfer owned folders Move all of the items (files, folders and workflows) owned by a user into… - [TransferManager](): TransferManager Transfer owned folders Transfer owned folders Move all of the items (files, folders and workflows) owned by a user into… - [TransferManager](): TransferManager Transfer owned folders Transfer owned folders Move all of the items (files, folders and workflows) owned by a user into… - [TransferManager](): TransferManager Transfer owned folders Transfer owned folders Move all of the items (files, folders and workflows) owned by a user into… - [Trash](): Trash Under normal circumstances, when an item in Box is deleted, it is not actually erased immediately. Instead, it is moved to the Trash… - [Trash](): Trash Under normal circumstances, when an item in Box is deleted, it is not actually erased immediately. Instead, it is moved to the Trash… - [Trash](): Trash Under normal circumstances, when an item in Box is deleted, it is not actually erased immediately. Instead, it is moved to the Trash… - [Trash](): Trash Under normal circumstances, when an item in Box is deleted, it is not actually erased immediately. Instead, it is moved to the Trash… - [TrashedFilesManager](): TrashedFilesManager Restore file Get trashed file Permanently remove file Restore file Restores a file that has been moved to the trash. An… - [TrashedFilesManager](): TrashedFilesManager Restore file Get trashed file Permanently remove file Restore file Restores a file that has been moved to the trash. An… - [TrashedFilesManager](): TrashedFilesManager Restore file Get trashed file Permanently remove file Restore file Restores a file that has been moved to the trash. An… - [TrashedFilesManager](): TrashedFilesManager Restore file Get trashed file Permanently remove file Restore file Restores a file that has been moved to the trash. An… - [TrashedFoldersManager](): TrashedFoldersManager Restore folder Get trashed folder Permanently remove folder Restore folder Restores a folder that has been moved to… - [TrashedFoldersManager](): TrashedFoldersManager Restore folder Get trashed folder Permanently remove folder Restore folder Restores a folder that has been moved to… - [TrashedFoldersManager](): TrashedFoldersManager Restore folder Get trashed folder Permanently remove folder Restore folder Restores a folder that has been moved to… - [TrashedFoldersManager](): TrashedFoldersManager Restore folder Get trashed folder Permanently remove folder Restore folder Restores a folder that has been moved to… - [TrashedItemsManager](): TrashedItemsManager List trashed items List trashed items Retrieves the files and folders that have been moved to the trash. Any attribute… - [TrashedItemsManager](): TrashedItemsManager List trashed items List trashed items Retrieves the files and folders that have been moved to the trash. Any attribute… - [TrashedItemsManager](): TrashedItemsManager List trashed items List trashed items Retrieves the files and folders that have been moved to the trash. Any attribute… - [TrashedItemsManager](): TrashedItemsManager List trashed items List trashed items Retrieves the files and folders that have been moved to the trash. Any attribute… - [TrashedWebLinksManager](): TrashedWebLinksManager Restore web link Get trashed web link Permanently remove web link Restore web link Restores a web link that has been… - [TrashedWebLinksManager](): TrashedWebLinksManager Restore web link Get trashed web link Permanently remove web link Restore web link Restores a web link that has been… - [TrashedWebLinksManager](): TrashedWebLinksManager Restore web link Get trashed web link Permanently remove web link Restore web link Restores a web link that has been… - [TrashedWebLinksManager](): TrashedWebLinksManager Restore web link Get trashed web link Permanently remove web link Restore web link Restores a web link that has been… - [Untitled](): The Box Python SDK is an open source project supported by Box used to interact with the Box API. This is a list of contributors. @Jeff… - [Upgrading from 4.x.x to 5.x.x](): Upgrading from 4.x.x to 5.x.x Follow the General changes to see the changes that are package indenpendent. Also refer to the Box.V2 or Box.V… - [Upgrading to v4](): Upgrading to v4 v4 of the Box Java SDK introduces a lot of new design changes. Since this is a major version bump, there will be breaking… - [Uploads](): Uploads Uploads module is used to upload files to Box. It supports uploading files from an InputStream. For now, it only supports uploading… - [UploadsManager](): UploadsManager Upload file version Preflight check before upload Upload file Upload file version Update a file's content. For file sizes… - [UploadsManager](): UploadsManager Upload file version Preflight check before upload Upload file Upload a file with a preflight check Upload file version Update… - [UploadsManager](): UploadsManager Upload file version Preflight check before upload Upload file Upload a file with a preflight check Upload file version Update… - [UserCollaborationsManager](): UserCollaborationsManager Get collaboration Update collaboration Remove collaboration Create collaboration Get collaboration Retrieves a… - [UserCollaborationsManager](): UserCollaborationsManager Get collaboration Update collaboration Remove collaboration Create collaboration Get collaboration Retrieves a… - [UserCollaborationsManager](): UserCollaborationsManager Get collaboration Update collaboration Remove collaboration Create collaboration Get collaboration Retrieves a… - [UserCollaborationsManager](): UserCollaborationsManager Get collaboration Update collaboration Remove collaboration Create collaboration Get collaboration Retrieves a… - [Users](): Users Users represent an individual's account on Box. Get User's Information Get the Current User's Information Get User Avatar Set User… - [Users](): Users Users represent an individual's account on Box. Get the Current User's Information Get User Information Get Avatar for a User Add or… - [Users](): Users Users represent an individual's account on Box. Users Get User Information Get the Current User's Information Create An Enterprise… - [Users](): Users Users represent an individual's account on Box. Get the Current User's Information Get User's Information Get User Avatar Add or… - [Users](): Users Users represent an individual's account on Box. Get Current User Get User Upload User Avatar Get User Avatar Delete User Avatar Create… - [Users](): Users Users represent an individual's account on Box. Get Current User Get User Upload User Avatar Get User Avatar Delete User Avatar Create… - [UsersManager](): UsersManager List enterprise users Create user Get current user Get user Update user Delete user List enterprise users Returns a list of all… - [UsersManager](): UsersManager List enterprise users Create user Get current user Get user Update user Delete user List enterprise users Returns a list of all… - [UsersManager](): UsersManager List enterprise users Create user Get current user Get user Update user Delete user List enterprise users Returns a list of all… - [UsersManager](): UsersManager List enterprise users Create user Get current user Get user Update user Delete user List enterprise users Returns a list of all… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Version Lifecycle](): Version Lifecycle We use a modified version of Semantic Versioning for all changes. It is strongly encouraged that you pin at least the… - [Watermarking](): Watermarking Watermarking allows you to place a semi-transparent overlay on an embedded file preview that displays a viewer's email address… - [Watermarking](): Watermarking The ability to watermark files and folders is represented as a sub-resource on the Files and Folders resources, respectively… - [Watermarking](): Watermarking The ability to watermark files and folders is represented as a sub-resource on the Files and Folders resources, respectively… - [Watermarking](): Watermarking Watermarking allows you to place a semi-transparent overlay on an embedded file preview that displays a viewer's email address… - [Web Links](): Web Links Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link… - [Web Links](): Web Links Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link… - [Web Links](): Web Links Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link… - [Web Links](): Web Links Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link… - [Web Links](): Web Links Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link… - [Web Links](): Web Links Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link… - [Webhooks](): Webhooks A webhook object enables you to attach events triggers to Box files and folders. These event triggers monitor events on Box objects… - [Webhooks](): Webhooks Webhooks enable you to attach event triggers to Box files and folders. Event triggers monitor events on Box objects and notify your… - [Webhooks](): Webhooks Webhooks enable you to attach event triggers to Box files and folders. Event triggers monitor events on Box objects and notify your… - [Webhooks](): Webhooks A webhook object enables you to attach events triggers to Box files and folders. These event triggers monitor events on Box objects… - [Webhooks](): Webhooks Webhooks enable you to attach event triggers to Box files and folders. Event triggers monitor events on Box objects and notify your… - [Webhooks](): Webhooks Webhooks enable you to attach event triggers to Box files and folders. Event triggers monitor events on Box objects and notify your… - [WebhooksManager](): WebhooksManager List all webhooks Create webhook Get webhook Update webhook Remove webhook Validate a webhook message List all webhooks… - [WebhooksManager](): WebhooksManager List all webhooks Create webhook Get webhook Update webhook Remove webhook Validate a webhook message List all webhooks… - [WebhooksManager](): WebhooksManager List all webhooks Create webhook Get webhook Update webhook Remove webhook List all webhooks Returns all defined webhooks… - [WebhooksManager](): WebhooksManager List all webhooks Create webhook Get webhook Update webhook Remove webhook Validate a webhook message List all webhooks… - [WebLinksManager](): WebLinksManager Create web link Get web link Update web link Remove web link Create web link Creates a web link object within a folder. This… - [WebLinksManager](): WebLinksManager Create web link Get web link Update web link Remove web link Create web link Creates a web link object within a folder. This… - [WebLinksManager](): WebLinksManager Create web link Get web link Update web link Remove web link Create web link Creates a web link object within a folder. This… - [WebLinksManager](): WebLinksManager Create web link Get web link Update web link Remove web link Create web link Creates a web link object within a folder. This… - [WorkflowsManager](): WorkflowsManager List workflows Starts workflow based on request body List workflows Returns list of workflows that act on a given folder ID… - [WorkflowsManager](): WorkflowsManager List workflows Starts workflow based on request body List workflows Returns list of workflows that act on a given folder ID… - [WorkflowsManager](): WorkflowsManager List workflows Starts workflow based on request body List workflows Returns list of workflows that act on a given folder ID… - [WorkflowsManager](): WorkflowsManager List workflows Starts workflow based on request body List workflows Returns list of workflows that act on a given folder ID… - [Working with Box Sign](https://developer.box.com/sign.md): Working with Box Sign This learning page provides developers with practical insights into working with Box Sign, aiming to facilitate the… - [Write the Box file contents to disk](): Files File objects represent individual files in Box. They can be used to download a file's contents, upload new versions, and perform other… - [Your first request](https://developer.box.com/sign/quick-start/your-first-request.md): Your first request Imagine that you have a document stored in Box and you want to send it to a customer for signature. At a minimum your app… - [Zip](): Zip Allows you to create a temporary zip file on Box, containing Box files and folders, and then download it. Download a Zip File Download a… - [Zip Download](): Zip Download Allows you to create a temporary zip file of Box files and folders and download them. Create a Zip File Download a Zip File… - [ZipDownloadsManager](): ZipDownloadsManager Create zip download Download zip archive Get zip download status Download ZIP Create zip download Creates a request to… - [ZipDownloadsManager](): ZipDownloadsManager Create zip download Download zip archive Get zip download status Download ZIP Create zip download Creates a request to… - [ZipDownloadsManager](): ZipDownloadsManager Create zip download Download zip archive Get zip download status Download ZIP Create zip download Creates a request to… - [ZipDownloadsManager](): ZipDownloadsManager Create zip download Download zip archive Get zip download status Download ZIP Create zip download Creates a request to…