Box Platform API

Box Platform API

API version: 2024.0

Auth

OAuth2

Base URL

https://api.box.com/2.0

Setup

1. Configure auth: OAuth2
2. GET /authorize -- verify access
3. POST /oauth2/token -- create first token

Endpoints

296 endpoints across 56 groups. See references/api-spec.lap for full details.

authorize

oauth2

files

file_requests

folders

folder_locks

metadata_templates

metadata_cascade_policies

metadata_queries

comments

collaborations

search

tasks

task_assignments

shared_items

shared_items#folders

web_links

shared_items#web_links

shared_items#app_items

users

invites

groups

group_memberships

webhooks

skill_invocations

events

collections

recent_items

retention_policies

retention_policy_assignments

legal_hold_policies

legal_hold_policy_assignments

file_version_retentions

file_version_legal_holds

shield_information_barriers

shield_information_barrier_reports

shield_information_barrier_segments

shield_information_barrier_segment_members

shield_information_barrier_segment_restrictions

device_pinners

enterprises

terms_of_services

terms_of_service_user_statuses

collaboration_whitelist_entries

collaboration_whitelist_exempt_targets

storage_policies

storage_policy_assignments

zip_downloads

sign_requests

workflows

sign_templates

integration_mappings

ai

ai_agent_default

ai_agents

