API Reference

Resources

AI agent for question requests AI agent for extract requests AI agent for structured extract request AI agent for text generation requests AI extract response AI response AI response (Full)

Endpoints

GETGet AI agent default configuration POSTAsk question POSTGenerate text POSTExtract metadata (freeform)

POSTExtract metadata (structured)

App item associations

Resources

App item App item association App item associations

Endpoints

GETList file app item associations GETList folder app item associations

Resources

Access token OAuth 2.0 error

Endpoints

GETAuthorize user POSTRequest access token POSTRefresh access token POSTRevoke access token

Box Sign requests

Resources

Box Sign request Create a Box Sign request Box Sign requests

Endpoints

GETGet Box Sign request by ID GETList Box Sign requests POSTCancel Box Sign request POSTResend Box Sign request POSTCreate Box Sign request

Box Sign templates

Resources

Box Sign template Box Sign templates

Endpoints

GETList Box Sign templates GETGet Box Sign template by ID

Classifications

Resources

Classification Classification Template

Endpoints

GETList all classifications POSTAdd initial classifications PUTAdd classification PUTUpdate classification

Classifications on files

Endpoints

GETGet classification on file POSTAdd classification to file PUTUpdate classification on file DELRemove classification from file

Classifications on folders

Endpoints

GETGet classification on folder POSTAdd classification to folder PUTUpdate classification on folder DELRemove classification from folder

Resources

Collaboration Collaborations Collaborations

Endpoints

GETGet collaboration POSTCreate collaboration PUTUpdate collaboration DELRemove collaboration

Collaborations (List)

Endpoints

GETList file collaborations GETList folder collaborations GETList pending collaborations GETList group collaborations

Resources

Collection Collections

Endpoints

GETList all collections GETList collection items GETGet collection by ID

Resources

Comment Comment (Base)Comment (Full)Comments

Endpoints

GETList file comments GETGet comment POSTCreate comment PUTUpdate comment DELRemove comment

Resources

Device pinner Device pinners

Endpoints

GETGet device pin GETList enterprise device pins DELRemove device pin

Domain restrictions (User exemptions)

Resources

Allowed collaboration domains user exemption Allowed collaboration domains user exemptions

Endpoints

GETList users exempt from collaboration domain restrictions GETGet user exempt from collaboration domain restrictions POSTCreate user exemption from collaboration domain restrictions DELRemove user from list of users exempt from domain restrictions

Domain restrictions for collaborations

Resources

Allowed collaboration domains Allowed collaboration domain

Endpoints

GETList allowed collaboration domains GETGet allowed collaboration domain POSTAdd domain to list of allowed collaboration domains DELRemove domain from list of allowed collaboration domains

Endpoints

GETDownload file

Resources

Email alias Email aliases

Endpoints

GETList user's email aliases POSTCreate email alias DELRemove email alias

Resources

Event Events Real-time servers

Endpoints

GETList user and enterprise events OPTSGet events long poll endpoint

Resources

Endpoints

GETGet file request POSTCopy file request PUTUpdate file request DELDelete file request

File version legal holds

Resources

File version legal hold File version legal holds

Endpoints

GETGet file version legal hold GETList file version legal holds

File version retentions

Resources

File version retention File version retentions

Endpoints

GETList file version retentions GETGet retention on file

Resources

Endpoints

GETList all file versions GETGet file version POSTPromote file version PUTRestore file version DELRemove file version

Resources

File File (Base)File (Full)File (Mini)Files

Endpoints

GETGet file information GETGet file thumbnail POSTCopy file PUTUpdate file DELDelete file

Resources

Folder Lock Folder Locks

Endpoints

GETList folder locks POSTCreate folder lock DELDelete folder lock

Resources

Folder Folder (Base)Folder (Full)Folder (Mini)Items Items

Endpoints

GETGet folder information GETList items in folder POSTCreate folder POSTCopy folder PUTUpdate folder DELDelete folder

Group memberships

Resources

Group membership Group memberships

Endpoints

