Skip to content

Box API

by box.com

Open documentation ↗

Overview

File Sharing and Storage

Box is a cloud storage & file sharing API from box.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 258 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Base URL
https://api.box.com/2.0
Version
2.0.0
Endpoints
258
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.box.com/2.0/authorize" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://api.box.com/2.0/authorize", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.box.com/2.0/authorize",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/authorizeAuthorize user
GET/collaboration_whitelist_entriesList allowed collaboration domains
POST/collaboration_whitelist_entriesAdd domain to list of allowed collaboration domains
GET/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}Get allowed collaboration domain
DELETE/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}Remove domain from list of allowed collaboration domains
GET/collaboration_whitelist_exempt_targetsList users exempt from collaboration domain restrictions
POST/collaboration_whitelist_exempt_targetsCreate user exemption from collaboration domain restrictions
GET/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}Get user exempt from collaboration domain restrictions
DELETE/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}Remove user from list of users exempt from domain restrictions
GET/collaborationsList pending collaborations
POST/collaborationsCreate collaboration
GET/collaborations/{collaboration_id}Get collaboration
PUT/collaborations/{collaboration_id}Update collaboration
DELETE/collaborations/{collaboration_id}Remove collaboration
GET/collectionsList all collections
GET/collections/{collection_id}/itemsList collection items
POST/commentsCreate comment
GET/comments/{comment_id}Get comment
PUT/comments/{comment_id}Update comment
DELETE/comments/{comment_id}Remove comment
GET/device_pinners/{device_pinner_id}Get device pin
DELETE/device_pinners/{device_pinner_id}Remove device pin
GET/enterprises/{enterprise_id}/device_pinnersList enterprise device pins
GET/eventsList user and enterprise events
GET/file_requests/{file_request_id}Get file request
PUT/file_requests/{file_request_id}Update file request
DELETE/file_requests/{file_request_id}Delete file request
POST/file_requests/{file_request_id}/copyCopy file request
GET/file_version_legal_holdsList file version legal holds
GET/file_version_legal_holds/{file_version_legal_hold_id}Get file version legal hold
GET/file_version_retentionsList file version retentions
GET/file_version_retentions/{file_version_retention_id}Get retention on file
POST/files/contentUpload file
POST/files/upload_sessionsCreate upload session
GET/files/upload_sessions/{upload_session_id}Get upload session
PUT/files/upload_sessions/{upload_session_id}Upload part of file
DELETE/files/upload_sessions/{upload_session_id}Remove upload session
POST/files/upload_sessions/{upload_session_id}/commitCommit upload session
GET/files/upload_sessions/{upload_session_id}/partsList parts
GET/files/{file_id}Get file information
POST/files/{file_id}Restore file
PUT/files/{file_id}Update file
DELETE/files/{file_id}Delete file
PUT/files/{file_id}#add_shared_linkAdd shared link to file
GET/files/{file_id}#get_shared_linkGet shared link for file
PUT/files/{file_id}#remove_shared_linkRemove shared link from file
PUT/files/{file_id}#update_shared_linkUpdate shared link on file
GET/files/{file_id}/collaborationsList file collaborations
GET/files/{file_id}/commentsList file comments
GET/files/{file_id}/contentDownload file
POST/files/{file_id}/contentUpload file version
POST/files/{file_id}/copyCopy file
GET/files/{file_id}/metadataList metadata instances on file
GET/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWoGet classification on file
POST/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWoAdd classification to file
PUT/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWoUpdate classification on file
DELETE/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWoRemove classification from file
GET/files/{file_id}/metadata/global/boxSkillsCardsList Box Skill cards on file
POST/files/{file_id}/metadata/global/boxSkillsCardsCreate Box Skill cards on file
PUT/files/{file_id}/metadata/global/boxSkillsCardsUpdate Box Skill cards on file
DELETE/files/{file_id}/metadata/global/boxSkillsCardsRemove Box Skill cards from file
GET/files/{file_id}/metadata/{scope}/{template_key}Get metadata instance on file
POST/files/{file_id}/metadata/{scope}/{template_key}Create metadata instance on file
PUT/files/{file_id}/metadata/{scope}/{template_key}Update metadata instance on file
DELETE/files/{file_id}/metadata/{scope}/{template_key}Remove metadata instance from file
GET/files/{file_id}/tasksList tasks on file
GET/files/{file_id}/thumbnail.{extension}Get file thumbnail
GET/files/{file_id}/trashGet trashed file
DELETE/files/{file_id}/trashPermanently remove file
POST/files/{file_id}/upload_sessionsCreate upload session for existing file
GET/files/{file_id}/versionsList all file versions
POST/files/{file_id}/versions/currentPromote file version
GET/files/{file_id}/versions/{file_version_id}Get file version
PUT/files/{file_id}/versions/{file_version_id}Restore file version
DELETE/files/{file_id}/versions/{file_version_id}Remove file version
GET/files/{file_id}/watermarkGet watermark on file
PUT/files/{file_id}/watermarkApply watermark to file
DELETE/files/{file_id}/watermarkRemove watermark from file
GET/folder_locksList folder locks
POST/folder_locksCreate folder lock
DELETE/folder_locks/{folder_lock_id}Delete folder lock
POST/foldersCreate folder
GET/folders/trash/itemsList trashed items
GET/folders/{folder_id}Get folder information
POST/folders/{folder_id}Restore folder
PUT/folders/{folder_id}Update folder
DELETE/folders/{folder_id}Delete folder
PUT/folders/{folder_id}#add_shared_linkAdd shared link to folder
GET/folders/{folder_id}#get_shared_linkGet shared link for folder
PUT/folders/{folder_id}#remove_shared_linkRemove shared link from folder
PUT/folders/{folder_id}#update_shared_linkUpdate shared link on folder
GET/folders/{folder_id}/collaborationsList folder collaborations
POST/folders/{folder_id}/copyCopy folder
GET/folders/{folder_id}/itemsList items in folder
GET/folders/{folder_id}/metadataList metadata instances on folder
GET/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWoGet classification on folder
POST/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWoAdd classification to folder
PUT/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWoUpdate classification on folder
DELETE/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWoRemove classification from folder
GET/folders/{folder_id}/metadata/{scope}/{template_key}Get metadata instance on folder

Showing the first 100 of 258 endpoints; the full list is in the documentation.

Questions

Does the Box API need an API key?

Yes. The Box API uses OAuth authentication; the documentation explains how to get credentials.

Does the Box API support HTTPS?

Yes, the Box API is served over HTTPS.

How many endpoints does the Box API have?

Its OpenAPI description lists 258 endpoints in version 2.0.0. The first 100 are shown on this page.

What are alternatives to the Box API?

Other Cloud Storage & File Sharing APIs include Dropbox, OneDrive, Google Drive, Gyazo, Imgbb.

Compare alternatives →

Listed from public-apis (MIT), public-apis database (MIT), APIs.guru (CC0).