Versioning. This reference covers every Box API resource. Resources and
endpoints added in a recent release are marked New.
When an endpoint has multiple versions, the latest is the recommended default.
Request an earlier one with the
box-version header. See the
API versioning strategy for details.Get started
In the vast majority of cases, API requests use the base URLhttps://api.box.com/2.0 and require an OAuth 2.0 access token.
New to the platform? Create a free developer account, then generate a developer token to start making calls in minutes.
Try your first request
Replace<ACCESS_TOKEN> with a developer token and run:
Common tasks
Authenticate
Choose an auth method and obtain access tokens
Upload a file
Send content to Box with direct or chunked uploads
Download a file
Retrieve file content and representations
Create a shared link
Share files and folders with a URL
Search content
Find files and folders across an account
Invite a collaborator
Grant users and groups access to content
Browse by category
Content management
Content management
Core file and folder operations, uploads, downloads, and trash.
Files
Core file operations and management
Folders
Core folder operations and management
File versions
Access and manage file version history
File requests
Create and manage file upload requests
Uploads
Upload files to Box
Uploads (Chunked)
Upload large files in chunks
Downloads
Download file content
Zip Downloads
Download multiple items as zip archives
Folder Locks
Lock folders to prevent modifications
Collections
Organize content into collections
Recent items
Access recently accessed items
Transfer folders
Transfer folder ownership between users
Web links
Create and manage bookmarks
App item associations
Associate app items with files and folders
Trashed files
Manage files in trash
Trashed folders
Manage folders in trash
Trashed items
List all items in trash
Trashed web links
Manage web links in trash
Archives
Create and manage Box Archive resources
Authentication & users
Authentication & users
Authorization, user accounts, groups, and session management.
Authorization
OAuth 2.0 authorization and token management
Users
Create and manage users
User avatars
Manage user profile images
Groups
Create and manage user groups
Group memberships
Manage user membership in groups
Invites
Invite users to join Box
Email aliases
Manage user email aliases
Session termination
Terminate user or group sessions
Device pinners
Manage device pinning for offline access
External Users
Manage external user access
Sharing & collaboration
Sharing & collaboration
Search & metadata
Search & metadata
Search across content and manage metadata templates, instances, taxonomies, and classifications.
Search
Search for files and folders
Metadata instances (Files)
Manage metadata on files
Metadata instances (Folders)
Manage metadata on folders
Metadata templates
Define custom metadata schemas
Metadata cascade policies
Auto-apply metadata to folder contents
Metadata taxonomies
Organize metadata into hierarchical taxonomies
Classifications
Define and manage security classifications
Classifications on files
Apply classifications to files
Classifications on folders
Apply classifications to folders
Events & webhooks
Events & webhooks
Monitor activity and receive real-time notifications.
Events
Monitor Box events and activity
Webhooks
Configure real-time event notifications
AI & intelligence
AI & intelligence
Box AI, custom AI agents, and metadata skills.
Box AI
AI-powered features for asking questions and extracting data
Box AI Studio
Build and manage custom AI agents
Box Skills
Apply AI-powered skills to files
Automation & document workflows
Automation & document workflows
Workflows and e-signatures.
Workflows
Trigger and manage Box Relay workflows
Box Sign requests
Create and manage e-signature requests
Box Sign templates
Manage reusable e-signature templates
Automate Workflows
New Beta List and manually start Automate workflow actions
Convert to Box note
New Convert content to a Box Note
Box Doc Gen
Generate documents programmatically from templates
Box Doc Gen templates
Manage document generation templates
Administration & compliance
Administration & compliance
Enterprise integrations, governance, retention, and Box Shield.
Integration mappings
Map Box users to external integrations
Legal hold policies
Define and manage legal hold policies
Legal hold policy assignments
Apply legal hold policies to content
File version legal holds
Apply legal holds to specific file versions
Retention policies
Define content retention policies
Retention policy assignments
Apply retention policies to content
File version retentions
Manage retention policies for file versions
Terms of service
Define enterprise terms of service
Terms of service user statuses
Track user acceptance of terms
Watermarks (Files)
Apply watermarks to files
Watermarks (Folders)
Apply watermarks to folders
Standard and Zones Storage Policies
Manage storage location policies
Standard and Zones Storage Policy Assignments
Assign storage policies to users
Shield information barriers
Implement information barriers for compliance
Shield information barrier segments
Create and manage barrier segments
Shield information barrier segment members
Manage users in barrier segments
Shield information barrier segment restrictions
Define restrictions between segments
Shield information barrier reports
Generate reports on information barriers
Enterprise Configurations
Configure enterprise-wide settings
Shield lists
Manage access control lists