box-platform-api — quality + safety report

---
name: box-platform-api
description: "Box Platform API skill. Use when working with Box Platform for authorize, oauth2, files. Covers 296 endpoints."
version: 1.0.0
generator: lapsh
---

# 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
| Method | Path | Description |
|--------|------|-------------|
| GET | /authorize | Authorize user |

### oauth2
| Method | Path | Description |
|--------|------|-------------|
| POST | /oauth2/token | Request access token |
| POST | /oauth2/token#refresh | Refresh access token |
| POST | /oauth2/revoke | Revoke access token |

### files
| Method | Path | Description |
|--------|------|-------------|
| 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 |
| GET | /files/{file_id}/app_item_associations | List file app item associations |
| GET | /files/{file_id}/content | Download file |
| POST | /files/{file_id}/content | Upload file version |
| OPTIONS | /files/content | Preflight check before upload |
| POST | /files/content | Upload file |
| POST | /files/upload_sessions | Create upload session |
| POST | /files/{file_id}/upload_sessions | Create upload session for existing file |
| 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 |
| GET | /files/upload_sessions/{upload_session_id}/parts | List parts |
| POST | /files/upload_sessions/{upload_session_id}/commit | Commit upload session |
| POST | /files/{file_id}/copy | Copy file |
| GET | /files/{file_id}/thumbnail.{extension} | Get file thumbnail |
| GET | /files/{file_id}/collaborations | List file collaborations |
| GET | /files/{file_id}/comments | List file comments |
| GET | /files/{file_id}/tasks | List tasks on file |
| GET | /files/{file_id}/trash | Get trashed file |
| DELETE | /files/{file_id}/trash | Permanently remove file |
| GET | /files/{file_id}/versions | List all file versions |
| GET | /files/{file_id}/versions/{file_version_id} | Get file version |
| DELETE | /files/{file_id}/versions/{file_version_id} | Remove file version |
| PUT | /files/{file_id}/versions/{file_version_id} | Restore file version |
| POST | /files/{file_id}/versions/current | Promote file version |
| 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/{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}/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}/watermark | Get watermark on file |
| PUT | /files/{file_id}/watermark | Apply watermark to file |
| DELETE | /files/{file_id}/watermark | Remove watermark from file |
| GET | /files/{file_id}#get_shared_link | Get shared link for file |
| PUT | /files/{file_id}#add_shared_link | Add shared link to file |
| PUT | /files/{file_id}#update_shared_link | Update shared link on file |
| PUT | /files/{file_id}#remove_shared_link | Remove shared link from file |

### file_requests
| Method | Path | Description |
|--------|------|-------------|
| 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 |

### folders
| Method | Path | Description |
|--------|------|-------------|
| 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 |
| GET | /folders/{folder_id}/app_item_associations | List folder app item associations |
| GET | /folders/{folder_id}/items | List items in folder |
| POST | /folders | Create folder |
| POST | /folders/{folder_id}/copy | Copy folder |
| GET | /folders/{folder_id}/collaborations | List folder collaborations |
| GET | /folders/{folder_id}/trash | Get trashed folder |
| DELETE | /folders/{folder_id}/trash | Permanently remove 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 |
| POST | /folders/{folder_id}/metadata/{scope}/{template_key} | Create metadata instance on folder |
| PUT | /folders/{folder_id}/metadata/{scope}/{template_key} | Update metadata instance on folder |
| DELETE | /folders/{folder_id}/metadata/{scope}/{template_key} | Remove metadata instance from folder |
| GET | /folders/trash/items | List trashed items |
| GET | /folders/{folder_id}/watermark | Get watermark for folder |
| PUT | /folders/{folder_id}/watermark | Apply watermark to folder |
| DELETE | /folders/{folder_id}/watermark | Remove watermark from folder |
| GET | /folders/{folder_id}#get_shared_link | Get shared link for folder |
| PUT | /folders/{folder_id}#add_shared_link | Add shared link to folder |
| PUT | /folders/{folder_id}#update_shared_link | Update shared link on folder |
| PUT | /folders/{folder_id}#remove_shared_link | Remove shared link from folder |

### folder_locks
| Method | Path | Description |
|--------|------|-------------|
| GET | /folder_locks | List folder locks |
| POST | /folder_locks | Create folder lock |
| DELETE | /folder_locks/{folder_lock_id} | Delete folder lock |

