--- name: folders-routes description: Handle 28 OpenAPI operation(s) under /folders for the folders route group. --- # folders API Routes Handle 28 OpenAPI operation(s) under /folders for the folders route group. Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool. ## Operations ### get_folders_id - Operation ID: `get_folders_id` - Route: `GET /folders/{folder_id}` - Mode: READ - Summary: Get folder information - Parameters: - `folder_id` in `path` required - `fields` in `query` - `if-none-match` in `header` - `boxapi` in `header` - `sort` in `query` - `direction` in `query` - `offset` in `query` - `limit` in `query` ### post_folders_id - Operation ID: `post_folders_id` - Route: `POST /folders/{folder_id}` - Mode: WRITE - Summary: Restore folder - Parameters: - `folder_id` in `path` required - `fields` in `query` - Body: JSON request body accepted. ### put_folders_id - Operation ID: `put_folders_id` - Route: `PUT /folders/{folder_id}` - Mode: WRITE - Summary: Update folder - Parameters: - `folder_id` in `path` required - `fields` in `query` - `if-match` in `header` - Body: JSON request body accepted. ### delete_folders_id - Operation ID: `delete_folders_id` - Route: `DELETE /folders/{folder_id}` - Mode: WRITE - Summary: Delete folder - Parameters: - `folder_id` in `path` required - `if-match` in `header` - `recursive` in `query` ### get_folders_id_app_item_associations - Operation ID: `get_folders_id_app_item_associations` - Route: `GET /folders/{folder_id}/app_item_associations` - Mode: READ - Summary: List folder app item associations - Parameters: - `folder_id` in `path` required - `limit` in `query` - `marker` in `query` - `application_type` in `query` ### get_folders_id_items - Operation ID: `get_folders_id_items` - Route: `GET /folders/{folder_id}/items` - Mode: READ - Summary: List items in folder - Parameters: - `folder_id` in `path` required - `fields` in `query` - `usemarker` in `query` - `marker` in `query` - `offset` in `query` - `limit` in `query` - `boxapi` in `header` - `sort` in `query` - `direction` in `query` ### post_folders - Operation ID: `post_folders` - Route: `POST /folders` - Mode: WRITE - Summary: Create folder - Parameters: - `fields` in `query` - Body: JSON request body accepted. ### post_folders_id_copy - Operation ID: `post_folders_id_copy` - Route: `POST /folders/{folder_id}/copy` - Mode: WRITE - Summary: Copy folder - Parameters: - `folder_id` in `path` required - `fields` in `query` - Body: JSON request body accepted. ### get_folders_id_collaborations - Operation ID: `get_folders_id_collaborations` - Route: `GET /folders/{folder_id}/collaborations` - Mode: READ - Summary: List folder collaborations - Parameters: - `folder_id` in `path` required - `fields` in `query` - `limit` in `query` - `marker` in `query` ### get_folders_id_trash - Operation ID: `get_folders_id_trash` - Route: `GET /folders/{folder_id}/trash` - Mode: READ - Summary: Get trashed folder - Parameters: - `folder_id` in `path` required - `fields` in `query` ### delete_folders_id_trash - Operation ID: `delete_folders_id_trash` - Route: `DELETE /folders/{folder_id}/trash` - Mode: WRITE - Summary: Permanently remove folder - Parameters: - `folder_id` in `path` required ### get_folders_id_metadata - Operation ID: `get_folders_id_metadata` - Route: `GET /folders/{folder_id}/metadata` - Mode: READ - Summary: List metadata instances on folder - Parameters: - `folder_id` in `path` required - `view` in `query` ### get_folders_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo - Operation ID: `get_folders_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo` - Route: `GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo` - Mode: READ - Summary: Get classification on folder - Parameters: - `folder_id` in `path` required ### post_folders_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo - Operation ID: `post_folders_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo` - Route: `POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo` - Mode: WRITE - Summary: Add classification to folder - Parameters: - `folder_id` in `path` required - Body: JSON request body accepted. ### put_folders_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo - Operation ID: `put_folders_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo` - Route: `PUT /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo` - Mode: WRITE - Summary: Update classification on folder - Parameters: - `folder_id` in `path` required - Body: JSON request body accepted. ### delete_folders_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo - Operation ID: `delete_folders_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo` - Route: `DELETE /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo` - Mode: WRITE - Summary: Remove classification from folder - Parameters: - `folder_id` in `path` required ### get_folders_id_metadata_id_id - Operation ID: `get_folders_id_metadata_id_id` - Route: `GET /folders/{folder_id}/metadata/{scope}/{template_key}` - Mode: READ - Summary: Get metadata instance on folder - Parameters: - `folder_id` in `path` required - `scope` in `path` required - `template_key` in `path` required ### post_folders_id_metadata_id_id - Operation ID: `post_folders_id_metadata_id_id` - Route: `POST /folders/{folder_id}/metadata/{scope}/{template_key}` - Mode: WRITE - Summary: Create metadata instance on folder - Parameters: - `folder_id` in `path` required - `scope` in `path` required - `template_key` in `path` required - Body: JSON request body accepted. ### put_folders_id_metadata_id_id - Operation ID: `put_folders_id_metadata_id_id` - Route: `PUT /folders/{folder_id}/metadata/{scope}/{template_key}` - Mode: WRITE - Summary: Update metadata instance on folder - Parameters: - `folder_id` in `path` required - `scope` in `path` required - `template_key` in `path` required - Body: JSON request body accepted. ### delete_folders_id_metadata_id_id - Operation ID: `delete_folders_id_metadata_id_id` - Route: `DELETE /folders/{folder_id}/metadata/{scope}/{template_key}` - Mode: WRITE - Summary: Remove metadata instance from folder - Parameters: - `folder_id` in `path` required - `scope` in `path` required - `template_key` in `path` required ### get_folders_trash_items - Operation ID: `get_folders_trash_items` - Route: `GET /folders/trash/items` - Mode: READ - Summary: List trashed items - Parameters: - `fields` in `query` - `limit` in `query` - `offset` in `query` - `usemarker` in `query` - `marker` in `query` - `direction` in `query` - `sort` in `query` ### get_folders_id_watermark - Operation ID: `get_folders_id_watermark` - Route: `GET /folders/{folder_id}/watermark` - Mode: READ - Summary: Get watermark for folder - Parameters: - `folder_id` in `path` required ### put_folders_id_watermark - Operation ID: `put_folders_id_watermark` - Route: `PUT /folders/{folder_id}/watermark` - Mode: WRITE - Summary: Apply watermark to folder - Parameters: - `folder_id` in `path` required - Body: JSON request body accepted. ### delete_folders_id_watermark - Operation ID: `delete_folders_id_watermark` - Route: `DELETE /folders/{folder_id}/watermark` - Mode: WRITE - Summary: Remove watermark from folder - Parameters: - `folder_id` in `path` required ### get_folders_id_get_shared_link - Operation ID: `get_folders_id_get_shared_link` - Route: `GET /folders/{folder_id}#get_shared_link` - Mode: READ - Summary: Get shared link for folder - Parameters: - `folder_id` in `path` required - `fields` in `query` required ### put_folders_id_add_shared_link - Operation ID: `put_folders_id_add_shared_link` - Route: `PUT /folders/{folder_id}#add_shared_link` - Mode: WRITE - Summary: Add shared link to folder - Parameters: - `folder_id` in `path` required - `fields` in `query` required - Body: JSON request body accepted. ### put_folders_id_update_shared_link - Operation ID: `put_folders_id_update_shared_link` - Route: `PUT /folders/{folder_id}#update_shared_link` - Mode: WRITE - Summary: Update shared link on folder - Parameters: - `folder_id` in `path` required - `fields` in `query` required - Body: JSON request body accepted. ### put_folders_id_remove_shared_link - Operation ID: `put_folders_id_remove_shared_link` - Route: `PUT /folders/{folder_id}#remove_shared_link` - Mode: WRITE - Summary: Remove shared link from folder - Parameters: - `folder_id` in `path` required - `fields` in `query` required - Body: JSON request body accepted.