metadata_taxonomies

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all authorize?" -> GET /authorize
• "Create a token?" -> POST /oauth2/token
• "Create a token#refresh?" -> POST /oauth2/token#refresh
• "Create a revoke?" -> POST /oauth2/revoke
• "Get file details?" -> GET /files/{file_id}
• "Update a file?" -> PUT /files/{file_id}
• "Delete a file?" -> DELETE /files/{file_id}
• "List all app_item_associations?" -> GET /files/{file_id}/app_item_associations
• "List all content?" -> GET /files/{file_id}/content
• "Create a content?" -> POST /files/{file_id}/content
• "Create a content?" -> POST /files/content
• "Create a upload_session?" -> POST /files/upload_sessions
• "Create a upload_session?" -> POST /files/{file_id}/upload_sessions
• "Get upload_session details?" -> GET /files/upload_sessions/{upload_session_id}
• "Update a upload_session?" -> PUT /files/upload_sessions/{upload_session_id}
• "Delete a upload_session?" -> DELETE /files/upload_sessions/{upload_session_id}
• "List all parts?" -> GET /files/upload_sessions/{upload_session_id}/parts
• "Create a commit?" -> POST /files/upload_sessions/{upload_session_id}/commit
• "Create a copy?" -> POST /files/{file_id}/copy
• "Get thumbnail.{extension} details?" -> GET /files/{file_id}/thumbnail.{extension}
• "List all collaborations?" -> GET /files/{file_id}/collaborations
• "List all comments?" -> GET /files/{file_id}/comments
• "List all tasks?" -> GET /files/{file_id}/tasks
• "List all trash?" -> GET /files/{file_id}/trash
• "List all versions?" -> GET /files/{file_id}/versions
• "Get version details?" -> GET /files/{file_id}/versions/{file_version_id}
• "Delete a version?" -> DELETE /files/{file_id}/versions/{file_version_id}
• "Update a version?" -> PUT /files/{file_id}/versions/{file_version_id}
• "Create a current?" -> POST /files/{file_id}/versions/current
• "List all metadata?" -> GET /files/{file_id}/metadata
• "List all securityClassification-6VMVochwUWo?" -> GET /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
• "Create a securityClassification-6VMVochwUWo?" -> POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
• "Get metadata details?" -> GET /files/{file_id}/metadata/{scope}/{template_key}
• "Update a metadata?" -> PUT /files/{file_id}/metadata/{scope}/{template_key}
• "Delete a metadata?" -> DELETE /files/{file_id}/metadata/{scope}/{template_key}
• "List all boxSkillsCards?" -> GET /files/{file_id}/metadata/global/boxSkillsCards
• "Create a boxSkillsCard?" -> POST /files/{file_id}/metadata/global/boxSkillsCards
• "List all watermark?" -> GET /files/{file_id}/watermark
• "Get file_request details?" -> GET /file_requests/{file_request_id}
• "Update a file_request?" -> PUT /file_requests/{file_request_id}
• "Delete a file_request?" -> DELETE /file_requests/{file_request_id}
• "Create a copy?" -> POST /file_requests/{file_request_id}/copy
• "Get folder details?" -> GET /folders/{folder_id}
• "Update a folder?" -> PUT /folders/{folder_id}
• "Delete a folder?" -> DELETE /folders/{folder_id}
• "List all app_item_associations?" -> GET /folders/{folder_id}/app_item_associations
• "List all items?" -> GET /folders/{folder_id}/items
• "Create a folder?" -> POST /folders
• "Create a copy?" -> POST /folders/{folder_id}/copy
• "List all collaborations?" -> GET /folders/{folder_id}/collaborations
• "List all trash?" -> GET /folders/{folder_id}/trash
• "List all metadata?" -> GET /folders/{folder_id}/metadata
• "List all securityClassification-6VMVochwUWo?" -> GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo
• "Create a securityClassification-6VMVochwUWo?" -> POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo
• "Get metadata details?" -> GET /folders/{folder_id}/metadata/{scope}/{template_key}
• "Update a metadata?" -> PUT /folders/{folder_id}/metadata/{scope}/{template_key}
• "Delete a metadata?" -> DELETE /folders/{folder_id}/metadata/{scope}/{template_key}
• "List all items?" -> GET /folders/trash/items
• "List all watermark?" -> GET /folders/{folder_id}/watermark
• "List all folder_locks?" -> GET /folder_locks
• "Create a folder_lock?" -> POST /folder_locks
• "Delete a folder_lock?" -> DELETE /folder_locks/{folder_lock_id}
• "List all metadata_templates?" -> GET /metadata_templates
• "List all schema?" -> GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema
• "List all schema?" -> GET /metadata_templates/{scope}/{template_key}/schema
• "Get metadata_template details?" -> GET /metadata_templates/{template_id}
• "List all global?" -> GET /metadata_templates/global
• "List all enterprise?" -> GET /metadata_templates/enterprise
• "Create a schema?" -> POST /metadata_templates/schema
• "Create a schema#classification?" -> POST /metadata_templates/schema#classifications
• "List all metadata_cascade_policies?" -> GET /metadata_cascade_policies
• "Create a metadata_cascade_policy?" -> POST /metadata_cascade_policies
• "Get metadata_cascade_policy details?" -> GET /metadata_cascade_policies/{metadata_cascade_policy_id}
• "Delete a metadata_cascade_policy?" -> DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}
• "Create a apply?" -> POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply
• "Create a execute_read?" -> POST /metadata_queries/execute_read
• "Get comment details?" -> GET /comments/{comment_id}
• "Update a comment?" -> PUT /comments/{comment_id}
• "Delete a comment?" -> DELETE /comments/{comment_id}
• "Create a comment?" -> POST /comments
• "Get collaboration details?" -> GET /collaborations/{collaboration_id}
• "Update a collaboration?" -> PUT /collaborations/{collaboration_id}
• "Delete a collaboration?" -> DELETE /collaborations/{collaboration_id}
• "List all collaborations?" -> GET /collaborations
• "Create a collaboration?" -> POST /collaborations
• "Search search?" -> GET /search
• "Create a task?" -> POST /tasks
• "Get task details?" -> GET /tasks/{task_id}
• "Update a task?" -> PUT /tasks/{task_id}
• "Delete a task?" -> DELETE /tasks/{task_id}
• "List all assignments?" -> GET /tasks/{task_id}/assignments
• "Create a task_assignment?" -> POST /task_assignments
• "Get task_assignment details?" -> GET /task_assignments/{task_assignment_id}
• "Update a task_assignment?" -> PUT /task_assignments/{task_assignment_id}
• "Delete a task_assignment?" -> DELETE /task_assignments/{task_assignment_id}
• "List all shared_items?" -> GET /shared_items
• "Get file details?" -> GET /files/{file_id}#get_shared_link
• "Update a file?" -> PUT /files/{file_id}#add_shared_link
• "Update a file?" -> PUT /files/{file_id}#update_shared_link
• "Update a file?" -> PUT /files/{file_id}#remove_shared_link
• "List all shared_items#folders?" -> GET /shared_items#folders
• "Get folder details?" -> GET /folders/{folder_id}#get_shared_link
• "Update a folder?" -> PUT /folders/{folder_id}#add_shared_link
• "Update a folder?" -> PUT /folders/{folder_id}#update_shared_link
• "Update a folder?" -> PUT /folders/{folder_id}#remove_shared_link
• "Create a web_link?" -> POST /web_links
• "Get web_link details?" -> GET /web_links/{web_link_id}
• "Update a web_link?" -> PUT /web_links/{web_link_id}
• "Delete a web_link?" -> DELETE /web_links/{web_link_id}
• "List all trash?" -> GET /web_links/{web_link_id}/trash
• "List all shared_items#web_links?" -> GET /shared_items#web_links
• "Get web_link details?" -> GET /web_links/{web_link_id}#get_shared_link
• "Update a web_link?" -> PUT /web_links/{web_link_id}#add_shared_link
• "Update a web_link?" -> PUT /web_links/{web_link_id}#update_shared_link
• "Update a web_link?" -> PUT /web_links/{web_link_id}#remove_shared_link
• "List all shared_items#app_items?" -> GET /shared_items#app_items
• "List all users?" -> GET /users
• "Create a user?" -> POST /users
• "List all me?" -> GET /users/me
• "Create a terminate_session?" -> POST /users/terminate_sessions
• "Get user details?" -> GET /users/{user_id}
• "Update a user?" -> PUT /users/{user_id}
• "Delete a user?" -> DELETE /users/{user_id}
• "List all avatar?" -> GET /users/{user_id}/avatar
• "Create a avatar?" -> POST /users/{user_id}/avatar
• "List all email_aliases?" -> GET /users/{user_id}/email_aliases
• "Create a email_aliase?" -> POST /users/{user_id}/email_aliases
• "Delete a email_aliase?" -> DELETE /users/{user_id}/email_aliases/{email_alias_id}
• "List all memberships?" -> GET /users/{user_id}/memberships
• "Create a invite?" -> POST /invites
• "Get invite details?" -> GET /invites/{invite_id}
• "List all groups?" -> GET /groups
• "Create a group?" -> POST /groups
• "Create a terminate_session?" -> POST /groups/terminate_sessions
• "Get group details?" -> GET /groups/{group_id}
• "Update a group?" -> PUT /groups/{group_id}
• "Delete a group?" -> DELETE /groups/{group_id}
• "List all memberships?" -> GET /groups/{group_id}/memberships
• "List all collaborations?" -> GET /groups/{group_id}/collaborations
• "Create a group_membership?" -> POST /group_memberships
• "Get group_membership details?" -> GET /group_memberships/{group_membership_id}
• "Update a group_membership?" -> PUT /group_memberships/{group_membership_id}
• "Delete a group_membership?" -> DELETE /group_memberships/{group_membership_id}
• "List all webhooks?" -> GET /webhooks
• "Create a webhook?" -> POST /webhooks
• "Get webhook details?" -> GET /webhooks/{webhook_id}
• "Update a webhook?" -> PUT /webhooks/{webhook_id}
• "Delete a webhook?" -> DELETE /webhooks/{webhook_id}
• "Update a skill_invocation?" -> PUT /skill_invocations/{skill_id}
• "List all events?" -> GET /events
• "List all collections?" -> GET /collections
• "List all items?" -> GET /collections/{collection_id}/items
• "Get collection details?" -> GET /collections/{collection_id}
• "List all recent_items?" -> GET /recent_items
• "List all retention_policies?" -> GET /retention_policies
• "Create a retention_policy?" -> POST /retention_policies
• "Get retention_policy details?" -> GET /retention_policies/{retention_policy_id}
• "Update a retention_policy?" -> PUT /retention_policies/{retention_policy_id}
• "Delete a retention_policy?" -> DELETE /retention_policies/{retention_policy_id}
• "List all assignments?" -> GET /retention_policies/{retention_policy_id}/assignments
• "Create a retention_policy_assignment?" -> POST /retention_policy_assignments
• "Get retention_policy_assignment details?" -> GET /retention_policy_assignments/{retention_policy_assignment_id}
• "Delete a retention_policy_assignment?" -> DELETE /retention_policy_assignments/{retention_policy_assignment_id}
• "List all files_under_retention?" -> GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention
• "List all file_versions_under_retention?" -> GET /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention
• "List all legal_hold_policies?" -> GET /legal_hold_policies
• "Create a legal_hold_policy?" -> POST /legal_hold_policies
• "Get legal_hold_policy details?" -> GET /legal_hold_policies/{legal_hold_policy_id}
• "Update a legal_hold_policy?" -> PUT /legal_hold_policies/{legal_hold_policy_id}
• "Delete a legal_hold_policy?" -> DELETE /legal_hold_policies/{legal_hold_policy_id}
• "List all legal_hold_policy_assignments?" -> GET /legal_hold_policy_assignments
• "Create a legal_hold_policy_assignment?" -> POST /legal_hold_policy_assignments
• "Get legal_hold_policy_assignment details?" -> GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}
• "Delete a legal_hold_policy_assignment?" -> DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}
• "List all files_on_hold?" -> GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold
• "List all file_version_retentions?" -> GET /file_version_retentions
• "List all file_versions_on_hold?" -> GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold
• "Get file_version_retention details?" -> GET /file_version_retentions/{file_version_retention_id}
• "Get file_version_legal_hold details?" -> GET /file_v

…(truncated)