GETList user's groups GETList members of group GETGet group membership POSTAdd user to group PUTUpdate group membership DELRemove user from group

Resources

Group Group (Base)Group (Full)Group (Mini)Groups

Endpoints

GETList groups for enterprise GETGet group POSTCreate group PUTUpdate group DELRemove group

Integration mappings

Resources

Integration mapping Slack Integration mapping (Base)Integration mappings Slack

Endpoints

GETList Slack integration mappings POSTCreate Slack integration mapping PUTUpdate Slack integration mapping DELDelete Slack integration mapping

Resources

Endpoints

GETGet user invite status POSTCreate user invite

Legal hold policies

Resources

Legal hold policies Legal hold policy Legal hold policy (Mini)

Endpoints

GETList all legal hold policies GETGet legal hold policy POSTCreate legal hold policy PUTUpdate legal hold policy DELRemove legal hold policy

Legal hold policy assignments

Resources

File versions on hold Files on hold Legal hold policy assignment Legal hold policy assignment (Base)Legal hold policy assignments

Endpoints

GETList legal hold policy assignments GETGet legal hold policy assignment GETList files with current file versions for legal hold policy assignment GETList previous file versions for legal hold policy assignment POSTAssign legal hold policy DELUnassign legal hold policy

Metadata cascade policies

Resources

Metadata cascade policies Metadata cascade policy

Endpoints

GETList metadata cascade policies GETGet metadata cascade policy POSTCreate metadata cascade policy POSTForce-apply metadata cascade policy to folder DELRemove metadata cascade policy

Metadata instances (Files)

Resources

Metadata instance Metadata instance (Base)Metadata instance (Full)Metadata instances

Endpoints

GETList metadata instances on file GETGet metadata instance on file POSTCreate metadata instance on file PUTUpdate metadata instance on file DELRemove metadata instance from file

Metadata instances (Folders)

Endpoints

GETList metadata instances on folder GETGet metadata instance on folder POSTCreate metadata instance on folder PUTUpdate metadata instance on folder DELRemove metadata instance from folder

Metadata templates

Resources

Metadata template Metadata templates

Endpoints

GETFind metadata template by instance ID GETGet metadata template by name GETGet metadata template by ID GETList all global metadata templates GETList all metadata templates for enterprise POSTCreate metadata template PUTUpdate metadata template DELRemove metadata template

Resources

Endpoints

GETList recently accessed items

Retention policies

Resources

Retention policies Retention policy Retention policy (Base)Retention policy (Mini)

Endpoints

GETList retention policies GETGet retention policy POSTCreate retention policy PUTUpdate retention policy DELDelete retention policy

Retention policy assignments

Resources

Files under retention Retention policy assignment Retention policy assignment (Base)Retention policy assignments

Endpoints

GETList retention policy assignments GETGet retention policy assignment GETGet files under retention GETGet file versions under retention POSTAssign retention policy DELRemove retention policy assignment

Resources

Metadata filter Metadata query index Metadata query search results Search Result (including Shared Link)Search Results Search Results (including Shared Links)

Endpoints

GETSearch for content POSTQuery files/folders by metadata

Session termination

Resources

Session termination message

Endpoints

POSTCreate jobs to terminate users session POSTCreate jobs to terminate user group session

Shared links (Files)

Endpoints

GETFind file for shared link GETGet shared link for file PUTAdd shared link to file PUTUpdate shared link on file PUTRemove shared link from file

Shared links (Folders)

Endpoints

GETFind folder for shared link GETGet shared link for folder PUTAdd shared link to folder PUTUpdate shared link on folder PUTRemove shared link from folder

Shared links (Web Links)

Endpoints

GETFind web link for shared link GETGet shared link for web link PUTAdd shared link to web link PUTUpdate shared link on web link PUTRemove shared link from web link

Shield information barrier reports

Resources

Shield information barrier reference Shield information barrier report Shield information barrier report (Base)Shield information barrier report details List of Shield Information Barrier Reports

Endpoints

GETList shield information barrier reports GETGet shield information barrier report by ID POSTCreate shield information barrier report

