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
- Category
- Cloud Storage & File Sharing
- Base URL
https://api.box.com/2.0- Version
- 2.0.0
- Endpoints
- 258
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.box.com/2.0/authorize" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"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);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
| Method | Path | What it does |
|---|---|---|
| GET | /authorize | Authorize user |
| GET | /collaboration_whitelist_entries | List allowed collaboration domains |
| POST | /collaboration_whitelist_entries | Add 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_targets | List users exempt from collaboration domain restrictions |
| POST | /collaboration_whitelist_exempt_targets | Create 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 | /collaborations | List pending collaborations |
| POST | /collaborations | Create collaboration |
| GET | /collaborations/{collaboration_id} | Get collaboration |
| PUT | /collaborations/{collaboration_id} | Update collaboration |
| DELETE | /collaborations/{collaboration_id} | Remove collaboration |
| GET | /collections | List all collections |
| GET | /collections/{collection_id}/items | List collection items |
| POST | /comments | Create 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_pinners | List enterprise device pins |
| GET | /events | List 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}/copy | Copy file request |
| GET | /file_version_legal_holds | List file version legal holds |
| GET | /file_version_legal_holds/{file_version_legal_hold_id} | Get file version legal hold |
| GET | /file_version_retentions | List file version retentions |
| GET | /file_version_retentions/{file_version_retention_id} | Get retention on file |
| POST | /files/content | Upload file |
| POST | /files/upload_sessions | Create 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}/commit | Commit upload session |
| GET | /files/upload_sessions/{upload_session_id}/parts | List 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_link | Add shared link to file |
| GET | /files/{file_id}#get_shared_link | Get shared link for file |
| PUT | /files/{file_id}#remove_shared_link | Remove shared link from file |
| PUT | /files/{file_id}#update_shared_link | Update shared link on file |
| GET | /files/{file_id}/collaborations | List file collaborations |
| GET | /files/{file_id}/comments | List file comments |
| GET | /files/{file_id}/content | Download file |
| POST | /files/{file_id}/content | Upload file version |
| POST | /files/{file_id}/copy | Copy file |
| GET | /files/{file_id}/metadata | List metadata instances on file |
| GET | /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Get classification on file |
| POST | /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Add classification to file |
| PUT | /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Update classification on file |
| DELETE | /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Remove classification from file |
| GET | /files/{file_id}/metadata/global/boxSkillsCards | List Box Skill cards on file |
| POST | /files/{file_id}/metadata/global/boxSkillsCards | Create Box Skill cards on file |
| PUT | /files/{file_id}/metadata/global/boxSkillsCards | Update Box Skill cards on file |
| DELETE | /files/{file_id}/metadata/global/boxSkillsCards | Remove 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}/tasks | List tasks on file |
| GET | /files/{file_id}/thumbnail.{extension} | Get file thumbnail |
| GET | /files/{file_id}/trash | Get trashed file |
| DELETE | /files/{file_id}/trash | Permanently remove file |
| POST | /files/{file_id}/upload_sessions | Create upload session for existing file |
| GET | /files/{file_id}/versions | List all file versions |
| POST | /files/{file_id}/versions/current | Promote 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}/watermark | Get watermark on file |
| PUT | /files/{file_id}/watermark | Apply watermark to file |
| DELETE | /files/{file_id}/watermark | Remove watermark from file |
| GET | /folder_locks | List folder locks |
| POST | /folder_locks | Create folder lock |
| DELETE | /folder_locks/{folder_lock_id} | Delete folder lock |
| POST | /folders | Create folder |
| GET | /folders/trash/items | List 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_link | Add shared link to folder |
| GET | /folders/{folder_id}#get_shared_link | Get shared link for folder |
| PUT | /folders/{folder_id}#remove_shared_link | Remove shared link from folder |
| PUT | /folders/{folder_id}#update_shared_link | Update shared link on folder |
| GET | /folders/{folder_id}/collaborations | List folder collaborations |
| POST | /folders/{folder_id}/copy | Copy folder |
| GET | /folders/{folder_id}/items | List items in folder |
| GET | /folders/{folder_id}/metadata | List metadata instances on folder |
| GET | /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Get classification on folder |
| POST | /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Add classification to folder |
| PUT | /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Update classification on folder |
| DELETE | /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Remove 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.
Similar cloud storage & file sharing APIs
Compare alternatives →Dropbox
Cloud Storage & File SharingFile Sharing and Storage
OneDrive
Cloud Storage & File SharingFile Sharing and Storage
Google Drive
Cloud Storage & File SharingFile Sharing and Storage
Gyazo
Cloud Storage & File SharingSave & Share screen captures instantly
Imgbb
Cloud Storage & File SharingSimple and quick private image sharing
Quip
Cloud Storage & File SharingFile Sharing and Storage for groups
Listed from public-apis (MIT), public-apis database (MIT), APIs.guru (CC0).