Box Developer Documentation
Log in

API Reference

Authorization
Resources
OAuth 2.0 errorAccess token
Endpoints
GETAuthorize userPOSTRequest access tokenPOSTRefresh access tokenPOSTRevoke access token
Collaboration whitelist entries
Resources
Collaboration whitelist entryCollaboration whitelist entries
Endpoints
GETList collaboration whitelist entriesGETGet collaboration whitelist entryPOSTCreate collaboration whitelist entryDELRemove collaboration whitelist entry
Collaboration whitelist exempt targets
Resources
Collaboration whitelist exempt targetCollaboration whitelist exempt targets
Endpoints
GETList collaboration whitelist exempt targetGETGet collaboration whitelist exempt targetPOSTCreate whitelist exempt targetDELRemove collaboration whitelist exempt target
Collaborations
Resources
CollaborationCollaborations
Endpoints
GETGet collaborationPOSTCreate collaborationPUTUpdate collaborationDELRemove collaboration
Collaborations (List)
Endpoints
GETList file collaborationsGETList folder collaborationsGETList pending collaborationsGETList collaborations for group
Collections
Resources
CollectionCollections
Endpoints
GETList all collectionsGETList collection items
Comments
Resources
CommentComments
Endpoints
GETList file commentsGETGet commentPOSTCreate commentPUTUpdate commentDELRemove comment
Device pinners
Resources
Device pinnerDevice pinners
Endpoints
GETGet device pinGETList enterprise device pinsDELRemove device pin
Downloads
Endpoints
GETDownload file
Email aliases
Resources
Email aliasEmail aliases
Endpoints
GETList user's email aliasesPOSTCreate email aliasDELRemove email alias
Events
Resources
EventEventsReal-time servers
Endpoints
GETList user and enterprise eventsOPTSGet events long poll endpoint
File version legal holds
Resources
File version legal holdFile version legal holds
Endpoints
GETGet file version legal holdGETList file version legal holds
File version retentions
Resources
File version retentionFile version retentions
Endpoints
GETGet retention on fileGETList file version retentions
File versions
Resources
File versionFile versions
Endpoints
GETList all file versionsGETGet file versionPOSTRevert file versionDELRemove file version
Files
Resources
FileFiles
Endpoints
GETGet file informationGETGet file thumbnailPOSTCopy filePUTUpdate fileDELDelete file
Folders
Resources
FolderItems
Endpoints
GETGet folder informationGETList items in folderPOSTCreate folderPOSTCopy folderPUTUpdate folderDELDelete folder
Group memberships
Resources
Group membershipGroup memberships
Endpoints
GETList user's groupsGETList members of groupGETGet group membershipPOSTAdd user to groupPUTUpdate group membershipDELRemove user from group
Groups
Resources
GroupGroups
Endpoints
GETList groups for enterpriseGETGet groupPOSTCreate groupPUTUpdate groupDELRemove group
Invites
Resources
Invite
Endpoints
GETGet user invite statusPOSTCreate user invite
Legal hold policies
Resources
Legal hold policyLegal hold policies
Endpoints
GETList all legal hold policiesGETGet legal hold policyPOSTCreate legal hold policyPUTUpdate legal hold policyDELRemove legal hold policy
Legal hold policy assignments
Resources
Legal hold policy assignmentLegal hold policy assignments
Endpoints
GETList legal hold policy assignmentsGETGet legal hold policy assignmentGETList current file versions for legal hold policy assignmentGETList previous file versions for legal hold policy assignmentPOSTAssign legal hold policyDELUnassign legal hold policy
Metadata cascade policies (Beta)
Resources
Metadata cascade policyMetadata cascade policies
Endpoints
GETList metadata cascade policiesGETGet metadata cascade policyPOSTCreate metadata cascade policyPOSTForce-apply metadata cascade policy to folderDELRemove metadata cascade policy
Metadata instances (Files)
Resources
Metadata instanceMetadata instances
Endpoints
GETList metadata instances on fileGETGet metadata instance on filePOSTCreate metadata instance on filePUTUpdate metadata instance on fileDELRemove metadata instance from file
Metadata instances (Folders)
Endpoints
GETList metadata instances on folderGETGet metadata instance on folderPOSTCreate metadata instance on folderPUTUpdate metadata instance on folderDELRemove metadata instance from folder
Metadata templates
Resources
Metadata templateMetadata templates
Endpoints
GETFind metadata template by instance IDGETGet metadata template by nameGETGet metadata template by IDGETList all global metadata templatesGETList all metadata templates for enterprisePOSTCreate metadata templatePUTUpdate metadata templateDELRemove metadata template
Recent items
Resources
Recent item
Endpoints
GETList recently accessed items
Retention policies
Resources
Retention policiesRetention policy
Endpoints
GETList retention policiesGETGet retention policyPOSTCreate retention policyPUTUpdate retention policy
Retention policy assignments
Resources
Retention policy assignmentRetention policy assignments
Endpoints
GETList retention policy assignmentsGETGet retention policy assignmentPOSTAssign retention policy
Search
Resources
Metadata query search resultMetadata query search results
Endpoints
GETSearch for contentPOSTQuery files/folders by metadata
Shared links
Endpoints
GETFind item for shared link
Skills
Resources
Skill invocation
Endpoints
PUTUpdate skill invocation
Storage policies
Resources
Storage policyStorage policies
Endpoints
GETList storage policiesGETGet storage policy
Storage policy assignments
Resources
Storage policy assignmentStorage policy assignments
Endpoints
GETList storage policy assignmentsGETGet storage policy assignmentPOSTAssign storage policyPUTUpdate storage policy assignmentDELUnassign storage policy
Task assignments
Resources
Task assignmentTask assignments
Endpoints
GETList task assignmentsGETGet task assignmentPOSTAssign taskPUTUpdate task assignmentDELUnassign task
Tasks
Resources
TaskTasks
Endpoints
GETList tasks on fileGETGet taskPOSTCreate taskPUTUpdate taskDELRemove task
Terms of service
Resources
Terms of serviceTerms of services
Endpoints
GETList terms of servicesGETGet terms of servicePOSTCreate terms of servicePUTUpdate terms of service
Terms of service user statuses
Resources
Terms of service user statusTerms of service user statuses
Endpoints
GETList terms of service user statusesPOSTCreate terms of service status for new userPUTUpdate terms of service status for existing user
Transfer folders
Endpoints
PUTTransfer owned folders
Trashed files
Endpoints
GETGet trashed filePOSTRestore fileDELPermanently remove file
Trashed folders
Endpoints
GETGet trashed folderPOSTRestore folderDELPermanently remove folder
Trashed items
Endpoints
GETList trashed items
Trashed web links
Endpoints
GETGet trashed web linkPOSTRestore web linkDELPermanently remove web link
Uploads
Resources
Conflict errorUpload URL
Endpoints
OPTSPreflight check before uploadPOSTUpload file versionPOSTUpload file
Uploads (Chunked)
Resources
Upload partUploaded partUpload partsUpload session
Endpoints
GETGet upload sessionGETList partsPOSTCreate upload sessionPOSTCreate upload session for existing filePOSTCommit upload sessionPUTUpload part of fileDELRemove upload session
User avatars
Endpoints
GETGet user avatar
Users
Resources
UserUsers
Endpoints
GETList enterprise usersGETGet current userGETGet userPOSTCreate userPUTUpdate userDELDelete user
Watermarks (Files)
Resources
Watermark
Endpoints
GETGet watermark on filePUTApply watermark to fileDELRemove watermark from file
Watermarks (Folders)
Endpoints
GETGet watermark for folderPUTApply watermark to folderDELRemove watermark from folder
Web links
Resources
Web link
Endpoints
GETGet web linkPOSTCreate web linkPUTUpdate web linkDELRemove web link
Webhooks
Resources
Webhook invocationWebhookWebhooks
Endpoints
GETList all webhooksGETGet webhookPOSTCreate webhookPUTUpdate webhookDELRemove webhook
Resources
Access tokenClient errorCollaborationCollaboration whitelist entriesCollaboration whitelist entryCollaboration whitelist exempt targetCollaboration whitelist exempt targetsCollaborationsCollectionCollections
CommentCommentsConflict errorDevice pinnerDevice pinnersEmail aliasEmail aliasesEventEvent sourceEvents
FileFile (Conflict)File versionFile version legal holdFile version legal holdsFile version retentionFile version retentionsFile versionsFilesFolder
GroupGroup membershipGroup membershipsGroupsInviteItemsLegal hold policiesLegal hold policyLegal hold policy assignmentLegal hold policy assignments
Metadata instanceMetadata cascade policiesMetadata cascade policyMetadata query search resultMetadata query search resultsMetadata templateMetadata templatesMetadata instancesOAuth 2.0 errorReal-time server
Real-time serversRecent itemRecent itemsRetention policiesRetention policyRetention policy assignmentRetention policy assignmentsSkill invocationStorage policiesStorage policy
Storage policy assignmentStorage policy assignmentsTaskTask assignmentTask assignmentsTasksTerms of serviceTerms of service user statusTerms of servicesTerms of service user statuses
Upload partUpload partsUpload sessionUpload URLUploaded partUserUsersWatermarkWeb linkWebhook
Webhook invocationWebhooks