Shield information barrier segment members

Resources

Shield information barrier segment member Shield 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 ID GETList shield information barrier segment members POSTCreate shield information barrier segment member DELDelete shield information barrier segment member by ID

Shield information barrier segment restrictions

Resources

Shield information barrier segment restriction Shield 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 ID GETList shield information barrier segment restrictions POSTCreate shield information barrier segment restriction DELDelete shield information barrier segment restriction by ID

Shield information barrier segments

Resources

Shield information barrier segment List of Shield Information Barrier Segments

Endpoints

GETGet shield information barrier segment with specified ID GETList shield information barrier segments POSTCreate shield information barrier segment PUTUpdate shield information barrier segment with specified ID DELDelete shield information barrier segment

Shield information barriers

Resources

Shield information barrier Shield information barrier (Base)List of Shield Information Barriers

Endpoints

GETGet shield information barrier with specified ID GETList shield information barriers POSTAdd changed status of shield information barrier with specified ID POSTCreate shield information barrier

Resources

Keyword Skill Card Skills metadata instance Skill webhook payload Status Skill Card Timeline Skill Card Transcript Skill Card

Endpoints

GETList Box Skill cards on file POSTCreate Box Skill cards on file PUTUpdate Box Skill cards on file PUTUpdate all Box Skill cards on file DELRemove Box Skill cards from file

Standard and Zones Storage Policies

Resources

Storage policies Storage policy Storage policy (Mini)

Endpoints

GETList storage policies GETGet storage policy

Standard and Zones Storage Policy Assignments

Resources

Storage policy assignment Storage policy assignments

Endpoints

GETList storage policy assignments GETGet storage policy assignment POSTAssign storage policy PUTUpdate storage policy assignment DELUnassign storage policy

Task assignments

Resources

Task assignment Task assignments

Endpoints

GETList task assignments GETGet task assignment POSTAssign task PUTUpdate task assignment DELUnassign task

Resources

Endpoints

GETList tasks on file GETGet task POSTCreate task PUTUpdate task DELRemove task

Terms of service

Resources

Terms of service Terms of service (Base)Terms of services

Endpoints

GETList terms of services GETGet terms of service POSTCreate terms of service PUTUpdate terms of service

Terms of service user statuses

Resources

Terms of service user status Terms of service user statuses

Endpoints

GETList terms of service user statuses POSTCreate terms of service status for new user PUTUpdate terms of service status for existing user

Transfer folders

Endpoints

PUTTransfer owned folders

Resources

Trashed File Trashed File (Restored)

Endpoints

GETGet trashed file POSTRestore file DELPermanently remove file

Trashed folders

Resources

Trashed Folder Trashed Folder (Restored)

Endpoints

GETGet trashed folder POSTRestore folder DELPermanently remove folder

Endpoints

GETList trashed items

Trashed web links

Resources

Trashed Web Link Trashed Web Link (Restored)

Endpoints

GETGet trashed web link POSTRestore web link DELPermanently remove web link

Resources

Conflict error Upload URL

Endpoints

OPTSPreflight check before upload POSTUpload file version POSTUpload file

Uploads (Chunked)

Resources

Upload part Upload part (Mini)Upload parts Upload session Uploaded part

Endpoints

GETGet upload session GETList parts POSTCreate upload session POSTCreate upload session for existing file POSTCommit upload session PUTUpload part of file DELRemove upload session

Resources

Endpoints

GETGet user avatar POSTAdd or update user avatar DELDelete user avatar

Resources

User User (Base)User (Collaborations)User (Full)User (Mini)User (Integration Mappings)Users

Endpoints

GETList enterprise users GETGet current user GETGet user POSTCreate user PUTUpdate user DELDelete user

Watermarks (Files)

Resources

Endpoints

GETGet watermark on file PUTApply watermark to file DELRemove watermark from file

Watermarks (Folders)

Endpoints

GETGet watermark for folder PUTApply watermark to folder DELRemove watermark from folder

Resources

Web link Web link (Base)Web link (Mini)

