# Box Dev Docs: English Home > Box for Developers: guides, API reference, SDKs, and tutorials for building content management, Box AI, and enterprise integrations. ## Home - [Home](https://developer.box.com/index.md): Build with the Box Platform. Explore guides, API reference, SDKs, and tutorials for content management, Box AI, e-signatures, and enterprise integrations. - [Sample Code Catalog](https://developer.box.com/sample-code.md): Explore sample code and demo applications for Box APIs, SDKs, and UI Elements ### Getting started - [Box for Developers quick start](https://developer.box.com/guides/getting-started/index.md): Sign up for a Box free developer account, generate the developer token and make your first API call. - [Free developer plan](https://developer.box.com/guides/getting-started/free-developer-plan.md): Build and test full-featured Box applications at no cost with a free developer plan. - [Why Box for developers](https://developer.box.com/guides/getting-started/why-box.md): Learn when to use Box to build applications, AI agents, and workflows on governed enterprise content. - [Plan your integration](https://developer.box.com/guides/getting-started/plan-your-integration.md): Assess whether your use case fits Box, then choose the application type that matches how your app runs. - [User types](https://developer.box.com/guides/getting-started/users.md): Learn which Box user type your app authenticates as, and how Managed Users, Service Accounts, and App Users differ. - [Create your first application](https://developer.box.com/guides/getting-started/first-application.md): Create, configure, and publish (optional) your first application. - [Locating IDs](https://developer.box.com/guides/getting-started/locating-values.md): Find user IDs, enterprise IDs, and file or folder IDs in the Box web app, Admin Console, Developer Console, and API. - [Box developer sandboxes](https://developer.box.com/guides/getting-started/sandbox.md): Build, test, and collaborate on Box applications in an isolated developer sandbox that mirrors your enterprise plan and add-ons. - [Box for Developers glossary](https://developer.box.com/guides/getting-started/box-glossary.md) - [Box Platform API agent playbook](https://developer.box.com/guides/getting-started/agent-playbook.md): Authentication, core endpoints, SDKs, rate limits, and usage instructions for coding agents integrating with the Box API. ### Applications & integrations - [Applications](https://developer.box.com/guides/applications/index.md) - [Integrations](https://developer.box.com/guides/applications/integrations/index.md) #### Platform Apps - [Platform App](https://developer.box.com/guides/applications/platform-apps/index.md) - [Create a Platform App](https://developer.box.com/guides/applications/platform-apps/create.md) #### Web App Integrations - [Web App Integration](https://developer.box.com/guides/applications/web-app-integrations/index.md) - [Integrations Types](https://developer.box.com/guides/applications/web-app-integrations/types.md) - [User Experience](https://developer.box.com/guides/applications/web-app-integrations/user-experience.md) - [Create Web App Integration](https://developer.box.com/guides/applications/web-app-integrations/configure.md) #### Slack integration mappings - [Slack Integration Mappings](https://developer.box.com/guides/integration-mappings/slack-mappings/index.md) - [Slack Integration Mappings Setup](https://developer.box.com/guides/integration-mappings/slack-mappings/setup.md) - [List Slack Integration Mappings](https://developer.box.com/guides/integration-mappings/slack-mappings/list-mappings.md) - [Create Slack Integration Mapping](https://developer.box.com/guides/integration-mappings/slack-mappings/create-mapping.md) - [Update Slack Integration Mapping](https://developer.box.com/guides/integration-mappings/slack-mappings/update-mapping.md) - [Delete Slack Integration Mapping](https://developer.box.com/guides/integration-mappings/slack-mappings/delete-mapping.md) - [Slack Integration Mappings Troubleshooting](https://developer.box.com/guides/integration-mappings/slack-mappings/troubleshooting.md) #### Teams integration mappings - [Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/index.md) - [List Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/list-mappings.md) - [Create Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/create-mappings.md) - [Update Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/update-mappings.md) - [Delete Teams integration mappings](https://developer.box.com/guides/integration-mappings/teams-mappings/delete-mappings.md) ### Identity & access #### Authentication - [Authentication](https://developer.box.com/guides/authentication/index.md): Compare Box authentication methods, see which credentials and files each one needs, and learn what the access token you get back represents. - [Switch between CCG and JWT](https://developer.box.com/guides/authentication/switch-server-auth-type.md): Check whether your enterprise allows changing a Server app's authentication method, and see what a switch revokes and what it preserves. - [Box API and SSO](https://developer.box.com/guides/authentication/sso.md): How single sign-on affects OAuth 2.0 sign-ins, and why it doesn't apply to server-side authentication. - [Authentication best practices](https://developer.box.com/guides/authentication/best-practices.md): Practical guidance on protecting your client secret, caching and refreshing access tokens, downscoping, and revoking tokens. ##### OAuth 2.0 - [OAuth 2.0 authentication](https://developer.box.com/guides/authentication/oauth2/index.md): How the OAuth 2.0 flow works on Box, from the authorization URL to the access token your app uses on behalf of a signed-in user. - [Setup with OAuth 2.0](https://developer.box.com/guides/authentication/oauth2/oauth2-setup.md): Create a User app in the Developer Console and configure its redirect URI, scopes, and CORS domains for OAuth 2.0. - [OAuth 2.0 with SDKs](https://developer.box.com/guides/authentication/oauth2/with-sdk.md): Walk through the OAuth 2.0 flow using a Box SDK, from configuring the client to exchanging the authorization code for a token. - [OAuth 2.0 without SDKs](https://developer.box.com/guides/authentication/oauth2/without-sdk.md): Build the authorization URL, redirect the user, and exchange the authorization code for an access token with direct API calls. - [as-user header](https://developer.box.com/guides/authentication/oauth2/as-user.md): Act on behalf of another user from an OAuth 2.0 app, and the Developer Console settings and permissions this requires. ##### Client Credentials Grant - [Client Credentials Grant](https://developer.box.com/guides/authentication/client-credentials/index.md): How Client Credentials Grant authenticates a Server app with a client ID and client secret, and which subjects it can request a token for. - [Setup with Client Credentials Grant](https://developer.box.com/guides/authentication/client-credentials/client-credentials-setup.md): Create a Server app with Client Credentials Grant, configure its access level and scopes, and request an access token. ##### JWT - [JWT authentication](https://developer.box.com/guides/authentication/jwt/index.md): How server-side JWT authentication works on Box, from signing an assertion with your private key to receiving a Service Account token. - [Setup with JWT](https://developer.box.com/guides/authentication/jwt/jwt-setup.md): Create a Server app with JWT, generate or upload a public/private keypair, and configure access level, scopes, and CORS domains. - [JWT with SDKs](https://developer.box.com/guides/authentication/jwt/with-sdk.md): Read a config.json file and initialize a Box SDK client that handles JWT assertions and token renewal for you. - [JWT without SDKs](https://developer.box.com/guides/authentication/jwt/without-sdk.md): Decrypt your private key, build and sign a JWT assertion, and exchange it for an access token without using a Box SDK. - [as-user header](https://developer.box.com/guides/authentication/jwt/as-user.md): Act on behalf of another user from a JWT app, including the required app settings, permissions, and known limitations. - [User access tokens](https://developer.box.com/guides/authentication/jwt/user-access-tokens.md): Request an access token that belongs to a specific user instead of the Service Account, with and without the Box SDKs. ##### Tokens - [Tokens](https://developer.box.com/guides/authentication/tokens/index.md): Compare Box access, refresh, and developer tokens and choose the right token for OAuth, JWT, or Developer Console testing. - [Access tokens](https://developer.box.com/guides/authentication/tokens/access-tokens.md): What Box returns in the token object for OAuth 2.0 and for server authentication, and how the two responses differ. - [Use a token](https://developer.box.com/guides/authentication/tokens/api-calls.md): Pass an access token in the Authorization header of a Box API call, and check which user the token represents. - [Refresh a token](https://developer.box.com/guides/authentication/tokens/refresh.md): Exchange a refresh token for a new access token, and understand the 60-day, single-use limits on refresh tokens. - [Revoke a token](https://developer.box.com/guides/authentication/tokens/revoke.md): Invalidate an access token or a refresh token with the revoke endpoint, in cURL and in the Box SDKs. - [Downscope a token](https://developer.box.com/guides/authentication/tokens/downscope.md): Exchange an access token for a more restricted one before you pass it to a browser, a mobile app, or Box UI Elements. - [Use a token in SDKs](https://developer.box.com/guides/authentication/tokens/sdks.md): Pass an existing access token or a developer token straight to a Box SDK client instead of configuring a full authentication flow. - [Developer tokens](https://developer.box.com/guides/authentication/tokens/developer-tokens.md): Generate a short-lived Box developer token in the Developer Console to test API calls during development. Tokens expire after 60 minutes. - [Annotator tokens](https://developer.box.com/guides/authentication/tokens/annotator-tokens.md): Generate an access token that ties Box View annotations to one of your own end users, with or without an SDK. #### Authorization - [Authorization](https://developer.box.com/guides/authorization/index.md) - [Platform App Approval](https://developer.box.com/guides/authorization/platform-app-approval.md) - [Limited Access App Approval](https://developer.box.com/guides/authorization/limited-access-approval.md) - [Common Errors](https://developer.box.com/guides/authorization/common-errors.md) #### SSO & App users - [SSO & App users](https://developer.box.com/guides/sso-identities-and-app-users/index.md): How to use your own SSO service as the identity source for an app and link those identities to Box App Users. - [Connect SSO identities to app users](https://developer.box.com/guides/sso-identities-and-app-users/connect-identities.md) - [Create connection between SSO identity and app user](https://developer.box.com/guides/sso-identities-and-app-users/create-app-user.md) - [Find app user for SSO identity](https://developer.box.com/guides/sso-identities-and-app-users/find-app-user.md) ##### Connect Okta identities to Box App Users in a web app - [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/index.md) - [Scaffold application code (Okta integration)](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/scaffold-application-code.md) - [Configure Okta](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/configure-okta.md) - [Configure Box (Okta integration)](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/configure-box.md) - [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) - [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) - [Run the application](https://developer.box.com/guides/sso-identities-and-app-users/connect-okta-to-app-users/run-the-app.md) ### Using the API - [API Calls](https://developer.box.com/guides/api-calls/index.md): Learn how to make calls to the Box REST API, including authentication headers, common patterns, and platform insights. - [Types and formats](https://developer.box.com/guides/api-calls/types-and-formats.md) - [Status codes](https://developer.box.com/guides/api-calls/status-codes.md) - [Sorting responses](https://developer.box.com/guides/api-calls/sorting.md) - [Request extra fields](https://developer.box.com/guides/api-calls/request-extra-fields.md) - [Ensure consistency with headers](https://developer.box.com/guides/api-calls/ensure-consistency.md) - [Allow domain access](https://developer.box.com/guides/api-calls/allowing-domain-access.md) - [Suppress notifications](https://developer.box.com/guides/api-calls/suppress-notifications.md) - [Language codes](https://developer.box.com/guides/api-calls/language-codes.md) - [API versioning strategy](https://developer.box.com/guides/api-calls/api-versioning-strategy.md) #### Pagination - [Pagination overview](https://developer.box.com/guides/api-calls/pagination/index.md) - [Box API offset-based pagination](https://developer.box.com/guides/api-calls/pagination/offset-based.md): Page Box API collections with `offset` and `limit`. This includes limits of offset-based pagination, and when to use marker-based paging instead. - [Marker-based Pagination](https://developer.box.com/guides/api-calls/pagination/marker-based.md) #### Permissions and errors - [Box API errors](https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors.md): Look up Box API HTTP errors, JSON error responses, and common 4xx and 5xx codes when a request fails. - [Box API rate limits](https://developer.box.com/guides/api-calls/permissions-and-errors/rate-limits.md): Understand Box API rate limits, 429 responses, and how to retry requests without exceeding per-user and enterprise quotas. - [Box API scopes](https://developer.box.com/guides/api-calls/permissions-and-errors/scopes.md): Configure Box application scopes in the Developer Console so your app can call only the API endpoints it needs. - [Token & URL Expiration](https://developer.box.com/guides/api-calls/permissions-and-errors/expiration.md) - [Versioning errors](https://developer.box.com/guides/api-calls/permissions-and-errors/versioning-errors.md) ### Troubleshooting - [Debugging your Box app](https://developer.box.com/guides/troubleshooting/debugging-your-box-app.md): A step-by-step playbook for diagnosing failed API calls, handling retries and timeouts, and using the App Diagnostics tool to troubleshoot your Box application. - [App Diagnostics Report](https://developer.box.com/guides/troubleshooting/app-diagnostics-report.md) ### Content #### Files - [Get File Information](https://developer.box.com/guides/files/get.md) - [File limitations](https://developer.box.com/guides/files/limitations.md) #### Folders - [Create Folder](https://developer.box.com/guides/folders/single/create.md) - [Update Folder](https://developer.box.com/guides/folders/single/update.md) - [Rename Folder](https://developer.box.com/guides/folders/single/rename.md) - [Move Folder](https://developer.box.com/guides/folders/single/move.md) - [Copy Folder](https://developer.box.com/guides/folders/single/copy.md) - [Delete Folder](https://developer.box.com/guides/folders/single/delete.md) - [Change Folder Owner](https://developer.box.com/guides/folders/single/change-owner.md) - [Create Folder Lock](https://developer.box.com/guides/folders/single/create-lock.md) - [Get Folder Lock](https://developer.box.com/guides/folders/single/get-locks.md) - [Delete Folder Lock](https://developer.box.com/guides/folders/single/delete-lock.md) - [Build Folder Tree](https://developer.box.com/guides/folders/bulk/build-folder-tree.md) #### Uploads - [Uploads](https://developer.box.com/guides/uploads/index.md): Upload files to Box using direct upload for files up to 50 MB or chunked upload for larger files with retry control. - [Preflight Check](https://developer.box.com/guides/uploads/check.md) ##### Direct Uploads - [Direct Uploads](https://developer.box.com/guides/uploads/direct/index.md) - [Upload New File](https://developer.box.com/guides/uploads/direct/file.md) - [Upload File Version](https://developer.box.com/guides/uploads/direct/file-version.md) ##### Chunked Uploads - [Chunked Uploads](https://developer.box.com/guides/uploads/chunked/index.md) - [Create Upload Session](https://developer.box.com/guides/uploads/chunked/create-session.md) - [Chunked Upload with SDKs](https://developer.box.com/guides/uploads/chunked/with-sdks.md) - [Upload Part](https://developer.box.com/guides/uploads/chunked/upload-part.md) - [Commit Upload Session](https://developer.box.com/guides/uploads/chunked/commit-session.md) - [Upload All Files in Folder](https://developer.box.com/guides/uploads/chunked/folder.md) ##### Tutorials - [Upload methods with Python](https://developer.box.com/guides/uploads/tutorials/upload-methods-python.md): Learn how to upload files to Box with the Python SDK by using direct upload and chunked upload, including the `upload_big_file` convenience method, manual upload sessions, preflight checks, and conflict handling. - [Recursively upload a folder with Python](https://developer.box.com/guides/uploads/tutorials/recursive-folder-upload-python.md): Learn how to upload a local folder tree to Box with a recursive Python script that creates folders, uploads files, and handles naming conflicts. #### Downloads - [Downloads](https://developer.box.com/guides/downloads/index.md): Download files from Box to your application server or directly to a browser, and understand access requirements. - [Download File](https://developer.box.com/guides/downloads/file.md) - [Download File Version](https://developer.box.com/guides/downloads/file-version.md) - [Get Download URL](https://developer.box.com/guides/downloads/get-url.md) - [Download Shared Link](https://developer.box.com/guides/downloads/shared-link.md) - [Download All Files in Folder using SDKs](https://developer.box.com/guides/downloads/folder.md) - [Download in Browser](https://developer.box.com/guides/downloads/in-browser.md) - [Download ZIP Archive](https://developer.box.com/guides/downloads/zip-archive.md) #### Web Links - [Web Links](https://developer.box.com/guides/web-links/index.md) - [Create Web Link](https://developer.box.com/guides/web-links/create.md) - [Delete Web Link](https://developer.box.com/guides/web-links/delete.md) #### Trash - [Trash](https://developer.box.com/guides/trash/index.md) - [Restore File](https://developer.box.com/guides/trash/restore-file.md) - [Permanently Delete File](https://developer.box.com/guides/trash/permanently-delete-file.md) - [Restore Folder](https://developer.box.com/guides/trash/restore-folder.md) - [Permanently Delete Folder](https://developer.box.com/guides/trash/permanently-delete-folder.md) - [Restore Web Link](https://developer.box.com/guides/trash/restore-web-link.md) - [Permanently Delete Web Link](https://developer.box.com/guides/trash/permanently-delete-web-link.md) #### Representations - [Representations](https://developer.box.com/guides/representations/index.md) - [List All Representations for File](https://developer.box.com/guides/representations/list-all-representations.md) - [Request Desired Representation](https://developer.box.com/guides/representations/request-a-representation.md) - [Download File Representation](https://developer.box.com/guides/representations/download-a-representation.md) - [Get Thumbnail Representation](https://developer.box.com/guides/representations/thumbnail-representation.md) - [Get Basic Thumbnail](https://developer.box.com/guides/representations/thumbnail.md) - [Get Markdown Representation](https://developer.box.com/guides/representations/markdown.md): Generate and download Markdown representations using the Box API. - [Get Text Representation](https://developer.box.com/guides/representations/text.md) - [Get PDF Representation](https://developer.box.com/guides/representations/pdf.md) - [Supported File Types](https://developer.box.com/guides/representations/supported-file-types.md) #### Box Archive - [Box Archive](https://developer.box.com/guides/archives/index.md) - [Add content to Box Archive](https://developer.box.com/guides/archives/add-content.md) - [Restore content from Box Archive](https://developer.box.com/guides/archives/restore-content.md) - [Supported APIs for Box Archive](https://developer.box.com/guides/archives/supported-apis.md) ### Collaboration #### Collaborations - [Collaborations](https://developer.box.com/guides/collaborations/index.md): Grant users and groups role-based access to files and folders, manage pending invitations, and apply collaboration domain restrictions. - [Share Content with User](https://developer.box.com/guides/collaborations/share-content.md) - [Sharing with Groups](https://developer.box.com/guides/collaborations/groups.md) - [Get Pending Collaborations](https://developer.box.com/guides/collaborations/pending.md) ##### Connect Slack to Group Collaborations - [Connect Slack to Box Group Collaborations](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/index.md) - [Configure Slack](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/configure-slack.md) - [Configure Box (Slack integration)](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/configure-box.md) - [Scaffold application code (Slack integration)](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/scaffold-application-code.md) - [Handle Slack Events](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/handle-slack-events.md) - [Connect Bot to Box](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/connect-box-functions.md) - [Test the bot](https://developer.box.com/guides/collaborations/connect-slack-to-group-collabs/test-bot.md) ##### Allowed Domains - [Allowed collaboration domains overview](https://developer.box.com/guides/collaborations/allowed-domains/index.md) - [Allow a domain for collaboration](https://developer.box.com/guides/collaborations/allowed-domains/create.md) - [List allowed domains for collaboration](https://developer.box.com/guides/collaborations/allowed-domains/list.md) - [Remove a previously allowed domain for collaboration](https://developer.box.com/guides/collaborations/allowed-domains/delete.md) #### Shared Links - [Shared Links](https://developer.box.com/guides/shared-links/index.md): Generate URL-based access to files, folders, and web links stored in Box with configurable access levels. - [Create or Update Shared Link](https://developer.box.com/guides/shared-links/create-or-update.md) - [Find Item from Shared Link](https://developer.box.com/guides/shared-links/find-for-item.md) - [Remove Shared Link](https://developer.box.com/guides/shared-links/remove.md) - [Shared Link Permissions](https://developer.box.com/guides/shared-links/permissions.md) #### Comments - [Comments overview](https://developer.box.com/guides/comments/index.md) - [Create Comment](https://developer.box.com/guides/comments/create-comment.md) - [Create Reply](https://developer.box.com/guides/comments/create-reply.md) #### Tasks - [Tasks overview](https://developer.box.com/guides/tasks/index.md) - [Create a task](https://developer.box.com/guides/tasks/create.md) - [Get information about a task](https://developer.box.com/guides/tasks/get.md) - [Lists all tasks for a file](https://developer.box.com/guides/tasks/for-file.md) - [Make changes to an existing task](https://developer.box.com/guides/tasks/update.md) - [Delete a task](https://developer.box.com/guides/tasks/delete.md) ##### Assigning tasks - [Assigning tasks](https://developer.box.com/guides/tasks/assignments/index.md) - [Assign a task to a user](https://developer.box.com/guides/tasks/assignments/assign.md) - [Unassign a task](https://developer.box.com/guides/tasks/assignments/unassign.md) - [Change an assignment's message](https://developer.box.com/guides/tasks/assignments/update-message.md) - [Get task assignment information](https://developer.box.com/guides/tasks/assignments/get.md) - [List a task's assignments](https://developer.box.com/guides/tasks/assignments/list.md) - [Change task assignment state](https://developer.box.com/guides/tasks/assignments/change-state.md) #### Collections - [Collections overview](https://developer.box.com/guides/collections/index.md) - [List User's Collections](https://developer.box.com/guides/collections/list.md) - [List Items in Collections](https://developer.box.com/guides/collections/list-items.md) - [Add Item to Collection](https://developer.box.com/guides/collections/add.md) - [Remove Item from Collection](https://developer.box.com/guides/collections/remove.md) #### File Requests - [File Requests](https://developer.box.com/guides/file-requests/index.md) - [Create a template File Request](https://developer.box.com/guides/file-requests/template.md) - [Copy a File Request](https://developer.box.com/guides/file-requests/copy.md) - [Get information for a File Request](https://developer.box.com/guides/file-requests/get.md) - [Update a File Request](https://developer.box.com/guides/file-requests/update.md) - [Delete a File Request](https://developer.box.com/guides/file-requests/delete.md) #### Box Notes - [Box Notes API](https://developer.box.com/guides/box-notes/index.md): Programmatically create Box Notes from Markdown content using the Box Notes API. - [Get started with Box Notes API](https://developer.box.com/guides/box-notes/get-started.md): Set up authentication and create your first Box Note from Markdown content. - [Convert Markdown to Box Note](https://developer.box.com/guides/box-notes/convert-markdown.md): Detailed guide for converting Markdown content to a Box Note using the POST /notes/convert endpoint. - [Box Notes API use cases](https://developer.box.com/guides/box-notes/use-cases.md): Common scenarios and patterns for creating Box Notes programmatically from Markdown content. #### Box Hubs - [Box Hubs overview](https://developer.box.com/guides/hubs-api/index.md): Organize files and folders into Box Hubs and query curated, permission-aware content with the Hubs API and Box AI Ask. - [Turn an enterprise document repository into an access-controlled AI knowledge base](https://developer.box.com/guides/hubs-api/access-controlled-knowledge-base.md): Build an access-controlled AI knowledge base with Box Hubs and Box AI Ask. Answers inherit Box permissions. No vector database needed. - [Hubs APIs use cases](https://developer.box.com/guides/hubs-api/use-cases.md): Use the Box Hubs API to automate content portals, inherit source-file permissions, and query curated knowledge with Box AI. - [Manage hub items](https://developer.box.com/guides/hubs-api/hubs-items/hub-items.md) - [Manage hub collaborations](https://developer.box.com/guides/hubs-api/hubs-collaborations/hub-collaborations.md) ##### Hubs - [Create a hub](https://developer.box.com/guides/hubs-api/hubs/create-hub.md) - [Get a hub](https://developer.box.com/guides/hubs-api/hubs/get-hub.md) - [List hubs](https://developer.box.com/guides/hubs-api/hubs/list-hubs.md) - [Update a hub](https://developer.box.com/guides/hubs-api/hubs/update-hub.md) - [Delete a hub](https://developer.box.com/guides/hubs-api/hubs/delete-hub.md) - [Copy a hub](https://developer.box.com/guides/hubs-api/hubs/copy-hub.md) ### Metadata & search #### Metadata - [Metadata](https://developer.box.com/guides/metadata/index.md): Define and store custom key-value data on files and folders using metadata templates, instances, cascade policies, and queries. - [Metadata template scopes](https://developer.box.com/guides/metadata/scopes.md) - [Classifications](https://developer.box.com/guides/metadata/classifications.md) ##### Working with Metadata - [Working with Metadata](https://developer.box.com/guides/metadata/quick-start/index.md) - [List all metadata templates (quick start)](https://developer.box.com/guides/metadata/quick-start/list-all.md) - [Create a custom metadata template](https://developer.box.com/guides/metadata/quick-start/create-template.md) - [Apply metadata to a file](https://developer.box.com/guides/metadata/quick-start/create-instance.md) - [Update metadata on a file](https://developer.box.com/guides/metadata/quick-start/update-instance.md) - [Update a metadata template (quick start)](https://developer.box.com/guides/metadata/quick-start/update-template.md) - [Create a metadata query](https://developer.box.com/guides/metadata/quick-start/create-query.md) - [Metadata quick start: next steps](https://developer.box.com/guides/metadata/quick-start/next-steps.md) ##### Metadata templates - [Metadata templates overview](https://developer.box.com/guides/metadata/templates/index.md) - [List all metadata templates](https://developer.box.com/guides/metadata/templates/list.md) - [Get a metadata template](https://developer.box.com/guides/metadata/templates/get.md) - [Create a metadata template](https://developer.box.com/guides/metadata/templates/create.md) - [Update a metadata template](https://developer.box.com/guides/metadata/templates/update.md) - [Delete a metadata template](https://developer.box.com/guides/metadata/templates/delete.md) ##### Metadata taxonomies - [Metadata taxonomies overview](https://developer.box.com/guides/metadata/taxonomies/index.md) - [Create metadata taxonomy items](https://developer.box.com/guides/metadata/taxonomies/create.md) - [List metadata taxonomies](https://developer.box.com/guides/metadata/taxonomies/list.md) - [Get metadata taxonomy items](https://developer.box.com/guides/metadata/taxonomies/get.md) - [Update metadata taxonomies](https://developer.box.com/guides/metadata/taxonomies/update.md) - [Remove metadata taxonomy items](https://developer.box.com/guides/metadata/taxonomies/remove.md) ##### Metadata fields - [Metadata fields](https://developer.box.com/guides/metadata/fields/index.md) - [String metadata field](https://developer.box.com/guides/metadata/fields/string.md) - [Float metadata field](https://developer.box.com/guides/metadata/fields/float.md) - [Date metadata field](https://developer.box.com/guides/metadata/fields/date.md) - [Enum metadata field](https://developer.box.com/guides/metadata/fields/enum.md) - [Multi Select metadata field](https://developer.box.com/guides/metadata/fields/multi-select.md) ##### Metadata instances - [Metadata instances overview](https://developer.box.com/guides/metadata/instances/index.md) - [List all metadata on an item](https://developer.box.com/guides/metadata/instances/list.md) - [Get metadata on item](https://developer.box.com/guides/metadata/instances/get.md) - [Apply metadata to an item](https://developer.box.com/guides/metadata/instances/create.md) - [Update metadata on an item](https://developer.box.com/guides/metadata/instances/update.md) - [Remove metadata from an item](https://developer.box.com/guides/metadata/instances/delete.md) ##### Metadata queries - [Metadata queries](https://developer.box.com/guides/metadata/queries/index.md) - [Create a query](https://developer.box.com/guides/metadata/queries/create.md) - [Query syntax](https://developer.box.com/guides/metadata/queries/syntax.md) - [Query item fields](https://developer.box.com/guides/metadata/queries/item-fields.md) - [Common errors](https://developer.box.com/guides/metadata/queries/errors.md) - [Metadata query limitations](https://developer.box.com/guides/metadata/queries/limitations.md) - [Paginate and sort](https://developer.box.com/guides/metadata/queries/pagination.md) - [Comparison to regular search](https://developer.box.com/guides/metadata/queries/comparison.md) ##### Metadata cascade policies - [Metadata cascade policies overview](https://developer.box.com/guides/metadata/cascades/index.md) - [List metadata cascade policies](https://developer.box.com/guides/metadata/cascades/list.md) - [Get a metadata cascade policy](https://developer.box.com/guides/metadata/cascades/get.md) - [Create a metadata cascade policy](https://developer.box.com/guides/metadata/cascades/create.md) - [Force-apply metadata to all items in a folder](https://developer.box.com/guides/metadata/cascades/force-apply.md) - [Delete a metadata cascade policy](https://developer.box.com/guides/metadata/cascades/delete.md) #### Query - [Box query](https://developer.box.com/guides/query/box-query.md) - [Query insights](https://developer.box.com/guides/query/insights.md) #### Search - [Search](https://developer.box.com/guides/search/index.md) - [Search indexing](https://developer.box.com/guides/search/indexing.md) - [Query operators](https://developer.box.com/guides/search/query-operators.md) - [Filter search results](https://developer.box.com/guides/search/filtering.md) - [Search result pagination](https://developer.box.com/guides/search/pagination.md) - [Metadata Query Filters](https://developer.box.com/guides/search/metadata-filters.md) - [Enterprise-wide search](https://developer.box.com/guides/search/enterprise.md) - [Searching trash](https://developer.box.com/guides/search/trash.md) - [Finding recent shared links](https://developer.box.com/guides/search/shared-links.md) - [Requesting extra fields](https://developer.box.com/guides/search/fields.md) ##### Search content using metadata - [Search content using metadata](https://developer.box.com/guides/search/quick-start/index.md) - [Create a Metadata Template](https://developer.box.com/guides/search/quick-start/create-metadata-template.md) - [Locate Information about a Metadata Template](https://developer.box.com/guides/search/quick-start/locate-template-info.md) - [Add Metadata Template to a File](https://developer.box.com/guides/search/quick-start/apply-template-to-file.md) - [Use the Metadata Query API](https://developer.box.com/guides/search/quick-start/metadata-query-api.md) - [Next Steps](https://developer.box.com/guides/search/quick-start/next-steps.md) ### Events & webhooks #### Events - [Events overview](https://developer.box.com/guides/events/index.md): Subscribe to user or enterprise events in Box, compare stream types, and monitor actions in real time or query historical records. ##### User Events - [User Events](https://developer.box.com/guides/events/user-events/index.md) - [Get User Events](https://developer.box.com/guides/events/user-events/for-user.md) - [Long-Poll Events](https://developer.box.com/guides/events/user-events/polling.md) ##### Enterprise Events - [Enterprise Events](https://developer.box.com/guides/events/enterprise-events/index.md) - [Get Enterprise Events](https://developer.box.com/guides/events/enterprise-events/for-enterprise.md) - [Migrating From History To Stream](https://developer.box.com/guides/events/enterprise-events/migrate-to-stream.md) ##### Event Stream Parameters - [Stream Types](https://developer.box.com/guides/events/parameters/stream-types.md) - [Stream Position Pagination](https://developer.box.com/guides/events/parameters/pagination.md) ##### Event Triggers - [Event Triggers](https://developer.box.com/guides/events/event-triggers/index.md) - [Event Source](https://developer.box.com/guides/events/event-triggers/event-source.md) - [AI Security Detection Events](https://developer.box.com/guides/events/event-triggers/ai-security-detection-events.md) - [Shield Alert Events](https://developer.box.com/guides/events/event-triggers/shield-alert-events.md) - [Shield Information Barrier Events](https://developer.box.com/guides/events/event-triggers/shield-information-barrier-events.md) - [Shield Smart Access Events](https://developer.box.com/guides/events/event-triggers/shield-smart-access-events.md) - [Sign Events](https://developer.box.com/guides/events/event-triggers/sign-events.md) #### Webhooks - [Webhooks overview](https://developer.box.com/guides/webhooks/index.md): Monitor Box content for events and get notified at a URL of your choice, and compare V1 and V2 webhooks. - [Webhook Event Triggers](https://developer.box.com/guides/webhooks/triggers.md) ##### V1 Webhooks - [V1 Webhooks](https://developer.box.com/guides/webhooks/v1/index.md) - [Create webhooks (v1)](https://developer.box.com/guides/webhooks/v1/create-v1.md) - [Delete webhooks (v1)](https://developer.box.com/guides/webhooks/v1/delete-v1.md) ##### V2 Webhooks - [V2 webhooks](https://developer.box.com/guides/webhooks/v2/index.md): Understand the payload headers, JSON body, and delivery retry behavior of Box V2 webhooks. - [List Webhooks for a User](https://developer.box.com/guides/webhooks/v2/list-v2.md) - [Create webhooks (v2)](https://developer.box.com/guides/webhooks/v2/create-v2.md) - [Update Webhooks](https://developer.box.com/guides/webhooks/v2/update-v2.md) - [Delete webhooks (v2)](https://developer.box.com/guides/webhooks/v2/delete-v2.md) - [Verify Box webhook signatures](https://developer.box.com/guides/webhooks/v2/signatures-v2.md): Verify Box webhook payloads with HMAC signatures so you can reject requests that were not sent by Box. - [Webhook limitations](https://developer.box.com/guides/webhooks/v2/limitations-v2.md) ### Users - [Users overview](https://developer.box.com/guides/users/index.md) - [Create Managed User](https://developer.box.com/guides/users/create-managed-user.md) - [Create App User](https://developer.box.com/guides/users/create-app-user.md) - [Delete User](https://developer.box.com/guides/users/delete-user.md) - [Bulk delete external users](https://developer.box.com/guides/users/bulk-delete-external-users.md) #### Provision Users - [Provision Users](https://developer.box.com/guides/users/provision/index.md) - [Create Architecture Skeleton](https://developer.box.com/guides/users/provision/architecture.md) - [Populate Content](https://developer.box.com/guides/users/provision/populate-content.md) - [Setup Shared Folders](https://developer.box.com/guides/users/provision/shared-folders.md) #### Deprovision Users - [Deprovision Users](https://developer.box.com/guides/users/deprovision/index.md) - [Transfer Files & Folders](https://developer.box.com/guides/users/deprovision/transfer-folders.md) ### Intelligent workflow - [Intelligent workflow](https://developer.box.com/guides/intelligent-workflow/index.md): Build governed, agentic content workflows without running your own automation infrastructure. #### Box Automate - [Box Automate](https://developer.box.com/guides/box-automate/index.md) - [Get started with Box Automate](https://developer.box.com/guides/box-automate/getting-started-box-automate.md) - [Triggers, outcomes, and logic in Box Automate](https://developer.box.com/guides/box-automate/triggers-and-logic.md) #### Box Doc Gen - [Box Doc Gen](https://developer.box.com/guides/docgen/index.md) - [Get started with Box Doc Gen](https://developer.box.com/guides/docgen/docgen-getting-started.md) - [Mark file as Box Doc Gen template](https://developer.box.com/guides/docgen/mark-template.md) - [Generate documents](https://developer.box.com/guides/docgen/generate-document.md) - [Box Doc Gen templates](https://developer.box.com/guides/docgen/docgen-templates.md) - [Box Doc Gen jobs](https://developer.box.com/guides/docgen/docgen-jobs.md) #### Box Relay - [Box Relay](https://developer.box.com/guides/box-relay/index.md) - [Get Workflows](https://developer.box.com/guides/box-relay/get-workflows.md) - [Start Workflow](https://developer.box.com/guides/box-relay/start-workflow.md) ### E-signatures - [Box Sign](https://developer.box.com/guides/box-sign/index.md): Send documents for electronic signature from your own app using the Box Sign API, and track them through to a signed file in Box. - [Set up Box Sign](https://developer.box.com/guides/box-sign/setup.md): Check your account type, enable the required scopes, and set up a safe place to test before you call the Box Sign API. - [Quick start](https://developer.box.com/guides/box-sign/quick-start.md): Send your first Box Sign request with a file, destination folder, and signer email. #### Document types - [Document types](https://developer.box.com/guides/box-sign/document-types/index.md): Choose how to send a Box Sign request for unstructured documents, templates, or structured tagged files. - [Signing unstructured docs](https://developer.box.com/guides/box-sign/document-types/unstructured.md): Prepare an unstructured document in Box Sign before you send it to a signer. - [Signing structured docs](https://developer.box.com/guides/box-sign/document-types/structured.md): Send a Box Sign request for a document that already includes signature tags. - [Create a sign request with a template](https://developer.box.com/guides/box-sign/document-types/sign-templates.md): Create a Box Sign template in the web app, list it through the API, and send a request with template_id and prefill tags. #### Create and configure - [Create a Box Sign request](https://developer.box.com/guides/box-sign/create-sign-request.md): Create a Box Sign request with files, signers, templates, and document preparation. - [Multiple signers and signing order](https://developer.box.com/guides/box-sign/multiple-signers.md): Assign signer, approver, and final copy reader roles, and control the order in which Box Sign notifies each person. - [Verify signer identity](https://developer.box.com/guides/box-sign/signer-verification.md): Require a signer to verify their identity with a smart card, SMS, or Box login, and add a password to a Box Sign request. - [In-person signing](https://developer.box.com/guides/box-sign/in-person-signing.md): Let a signer complete a Box Sign request on the requester's device, and cycle through several in-person signers in one session. - [21 CFR Part 11 requests](https://developer.box.com/guides/box-sign/cfr-part-11.md): Send GxP signature requests through the Box Sign API with request_flow set to cfr11, and handle the extra validation rules. - [Deliver the request to signers](https://developer.box.com/guides/box-sign/how-signers-get-the-request.md): Customize Box Sign email, send your own notifications, or embed the signing client so signers can complete a request in your app. #### Manage requests - [List and get Box Sign requests](https://developer.box.com/guides/box-sign/list-sign-requests.md): List all Box Sign requests for the current user, or get a single request by ID. - [Resend a Box Sign request](https://developer.box.com/guides/box-sign/resend-sign-request.md): Resend a Box Sign request email to remaining signers, or enable automatic reminders when you create the request. - [Cancel a Box Sign request](https://developer.box.com/guides/box-sign/cancel-sign-request.md): Cancel an unsigned Box Sign request and optionally provide a cancellation reason. - [Box Sign webhooks](https://developer.box.com/guides/box-sign/webhooks.md): Listen for Box Sign request events on a folder, create a webhook, and handle the notification payload. #### Reference - [Box Sign endpoints](https://developer.box.com/guides/box-sign/api-endpoints.md): A map of the Box Sign request and template endpoints, and what each one does. - [Box Sign request status](https://developer.box.com/guides/box-sign/request-status.md): What each Box Sign request status means, and which statuses let you resend or cancel a request. ### Security & compliance #### Security - [Security](https://developer.box.com/guides/security/index.md) - [FedRAMP](https://developer.box.com/guides/security/fedramp.md) - [Device Pinners](https://developer.box.com/guides/security/device-pinners.md) - [Cross-Origin Resource Sharing (CORS)](https://developer.box.com/guides/security/cors.md) ##### Terms of Service - [Terms of Service](https://developer.box.com/guides/security/terms-of-service/index.md) - [Application Flow](https://developer.box.com/guides/security/terms-of-service/flow.md) - [Find Terms for Collaboration](https://developer.box.com/guides/security/terms-of-service/for-colaboration.md) - [Permissions](https://developer.box.com/guides/security/terms-of-service/permissions.md) #### Legal Holds - [Legal Holds](https://developer.box.com/guides/legal-holds/index.md) - [List All Legal Hold Policies](https://developer.box.com/guides/legal-holds/list.md) - [Get Legal Hold Policy](https://developer.box.com/guides/legal-holds/get.md) #### Retention Policies - [Retention Policies](https://developer.box.com/guides/retention-policies/index.md) - [List All Retention Policies](https://developer.box.com/guides/retention-policies/list.md) - [Get Retention Policy](https://developer.box.com/guides/retention-policies/get.md)