Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Guides

Start Here
Create your first application Publish your app Sandboxes in Box Platform
Box AI
Box AI tutorials AI model overrides Supported AI models
Box Archive
Add content to Box Archive Restore content from Box Archive Supported APIs for Box Archive
Box AI Studio
Get started with AI studio AI studio agents
Box MCP server
Remote Box MCP server Self-hosted Box MCP server
Box Doc Gen
Get started with Box Doc Gen Mark file as Box Doc Gen template Generate documents Box Doc Gen templates Box Doc Gen jobs
Applications
Integrations Application Types Web App Integration
Authentication
Select Auth Method Best Practices Box API & SSO Tokens OAuth 2.0 Auth JWT Auth Client Credentials Grant App Token Auth
Authorization
Platform App Approval Limited Access App Approval Common Errors Custom Skill Approval
API Calls
Types and formats Status codes Sorting responses Request extra fields Ensure consistency with headers Allow domain access Suppress notifications Language codes API versioning strategy Pagination Permissions and errors
CLI
Use Box CLI with OAuth 2.0 CLI sample scripts CLI guides
Embed Box
Box Embed UI Elements Box View
Tooling
Postman Collection Salesforce Developer Toolkit Box SDKs
Security
FedRAMP Device Pinners Cross-Origin Resource Sharing (CORS) Terms of Service
SSO & App users
Connect SSO identities to app users Create connection between SSO identity and app user Find app user for SSO identity Connect Okta identities to Box App Users in a web app
Collaborations
Share Content with User Sharing with Groups Get Pending Collaborations Connect Slack to Box Group Collaborations Allowed collaboration domains
Collections
List User's Collections List Items in Collections Add Item to Collection Remove Item from Collection
Comments
Create Comment Create Reply
Downloads
Download File Download File Version Get Download URL Download Shared Link Download All Files in Folder using SDKs Download in Browser Download ZIP Archive
Events
User Events Enterprise Events Event Stream Parameters Event Triggers
Files
Get File Information Limitations
File Requests
Create a template File Request Copy a File Request Get information for a File Request Update a File Request Delete a File Request
Folders
Single Folders Bulk Manipulation
Integration Mappings
Teams integration mappings Slack Integration Mappings
Legal Holds
List All Legal Hold Policies Get Legal Hold Policy
Metadata
Metadata template scopes Classifications Working with Metadata Metadata templates Metadata fields Metadata instances Metadata queries Metadata cascade policies
Mobile
Deep Linking Android iOS
Representations
List All Representations for File Request Desired Representation Download File Representation Get Thumbnail Representation Get Basic Thumbnail Get PDF Representation Get Text Representation Supported File Types
Retention Policies
List All Retention Policies Get Retention Policy
Search
Search indexing Query operators Filter search results Pagination Metadata Query Filters Enterprise-wide search Searching trash Finding recent shared links Requesting extra fields Search content using metadata
Shared Links
Create or Update Shared Link Find Item from Shared Link Remove Shared Link Shared Link Permissions
Box Relay
Get Workflows Start Workflow
Box Sign
Create Box Sign Request Resend Box Sign Request Cancel Box Sign Request List Box Sign Requests Suppress default Box Sign notifications Create Sign Request with Sign Template Embedded Sign client
Box Skills
Invocation URL Box Skills Kit Handle Skills Payloads
Tasks
Create a task Get information about a task Lists all tasks for a file Make changes to an existing task Delete a task Assigning tasks
Trash
Restore File Permanently Delete File Restore Folder Permanently Delete Folder Restore Web Link Permanently Delete Web Link
Uploads
Preflight Check Direct Uploads Chunked Uploads
Users
Create Managed User Create App User Delete User Bulk delete external users Provision Users Deprovision Users
Webhooks
Webhook Event Triggers V1 Webhooks V2 Webhooks
Web Links
Create Web Link Delete Web Link