API Reference

Resources

OAuth 2.0 error Access token

Endpoints

GETAuthorize user POSTRequest access token POSTRefresh access token POSTRevoke access token

Resources

Endpoints

GETGet sign request by ID GETList sign requests POSTCancel sign request POSTResend sign request POSTCreate sign request

Classifications

Resources

Classification Classification Template

Endpoints

GETList all classifications POSTAdd initial classifications PUTAdd classification PUTUpdate classification PUTDelete classification DELDelete all classifications

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

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

Resources

Comment Comments Comment (Base)Comment (Full)

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 domain Allowed collaboration domains

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 POSTRevert file version DELRemove file version

Resources

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

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 (Full)Folder (Mini)Folder (Base)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 Groups Group (Base)Group (Full)Group (Mini)

Endpoints

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

Resources

Endpoints

GETGet user invite status POSTCreate user invite

Legal hold policies

Resources

Legal hold policy Legal hold policies 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

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 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 policy Metadata cascade policies

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 (Full)Metadata instance (Base)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 (Mini)Retention policy (Base)

Endpoints

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

Retention policy assignments

Resources

Files under retention Retention policy assignment Retention policy assignments

Endpoints

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

Resources

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

Endpoints

GETList metadata query indices GETSearch for content POSTQuery files/folders by metadata

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

Resources

Skill webhook payload Skills metadata instance Skill Card Keyword Skill Card Timeline Skill Card Transcript Skill Card Status 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 policy Storage policies 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 services Terms of service (Mini)

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

Endpoints

GETGet trashed file POSTRestore file DELPermanently remove file

Trashed folders

Endpoints

GETGet trashed folder POSTRestore folder DELPermanently remove folder

Endpoints

GETList trashed items

Trashed web links

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)Uploaded part Upload parts Upload session

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

Endpoints

GETGet user avatar

Resources

User Users User (Full)User (Mini)User (Base)

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 (V2) payload Webhook Webhook (Mini)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 Classification Classification Template Client error Collaboration Allowed collaboration domains Allowed collaboration domain Allowed collaboration domains user exemption Allowed collaboration domains user exemptions Collaborations

Collection Collections Comment Comment (Base)Comment (Full)Comments Conflict error Device pinner Device pinners Email alias

Email aliases Event Event source Events File File (Base)File (Full)File (Mini)File (Conflict)File Request

File version File version (Base)File version (Mini)File version legal hold File version legal holds File version retention File version retentions File versions Files Files under retention

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

Group membership Group memberships Groups Invite 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)Metadata field filter (float range)

Metadata field filter (multi-select)Metadata field filter (string)Metadata filter Metadata query index Metadata query indices 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 assignments

Search Result (including Shared Link)Search Results Search Results (including Shared Links)Box Sign Skill Card 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 (Mini)Terms of service user status

Terms of services Terms of service user statuses Timeline Skill Card Transcript Skill Card Upload part Upload part (Mini)Upload parts Upload session Upload URL Uploaded part

User User (Base)User (Full)User (Mini)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