Box Developer Documentation
Log in

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

API Reference

AI
Resources
AI extract responseAI responseAI response (Full)AI agent for question requestsAI agent for extract requestsAI agent for structured extract requestAI agent for text generation requests
Endpoints
GETGet AI agent default configurationPOSTAsk questionPOSTGenerate textPOSTExtract metadata (freeform)
Beta
POSTExtract metadata (structured)
Beta
App item associations
Resources
App itemApp item associationApp item associations
Endpoints
GETList file app item associationsGETList folder app item associations
Authorization
Resources
Access tokenOAuth 2.0 error
Endpoints
GETAuthorize userPOSTRequest access tokenPOSTRefresh access tokenPOSTRevoke access token
Box Sign requests
Resources
Box Sign requestBox Sign requestsCreate a Box Sign request
Endpoints
GETGet Box Sign request by IDGETList Box Sign requestsPOSTCancel Box Sign requestPOSTResend Box Sign requestPOSTCreate Box Sign request
Box Sign templates
Resources
Box Sign templateBox Sign templates
Endpoints
GETList Box Sign templatesGETGet Box Sign template by ID
Classifications
Resources
ClassificationClassification Template
Endpoints
GETList all classificationsPOSTAdd initial classificationsPUTAdd classificationPUTUpdate classification
Classifications on files
Endpoints
GETGet classification on filePOSTAdd classification to filePUTUpdate classification on fileDELRemove classification from file
Classifications on folders
Endpoints
GETGet classification on folderPOSTAdd classification to folderPUTUpdate classification on folderDELRemove classification from folder
Collaborations
Resources
CollaborationCollaborations
Endpoints
GETGet collaborationPOSTCreate collaborationPUTUpdate collaborationDELRemove collaboration
Collaborations (List)
Endpoints
GETList file collaborationsGETList folder collaborationsGETList pending collaborationsGETList group collaborations
Collections
Resources
CollectionCollections
Endpoints
GETList all collectionsGETList collection itemsGETGet collection by ID
Comments
Resources
CommentComment (Base)Comment (Full)Comments
Endpoints
GETList file commentsGETGet commentPOSTCreate commentPUTUpdate commentDELRemove comment
Device pinners
Resources
Device pinnerDevice pinners
Endpoints
GETGet device pinGETList enterprise device pinsDELRemove device pin
Domain restrictions (User exemptions)
Resources
Allowed collaboration domains user exemptionAllowed collaboration domains user exemptions
Endpoints
GETList users exempt from collaboration domain restrictionsGETGet user exempt from collaboration domain restrictionsPOSTCreate user exemption from collaboration domain restrictionsDELRemove user from list of users exempt from domain restrictions
Domain restrictions for collaborations
Resources
Allowed collaboration domainsAllowed collaboration domain
Endpoints
GETList allowed collaboration domainsGETGet allowed collaboration domainPOSTAdd domain to list of allowed collaboration domainsDELRemove domain from list of allowed collaboration domains
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 requests
Resources
File Request
Endpoints
GETGet file requestPOSTCopy file requestPUTUpdate file requestDELDelete file request
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
GETList file version retentionsGETGet retention on file
File versions
Resources
File versions
Endpoints
GETList all file versionsGETGet file versionPOSTPromote file versionPUTRestore file versionDELRemove file version
Files
Resources
FileFile (Base)File (Full)File (Mini)Files
Endpoints
GETGet file informationGETGet file thumbnailPOSTCopy filePUTUpdate fileDELDelete file
Folder Locks
Resources
Folder LockFolder Locks
Endpoints
GETList folder locksPOSTCreate folder lockDELDelete folder lock
Folders
Resources
FolderFolder (Base)Folder (Full)Folder (Mini)Items
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
GroupGroup (Base)Group (Full)Group (Mini)Groups
Endpoints
GETList groups for enterpriseGETGet groupPOSTCreate groupPUTUpdate groupDELRemove group
Integration mappings
Resources
Integration mapping SlackIntegration mapping (Base)Integration mappings Slack
Endpoints
GETList Slack integration mappingsPOSTCreate Slack integration mappingPUTUpdate Slack integration mappingDELDelete Slack integration mapping
Invites
Resources
Invite
Endpoints
GETGet user invite statusPOSTCreate user invite
Legal hold policies
Resources
Legal hold policiesLegal hold policyLegal hold policy (Mini)
Endpoints
GETList all legal hold policiesGETGet legal hold policyPOSTCreate legal hold policyPUTUpdate legal hold policyDELRemove legal hold policy
Legal hold policy assignments
Resources
File versions on holdFiles on holdLegal hold policy assignmentLegal hold policy assignment (Base)Legal hold policy assignments
Endpoints
GETList legal hold policy assignmentsGETGet legal hold policy assignmentGETList files with 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
Resources
Metadata cascade policiesMetadata cascade policy
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 instance (Base)Metadata instance (Full)Metadata 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 policyRetention policy (Base)Retention policy (Mini)
Endpoints
GETList retention policiesGETGet retention policyPOSTCreate retention policyPUTUpdate retention policyDELDelete retention policy
Retention policy assignments
Resources
Files under retentionRetention policy assignmentRetention policy assignment (Base)Retention policy assignments
Endpoints
GETList retention policy assignmentsGETGet retention policy assignmentGETGet files under retentionGETGet file versions under retentionPOSTAssign retention policyDELRemove retention policy assignment
Search
Resources
Metadata filterMetadata query indexMetadata query search resultsSearch Result (including Shared Link)Search ResultsSearch Results (including Shared Links)
Endpoints
GETSearch for contentPOSTQuery files/folders by metadata
Session termination
Resources
Session termination message
Endpoints
POSTCreate jobs to terminate users sessionPOSTCreate jobs to terminate user group session
Shared links (Files)
Endpoints
GETFind file for shared linkGETGet shared link for filePUTAdd shared link to filePUTUpdate shared link on filePUTRemove shared link from file
Shared links (Folders)
Endpoints
GETFind folder for shared linkGETGet shared link for folderPUTAdd shared link to folderPUTUpdate shared link on folderPUTRemove shared link from folder
Shared links (Web Links)
Endpoints
GETFind web link for shared linkGETGet shared link for web linkPUTAdd shared link to web linkPUTUpdate shared link on web linkPUTRemove shared link from web link
Shield information barrier reports
Resources
Shield information barrier referenceShield information barrier reportShield information barrier report (Base)Shield information barrier report detailsList of Shield Information Barrier Reports
Endpoints
GETList shield information barrier reportsGETGet shield information barrier report by IDPOSTCreate shield information barrier report
Shield information barrier segment members
Resources
Shield information barrier segment memberShield information barrier segment member (Base)Shield information barrier segment member (Mini)List of Shield Information Barrier Segment Members
Endpoints
GETGet shield information barrier segment member by IDGETList shield information barrier segment membersPOSTCreate shield information barrier segment memberDELDelete shield information barrier segment member by ID
Shield information barrier segment restrictions
Resources
Shield information barrier segment restrictionShield information barrier segment restriction (Base)Shield information barrier segment restriction (Mini)List of Shield Information Barrier Segment Restrictions
Endpoints
GETGet shield information barrier segment restriction by IDGETList shield information barrier segment restrictionsPOSTCreate shield information barrier segment restrictionDELDelete shield information barrier segment restriction by ID
Shield information barrier segments
Resources
Shield information barrier segmentList of Shield Information Barrier Segments
Endpoints
GETGet shield information barrier segment with specified IDGETList shield information barrier segmentsPOSTCreate shield information barrier segmentPUTUpdate shield information barrier segment with specified IDDELDelete shield information barrier segment
Shield information barriers
Resources
Shield information barrierShield information barrier (Base)List of Shield Information Barriers
Endpoints
GETGet shield information barrier with specified IDGETList shield information barriersPOSTAdd changed status of shield information barrier with specified IDPOSTCreate shield information barrier
Skills
Resources
Keyword Skill CardSkills metadata instanceSkill webhook payloadStatus Skill CardTimeline Skill CardTranscript Skill Card
Endpoints
GETList Box Skill cards on filePOSTCreate Box Skill cards on filePUTUpdate Box Skill cards on filePUTUpdate all Box Skill cards on fileDELRemove Box Skill cards from file
Standard and Zones Storage Policies
Resources
Storage policiesStorage policyStorage policy (Mini)
Endpoints
GETList storage policiesGETGet storage policy
Standard and Zones 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 service (Base)Terms 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
Resources
Trashed FileTrashed File (Restored)
Endpoints
GETGet trashed filePOSTRestore fileDELPermanently remove file
Trashed folders
Resources
Trashed FolderTrashed Folder (Restored)
Endpoints
GETGet trashed folderPOSTRestore folderDELPermanently remove folder
Trashed items
Endpoints
GETList trashed items
Trashed web links
Resources
Trashed Web LinkTrashed Web Link (Restored)
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 partUpload part (Mini)Upload partsUpload sessionUploaded part
Endpoints
GETGet upload sessionGETList partsPOSTCreate upload sessionPOSTCreate upload session for existing filePOSTCommit upload sessionPUTUpload part of fileDELRemove upload session
User avatars
Resources
User avatar
Endpoints
GETGet user avatarPOSTAdd or update user avatarDELDelete user avatar
Users
Resources
UserUser (Base)User (Collaborations)User (Full)User (Mini)User (Integration Mappings)Users
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 linkWeb link (Base)Web link (Mini)
Endpoints
GETGet web linkPOSTCreate web linkPUTUpdate web linkDELRemove web link
Webhooks
Resources
WebhookWebhook (Mini)Webhook (V2) payloadWebhooks
Endpoints
GETList all webhooksGETGet webhookPOSTCreate webhookPUTUpdate webhookDELRemove webhook
Workflows
Resources
WorkflowWorkflow (Full)Workflow (Mini)Workflows
Endpoints
GETList workflowsPOSTStarts workflow based on request body
Zip Downloads
Resources
Zip downloadZip download status
Endpoints
GETDownload zip archiveGETGet zip download statusPOSTCreate zip download
Resources
Access tokenAI agent for question requestsAI agent for extract requestsAI agent for structured extract requestAI agent for text generation requestsAI extract responseAI LLM endpoint params AWSAI LLM endpoint params GoogleAI LLM endpoint params OpenAIAI response
AI response (Full)App itemApp item associationApp item associationsAppItem event sourceClassificationClassification TemplateClient errorCollaborationAllowed collaboration domains
Allowed collaboration domainAllowed collaboration domains user exemptionAllowed collaboration domains user exemptionsCollaborationsCollectionCollectionsCommentComment (Base)Comment (Full)Comments
Conflict errorDevice pinnerDevice pinnersEmail aliasEmail aliasesEnterprise (Base)EventEvent sourceEventsFile
File (Base)File (Full)File (Mini)File (Conflict)File RequestFile versionFile version (Base)File version (Full)File version (Mini)File version legal hold
File version legal holdsFile version retentionFile version retentionsFile versionsFile versions on holdFilesFiles on holdFiles under retentionFolderFolder (Base)
Folder (Full)Folder (Mini)Folder LockFolder LocksGeneric sourceGroupGroup (Base)Group (Full)Group (Mini)Group membership
Group membershipsGroupsIntegration mapping (Base)Integration mapping SlackCreate Slack integration mapping requestIntegration mappings SlackInviteItemsKeyword Skill CardLegal hold policies
Legal hold policyLegal hold policy (Mini)Legal hold policy assignmentLegal hold policy assignment (Base)Legal hold policy assignmentsMetadata instanceMetadata instance (Base)Metadata instance (Full)Metadata cascade policiesMetadata cascade policy
Metadata field filter (date range)Metadata field filter (float range)Metadata filterMetadata query indexMetadata query search resultsMetadata templateMetadata templatesMetadata instancesOAuth 2.0 errorReal-time server
Real-time serversRecent itemRecent itemsRetention policiesRetention policyRetention policy (Base)Retention policy (Mini)Retention policy assignmentRetention policy assignment (Base)Retention policy assignments
Search Result (including Shared Link)Search ResultsSearch Results (including Shared Links)Session termination messageShield information barrierShield information barrier (Base)Shield information barrier referenceShield information barrier reportShield information barrier report (Base)Shield information barrier report details
List of Shield Information Barrier ReportsShield information barrier segmentShield information barrier segment memberShield information barrier segment member (Base)Shield information barrier segment member (Mini)List of Shield Information Barrier Segment MembersShield information barrier segment restrictionShield information barrier segment restriction (Base)Shield information barrier segment restriction (Mini)List of Shield Information Barrier Segment Restrictions
List of Shield Information Barrier SegmentsList of Shield Information BarriersBox Sign requestCreate a Box Sign requestBox Sign requestsBox Sign templateBox Sign templatesSkills metadata instanceSkill webhook payloadStatus Skill Card
Storage policiesStorage policyStorage policy (Mini)Storage policy assignmentStorage policy assignmentsTaskTask assignmentTask assignmentsTasksTerms of service
Terms of service (Base)Terms of service user statusTerms of servicesTerms of service user statusesTimeline Skill CardTranscript Skill CardTrashed FileTrashed File (Restored)Trashed FolderTrashed Folder (Restored)
Trashed Web LinkTrashed Web Link (Restored)Upload partUpload part (Mini)Upload partsUpload sessionUpload URLUploaded partUserUser (Base)
User (Full)User (Mini)User avatarUser (Collaborations)User (Integration Mappings)UsersWatermarkWeb linkWeb link (Base)Web link (Mini)
WebhookWebhook (Mini)Webhook (V2) payloadWebhooksWorkflowWorkflow (Full)Workflow (Mini)WorkflowsZip downloadZip download status