Endpoints

GETGet web link POSTCreate web link PUTUpdate web link DELRemove web link

Resources

Webhook Webhook (Mini)Webhook (V2) payload Webhooks

Endpoints

GETList all webhooks GETGet webhook POSTCreate webhook PUTUpdate webhook DELRemove webhook

Resources

Workflow Workflow (Full)Workflow (Mini)Workflows

Endpoints

GETList workflows POSTStarts workflow based on request body

Resources

Zip download Zip download status

Endpoints

GETDownload zip archive GETGet zip download status POSTCreate zip download

Access token AI agent for question requests AI agent for extract requests AI agent for structured extract request AI agent for text generation requests AI extract response AI LLM endpoint params AWS AI LLM endpoint params Google AI LLM endpoint params OpenAI AI response

AI response (Full)App item App item association App item associations AppItem event source Classification Classification Template Client error Collaboration Allowed collaboration domains

Allowed collaboration domain Allowed collaboration domains user exemption Allowed collaboration domains user exemptions Collaborations Collaborations Collection Collections Comment Comment (Base)Comment (Full)

Comments Conflict error Device pinner Device pinners Email alias Email aliases Enterprise (Base)Event Event source Events

File File (Base)File (Full)File (Mini)File (Conflict)File Request File version File version (Base)File version (Full)File version (Mini)

File version legal hold File version legal holds File version retention File version retentions File versions File versions on hold Files Files on hold Files under retention Folder

Folder (Base)Folder (Full)Folder (Mini)Folder Lock Folder Locks Generic source Group Group (Base)Group (Full)Group (Mini)

Group membership Group memberships Groups Integration mapping (Base)Integration mapping Slack Create Slack integration mapping request Integration mappings Slack Invite Items Items

Keyword Skill Card Legal hold policies Legal hold policy Legal hold policy (Mini)Legal hold policy assignment Legal hold policy assignment (Base)Legal hold policy assignments Metadata instance Metadata instance (Base)Metadata instance (Full)

Metadata cascade policies Metadata cascade policy Metadata field filter (date range)Metadata field filter (float range)Metadata filter Metadata query index Metadata query search results Metadata template Metadata templates Metadata instances

OAuth 2.0 error Real-time server Real-time servers Recent item Recent items Retention policies Retention policy Retention policy (Base)Retention policy (Mini)Retention policy assignment

Retention policy assignment (Base)Retention policy assignments Search Result (including Shared Link)Search Results Search Results (including Shared Links)Session termination message Shield information barrier Shield information barrier (Base)Shield information barrier reference Shield information barrier report

Shield information barrier report (Base)Shield information barrier report details List of Shield Information Barrier Reports Shield information barrier segment Shield information barrier segment member Shield information barrier segment member (Base)Shield information barrier segment member (Mini)List of Shield Information Barrier Segment Members Shield information barrier segment restriction Shield information barrier segment restriction (Base)

Shield information barrier segment restriction (Mini)List of Shield Information Barrier Segment Restrictions List of Shield Information Barrier Segments List of Shield Information Barriers Box Sign request Create a Box Sign request Box Sign requests Box Sign template Box Sign templates Skills metadata instance

Skill webhook payload Status Skill Card Storage policies Storage policy Storage policy (Mini)Storage policy assignment Storage policy assignments Task Task assignment Task assignments

Tasks Terms of service Terms of service (Base)Terms of service user status Terms of services Terms of service user statuses Timeline Skill Card Transcript Skill Card Trashed File Trashed File (Restored)

Trashed Folder Trashed Folder (Restored)Trashed Web Link Trashed Web Link (Restored)Upload part Upload part (Mini)Upload parts Upload session Upload URL Uploaded part

User User (Base)User (Full)User (Mini)User avatar User (Collaborations)User (Integration Mappings)Users Watermark Web link

Web link (Base)Web link (Mini)Webhook Webhook (Mini)Webhook (V2) payload Webhooks Workflow Workflow (Full)Workflow (Mini)Workflows

Zip download Zip download status