### metadata_templates
| Method | Path | Description |
|--------|------|-------------|
| GET | /metadata_templates | Find metadata template by instance ID |
| GET | /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema | List all classifications |
| PUT | /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add | Add classification |
| PUT | /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update | Update classification |
| GET | /metadata_templates/{scope}/{template_key}/schema | Get metadata template by name |
| PUT | /metadata_templates/{scope}/{template_key}/schema | Update metadata template |
| DELETE | /metadata_templates/{scope}/{template_key}/schema | Remove metadata template |
| GET | /metadata_templates/{template_id} | Get metadata template by ID |
| GET | /metadata_templates/global | List all global metadata templates |
| GET | /metadata_templates/enterprise | List all metadata templates for enterprise |
| POST | /metadata_templates/schema | Create metadata template |
| POST | /metadata_templates/schema#classifications | Add initial classifications |
| GET | /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options | List metadata template's options for taxonomy field |

### metadata_cascade_policies
| Method | Path | Description |
|--------|------|-------------|
| GET | /metadata_cascade_policies | List metadata cascade policies |
| POST | /metadata_cascade_policies | Create metadata cascade policy |
| GET | /metadata_cascade_policies/{metadata_cascade_policy_id} | Get metadata cascade policy |
| DELETE | /metadata_cascade_policies/{metadata_cascade_policy_id} | Remove metadata cascade policy |
| POST | /metadata_cascade_policies/{metadata_cascade_policy_id}/apply | Force-apply metadata cascade policy to folder |

### metadata_queries
| Method | Path | Description |
|--------|------|-------------|
| POST | /metadata_queries/execute_read | Query files/folders by metadata |

### comments
| Method | Path | Description |
|--------|------|-------------|
| GET | /comments/{comment_id} | Get comment |
| PUT | /comments/{comment_id} | Update comment |
| DELETE | /comments/{comment_id} | Remove comment |
| POST | /comments | Create comment |

### collaborations
| Method | Path | Description |
|--------|------|-------------|
| GET | /collaborations/{collaboration_id} | Get collaboration |
| PUT | /collaborations/{collaboration_id} | Update collaboration |
| DELETE | /collaborations/{collaboration_id} | Remove collaboration |
| GET | /collaborations | List pending collaborations |
| POST | /collaborations | Create collaboration |

### search
| Method | Path | Description |
|--------|------|-------------|
| GET | /search | Search for content |

### tasks
| Method | Path | Description |
|--------|------|-------------|
| POST | /tasks | Create task |
| GET | /tasks/{task_id} | Get task |
| PUT | /tasks/{task_id} | Update task |
| DELETE | /tasks/{task_id} | Remove task |
| GET | /tasks/{task_id}/assignments | List task assignments |

### task_assignments
| Method | Path | Description |
|--------|------|-------------|
| POST | /task_assignments | Assign task |
| GET | /task_assignments/{task_assignment_id} | Get task assignment |
| PUT | /task_assignments/{task_assignment_id} | Update task assignment |
| DELETE | /task_assignments/{task_assignment_id} | Unassign task |

### shared_items
| Method | Path | Description |
|--------|------|-------------|
| GET | /shared_items | Find file for shared link |

### shared_items#folders
| Method | Path | Description |
|--------|------|-------------|
| GET | /shared_items#folders | Find folder for shared link |

### web_links
| Method | Path | Description |
|--------|------|-------------|
| POST | /web_links | Create web link |
| GET | /web_links/{web_link_id} | Get web link |
| POST | /web_links/{web_link_id} | Restore web link |
| PUT | /web_links/{web_link_id} | Update web link |
| DELETE | /web_links/{web_link_id} | Remove web link |
| GET | /web_links/{web_link_id}/trash | Get trashed web link |
| DELETE | /web_links/{web_link_id}/trash | Permanently remove web link |
| GET | /web_links/{web_link_id}#get_shared_link | Get shared link for web link |
| PUT | /web_links/{web_link_id}#add_shared_link | Add shared link to web link |
| PUT | /web_links/{web_link_id}#update_shared_link | Update shared link on web link |
| PUT | /web_links/{web_link_id}#remove_shared_link | Remove shared link from web link |

### shared_items#web_links
| Method | Path | Description |
|--------|------|-------------|
| GET | /shared_items#web_links | Find web link for shared link |

### shared_items#app_items
| Method | Path | Description |
|-----

… (truncated)