Box Platform API
[Box Platform](https://box.dev) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.
Base URL:
Auth: unknown
Endpoints: 103
Reachable: unknown
CORS: unknown
https://api.box.com/2.0Auth: unknown
Endpoints: 103
Reachable: unknown
CORS: unknown
Links
Endpoints
| Method | Path | Summary | Auth | Last Status | Latency |
|---|---|---|---|---|---|
GET |
/collaboration_whitelist_entries | List allowed collaboration domains | — | — | — |
GET |
/collaboration_whitelist_entries/{collaboration_whitelist_entry_id} | Get allowed collaboration domain | — | — | — |
GET |
/collaboration_whitelist_exempt_targets | List users exempt from collaboration domain restrictions | — | — | — |
GET |
/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} | Get user exempt from collaboration domain restrictions | — | — | — |
GET |
/collaborations | List pending collaborations | — | — | — |
GET |
/collaborations/{collaboration_id} | Get collaboration | — | — | — |
GET |
/collections | List all collections | — | — | — |
GET |
/collections/{collection_id}/items | List collection items | — | — | — |
GET |
/comments/{comment_id} | Get comment | — | — | — |
GET |
/device_pinners/{device_pinner_id} | Get 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 | — | — | — |
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 | — | — | — |
GET |
/files/upload_sessions/{upload_session_id} | Get upload session | — | — | — |
GET |
/files/upload_sessions/{upload_session_id}/parts | List parts | — | — | — |
GET |
/files/{file_id} | Get file information | — | — | — |
GET |
/files/{file_id}#get_shared_link | Get shared link for file | — | — | — |
GET |
/files/{file_id}/collaborations | List file collaborations | — | — | — |
GET |
/files/{file_id}/comments | List file comments | — | — | — |
GET |
/files/{file_id}/content | Download file | — | — | — |
GET |
/files/{file_id}/metadata | List metadata instances on file | — | — | — |
GET |
/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo | Get classification on file | — | — | — |
GET |
/files/{file_id}/metadata/global/boxSkillsCards | List Box Skill cards on file | — | — | — |
GET |
/files/{file_id}/metadata/{scope}/{template_key} | Get metadata instance on 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 | — | — | — |
GET |
/files/{file_id}/versions | List all file versions | — | — | — |
GET |
/files/{file_id}/versions/{file_version_id} | Get file version | — | — | — |
GET |
/files/{file_id}/watermark | Get watermark on file | — | — | — |
GET |
/folder_locks | List folder locks | — | — | — |
GET |
/folders/trash/items | List trashed items | — | — | — |
GET |
/folders/{folder_id} | Get folder information | — | — | — |
GET |
/folders/{folder_id}#get_shared_link | Get shared link for folder | — | — | — |
GET |
/folders/{folder_id}/collaborations | List folder collaborations | — | — | — |
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 | — | — | — |
GET |
/folders/{folder_id}/metadata/{scope}/{template_key} | Get metadata instance on folder | — | — | — |
GET |
/folders/{folder_id}/trash | Get trashed folder | — | — | — |
GET |
/folders/{folder_id}/watermark | Get watermark for folder | — | — | — |
GET |
/group_memberships/{group_membership_id} | Get group membership | — | — | — |
GET |
/groups | List groups for enterprise | — | — | — |
GET |
/groups/{group_id} | Get group | — | — | — |
GET |
/groups/{group_id}/collaborations | List group collaborations | — | — | — |
GET |
/invites/{invite_id} | Get user invite status | — | — | — |
GET |
/legal_hold_policies | List all legal hold policies | — | — | — |
GET |
/legal_hold_policies/{legal_hold_policy_id} | Get legal hold policy | — | — | — |
GET |
/legal_hold_policy_assignments | List legal hold policy assignments | — | — | — |
GET |
/legal_hold_policy_assignments/{legal_hold_policy_assignment_id} | Get legal hold policy assignment | — | — | — |
GET |
/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold | List previous file versions for legal hold policy assignment | — | — | — |
GET |
/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold | List current file versions for legal hold policy assignment | — | — | — |
GET |
/metadata_cascade_policies | List metadata cascade policies | — | — | — |
GET |
/metadata_cascade_policies/{metadata_cascade_policy_id} | Get metadata cascade policy | — | — | — |
GET |
/metadata_query_indices | List metadata query indices | — | — | — |
GET |
/metadata_templates | Find metadata template by instance ID | — | — | — |
GET |
/metadata_templates/enterprise | List all metadata templates for enterprise | — | — | — |
GET |
/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema | List all classifications | — | — | — |
GET |
/metadata_templates/global | List all global metadata templates | — | — | — |
GET |
/metadata_templates/{scope}/{template_key}/schema | Get metadata template by name | — | — | — |
GET |
/metadata_templates/{template_id} | Get metadata template by ID | — | — | — |
GET |
/recent_items | List recently accessed items | — | — | — |
GET |
/retention_policies | List retention policies | — | — | — |
GET |
/retention_policies/{retention_policy_id} | Get retention policy | — | — | — |
GET |
/retention_policies/{retention_policy_id}/assignments | List retention policy assignments | — | — | — |
GET |
/retention_policy_assignments/{retention_policy_assignment_id} | Get retention policy assignment | — | — | — |
GET |
/retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention | Get file versions under retention | — | — | — |
GET |
/retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention | Get files under retention | — | — | — |
GET |
/search | Search for content | — | — | — |
GET |
/shared_items | Find file for shared link | — | — | — |
GET |
/shared_items#folders | Find folder for shared link | — | — | — |
GET |
/shared_items#web_links | Find web link for shared link | — | — | — |
GET |
/shield_information_barrier_reports | List shield information barrier reports | — | — | — |
GET |
/shield_information_barrier_reports/{shield_information_barrier_report_id} | Get shield information barrier report by ID | — | — | — |
GET |
/shield_information_barrier_segment_members | List shield information barrier segment members | — | — | — |
GET |
/shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id} | Get shield information barrier segment member by ID | — | — | — |
GET |
/shield_information_barrier_segment_restrictions | List shield information barrier segment restrictions | — | — | — |
GET |
/shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id} | Get shield information barrier segment restriction by ID | — | — | — |
GET |
/shield_information_barrier_segments | List shield information barrier segments | — | — | — |
GET |
/shield_information_barrier_segments/{shield_information_barrier_segment_id} | Get shield information barrier segment with specified ID | — | — | — |
GET |
/shield_information_barriers | List shield information barriers | — | — | — |
GET |
/shield_information_barriers/{shield_information_barrier_id} | Get shield information barrier with specified ID | — | — | — |
GET |
/sign_requests | List sign requests | — | — | — |
GET |
/sign_requests/{sign_request_id} | Get sign request by ID | — | — | — |
GET |
/storage_policies | List storage policies | — | — | — |
GET |
/storage_policies/{storage_policy_id} | Get storage policy | — | — | — |
GET |
/storage_policy_assignments | List storage policy assignments | — | — | — |
GET |
/storage_policy_assignments/{storage_policy_assignment_id} | Get storage policy assignment | — | — | — |
GET |
/task_assignments/{task_assignment_id} | Get task assignment | — | — | — |
GET |
/tasks/{task_id} | Get task | — | — | — |
GET |
/tasks/{task_id}/assignments | List task assignments | — | — | — |
GET |
/terms_of_service_user_statuses | List terms of service user statuses | — | — | — |
GET |
/terms_of_services | List terms of services | — | — | — |
GET |
/terms_of_services/{terms_of_service_id} | Get terms of service | — | — | — |
GET |
/web_links/{web_link_id} | Get web link | — | — | — |
GET |
/web_links/{web_link_id}#get_shared_link | Get shared link for web link | — | — | — |
GET |
/web_links/{web_link_id}/trash | Get trashed web link | — | — | — |
GET |
/workflows | List workflows | — | — | — |
GET |
/zip_downloads/{zip_download_id}/content | Download zip archive | — | — | — |
GET |
/zip_downloads/{zip_download_id}/status | Get zip download status | — | — | — |