Box Developer Documentation
Log in

API Reference

Authorization
dataOAuth 2.0 errordataAccess tokenGETAuthorize userPOSTRequest access tokenPOSTRefresh access tokenPOSTRevoke access token
Collaboration whitelist entries
dataCollaboration whitelist entrydataCollaboration whitelist entriesGETList collaboration whitelist entriesGETGet collaboration whitelist entryPOSTCreate collaboration whitelist entryDELRemove collaboration whitelist entry
Collaboration whitelist exempt targets
dataCollaboration whitelist exempt targetdataCollaboration whitelist exempt targetsGETList collaboration whitelist exempt targetGETGet collaboration whitelist exempt targetPOSTCreate whitelist exempt targetDELRemove collaboration whitelist exempt target
Collaborations
dataCollaborationdataCollaborationsGETGet collaborationPOSTCreate collaborationPUTUpdate collaborationDELRemove collaboration
Collaborations (List)
GETList file collaborationsGETList folder collaborationsGETList pending collaborationsGETList collaborations for group
Collections
dataCollectiondataCollectionsGETList all collectionsGETList collection items
Comments
dataCommentdataCommentsGETList file commentsGETGet commentPOSTCreate commentPUTUpdate commentDELRemove comment
Device pinners
dataDevice pinnerdataDevice pinnersGETGet device pinGETList enterprise device pinsDELRemove device pin
Downloads
GETDownload file
Email aliases
dataEmail aliasdataEmail aliasesGETList user's email aliasesPOSTCreate email aliasDELRemove email alias
Events
dataEventdataEventsdataReal-time serversGETList user and enterprise eventsOPTSGet events long poll endpoint
File version legal holds
dataFile version legal holddataFile version legal holdsGETGet file version legal holdGETList file version legal holds
File version retentions
dataFile version retentiondataFile version retentionsGETGet retention on fileGETList file version retentions
File versions
dataFile versiondataFile versionsGETList all file versionsGETGet file versionPOSTRevert file versionDELRemove file version
Files
dataFiledataFilesGETGet file informationGETGet file thumbnailPOSTCopy filePUTUpdate fileDELDelete file
Folders
dataFolderdataItemsGETGet folder informationGETList items in folderPOSTCreate folderPOSTCopy folderPUTUpdate folderDELDelete folder
Group memberships
dataGroup membershipdataGroup membershipsGETList user's groupsGETList members of groupGETGet group membershipPOSTAdd user to groupPUTUpdate group membershipDELRemove user from group
Groups
dataGroupdataGroupsGETList groups for enterpriseGETGet groupPOSTCreate groupPUTUpdate groupDELRemove group
Invites
dataInviteGETGet user invite statusPOSTCreate user invite
Legal hold policies
dataLegal hold policydataLegal hold policiesGETList all legal hold policiesGETGet legal hold policyPOSTCreate legal hold policyPUTUpdate legal hold policyDELRemove legal hold policy
Legal hold policy assignments
dataLegal hold policy assignmentdataLegal hold policy assignmentsGETList 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)
dataMetadata cascade policydataMetadata cascade policiesGETList metadata cascade policiesGETGet metadata cascade policyPOSTCreate metadata cascade policyPOSTForce-apply metadata cascade policy to folderDELRemove metadata cascade policy
Metadata instances (Files)
dataMetadata instancedataMetadata instancesGETList metadata instances on fileGETGet metadata instance on filePOSTCreate metadata instance on filePUTUpdate metadata instance on fileDELRemove metadata instance from file
Metadata instances (Folders)
GETList metadata instances on folderGETGet metadata instance on folderPOSTCreate metadata instance on folderPUTUpdate metadata instance on folderDELRemove metadata instance from folder
Metadata templates
dataMetadata templatedataMetadata templatesGETFind 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
dataRecent itemGETList recently accessed items
Retention policies
dataRetention policiesdataRetention policyGETList retention policiesGETGet retention policyPOSTCreate retention policyPUTUpdate retention policy
Retention policy assignments
dataRetention policy assignmentdataRetention policy assignmentsGETList retention policy assignmentsGETGet retention policy assignmentPOSTAssign retention policy
Search
GETSearch for contentPOSTQuery files/folders by metadata
Shared links
GETFind item for shared link
Skills
PUTUpdate skill invocation
Storage policies
dataStorage policydataStorage policiesGETList storage policiesGETGet storage policy
Storage policy assignments
dataStorage policy assignmentdataStorage policy assignmentsGETList storage policy assignmentsGETGet storage policy assignmentPOSTAssign storage policyPUTUpdate storage policy assignmentDELUnassign storage policy
Task assignments
dataTask assignmentdataTask assignmentsGETList task assignmentsGETGet task assignmentPOSTAssign taskPUTUpdate task assignmentDELUnassign task
Tasks
dataTaskdataTasksGETList tasks on fileGETGet taskPOSTCreate taskPUTUpdate taskDELRemove task
Terms of service
dataTerms of servicedataTerms of servicesGETList terms of servicesGETGet terms of servicePOSTCreate terms of servicePUTUpdate terms of service
Terms of service user statuses
dataTerms of service user statusdataTerms of service user statusesGETList terms of service user statusesPOSTCreate terms of service status for new userPUTUpdate terms of service status for existing user
Transfer folders
PUTTransfer owned folders
Trashed files
GETGet trashed filePOSTRestore fileDELPermanently remove file
Trashed folders
GETGet trashed folderPOSTRestore folderDELPermanently remove folder
Trashed items
GETList trashed items
Trashed web links
GETGet trashed web linkPOSTRestore web linkDELPermanently remove web link
Uploads
dataConflict errordataUpload URLOPTSPreflight check before uploadPOSTUpload file versionPOSTUpload file
Uploads (Chunked)
dataUploaded partdataUpload sessionGETGet upload sessionGETList partsPOSTCreate upload sessionPOSTCreate upload session for existing filePOSTCommit upload sessionPUTUpload part of fileDELRemove upload session
User avatars
GETGet user avatar
Users
dataUserdataUsersGETList enterprise usersGETGet current userGETGet userPOSTCreate userPUTUpdate userDELDelete user
Watermarks (Files)
dataWatermarkGETGet watermark on filePUTApply watermark to fileDELRemove watermark from file
Watermarks (Folders)
GETGet watermark for folderPUTApply watermark to folderDELRemove watermark from folder
Web links
dataWeb linkGETGet web linkPOSTCreate web linkPUTUpdate web linkDELRemove web link
Webhooks
dataWebhookdataWebhooksGETList all webhooksGETGet webhookPOSTCreate webhookPUTUpdate webhookDELRemove webhook
Resources
dataAccess tokendataClient errordataCollaborationdataCollaboration whitelist entriesdataCollaboration whitelist entrydataCollaboration whitelist exempt targetdataCollaboration whitelist exempt targetsdataCollaborationsdataCollectiondataCollections
dataCommentdataCommentsdataConflict errordataDevice pinnerdataDevice pinnersdataEmail aliasdataEmail aliasesdataEventdataEvent sourcedataEvents
dataFiledataFile versiondataFile version legal holddataFile version legal holdsdataFile version retentiondataFile version retentionsdataFile versionsdataFilesdataFolderdataGroup
dataGroup membershipdataGroup membershipsdataGroupsdataInvitedataItemsdataItem (Mini)dataLegal hold policiesdataLegal hold policydataLegal hold policy assignmentdataLegal hold policy assignments
dataMetadata instancedataMetadata cascade policiesdataMetadata cascade policydataMetadata query search resultdataMetadata query search resultsdataMetadata templatedataMetadata templatesdataMetadata instancesdataOAuth 2.0 errordataReal-time server
dataReal-time serversdataRecent itemdataRecent itemsdataRetention policiesdataRetention policydataRetention policy assignmentdataRetention policy assignmentsdataSkilldataSkill invocationdataStorage policies
dataStorage policydataStorage policy assignmentdataStorage policy assignmentsdataTaskdataTask assignmentdataTask assignmentsdataTasksdataTerms of servicedataTerms of service user statusdataTerms of services
dataTerms of service user statusesdataUpload partdataUpload partsdataUpload sessiondataUpload URLdataUploaded partdataUserdataUsersdataWatermarkdataWeb link
dataWebhookdataWebhook invocationdataWebhooks