Sample - Box Platform API

GETList AI agents/ai_agents POSTCreate AI agent/ai_agents GETGet an AI agent/ai_agents/{agent_id}PUTUpdate an AI agent/ai_agents/{agent_id}DELETEDelete AI agent/ai_agents/{agent_id}

POSTAsk a question with Box AI/ai/ask POSTExtract freeform metadata with Box AI/ai/extract POSTExtract structured metadata with Box AI/ai/extract_structured POSTGenerate text with Box AI/ai/text_gen

GETAuthorize user/authorize

GETList allowed collaboration domains/collaboration_whitelist_entries POSTAdd domain to list of allowed collaboration domains/collaboration_whitelist_entries GETGet allowed collaboration domain/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}DELETERemove domain from list of allowed collaboration domains/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}

GETList users exempt from collaboration domain restrictions/collaboration_whitelist_exempt_targets POSTCreate user exemption from collaboration domain restrictions/collaboration_whitelist_exempt_targets GETGet user exempt from collaboration domain restrictions/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}DELETERemove user from list of users exempt from domain restrictions/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}

GETList pending collaborations/collaborations POSTCreate collaboration/collaborations GETGet a collaboration/collaborations/{collaboration_id}PUTUpdate collaboration/collaborations/{collaboration_id}DELETERemove a collaboration/collaborations/{collaboration_id}

GETList all collections/collections GETGet a collection by ID/collections/{collection_id}

GETList collection items/collections/{collection_id}/items

POSTCreate comment/comments GETGet comment/comments/{comment_id}PUTUpdate a comment/comments/{comment_id}DELETERemove a comment/comments/{comment_id}

GETGet device pin/device_pinners/{device_pinner_id}DELETERemove a device pin/device_pinners/{device_pinner_id}

GETList enterprise device pins/enterprises/{enterprise_id}/device_pinners

OPTIONSGet events long poll endpoint/events GETList user and enterprise events/events

GETGet a file request/file_requests/{file_request_id}PUTUpdate file request/file_requests/{file_request_id}DELETEDelete a file request/file_requests/{file_request_id}

POSTCopy file request/file_requests/{file_request_id}/copy

GETList file version legal holds/file_version_legal_holds GETGet file version legal hold/file_version_legal_holds/{file_version_legal_hold_id}

GETList file version retentions/file_version_retentions GETGet retention on file/file_version_retentions/{file_version_retention_id}

GETGet file information/files/{file_id}POSTRestore a file from the trash/files/{file_id}PUTUpdate file information/files/{file_id}DELETEDelete file/files/{file_id}PUTAdd a shared link to a file/files/{file_id}#add_shared_link GETGet a file's shared link/files/{file_id}#get_shared_link PUTRemove a file shared link/files/{file_id}#remove_shared_link PUTUpdate a file shared link/files/{file_id}#update_shared_link

GETList file app item associations/files/{file_id}/app_item_associations GETList file collaborations/files/{file_id}/collaborations GETList file comments/files/{file_id}/comments POSTCopy a file/files/{file_id}/copy GETList tasks on file/files/{file_id}/tasks GETGet file thumbnail/files/{file_id}/thumbnail.{extension}

GETDownload file content/files/{file_id}/content POSTUpload file version/files/{file_id}/content

OPTIONSCheck a file before upload/files/content POSTUpload file/files/content

GETList metadata instances on a file/files/{file_id}/metadata

GETGet metadata instance on file/files/{file_id}/metadata/{scope}/{template_key}POSTCreate a metadata instance on a file/files/{file_id}/metadata/{scope}/{template_key}PUTUpdate metadata on a file/files/{file_id}/metadata/{scope}/{template_key}DELETERemove metadata from a file/files/{file_id}/metadata/{scope}/{template_key}

GETGet classification on file/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo POSTAdd classification to file/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo PUTUpdate classification on a file/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo DELETERemove classification from file/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo

GETList Box Skill cards on file/files/{file_id}/metadata/global/boxSkillsCards POSTCreate Box Skill cards on file/files/{file_id}/metadata/global/boxSkillsCards PUTUpdate Box Skill cards on a file/files/{file_id}/metadata/global/boxSkillsCards DELETERemove Box Skill cards from file/files/{file_id}/metadata/global/boxSkillsCards

GETGet trashed file/files/{file_id}/trash DELETEPermanently remove file/files/{file_id}/trash

POSTCreate an upload session for an existing file/files/{file_id}/upload_sessions

POSTCreate an upload session/files/upload_sessions

GETGet upload session/files/upload_sessions/{upload_session_id}PUTUpload a file part/files/upload_sessions/{upload_session_id}DELETERemove upload session/files/upload_sessions/{upload_session_id}

POSTCommit upload session/files/upload_sessions/{upload_session_id}/commit GETList parts/files/upload_sessions/{upload_session_id}/parts POSTPlan upload session/files/upload_sessions/{upload_session_id}/plan

GETList all file versions/files/{file_id}/versions

GETGet file version/files/{file_id}/versions/{file_version_id}PUTRestore file version/files/{file_id}/versions/{file_version_id}DELETERemove file version/files/{file_id}/versions/{file_version_id}POSTPromote file version/files/{file_id}/versions/current

GETGet a file watermark/files/{file_id}/watermark PUTApply a watermark to a file/files/{file_id}/watermark DELETERemove a file watermark/files/{file_id}/watermark

GETList folder locks/folder_locks POSTCreate folder lock/folder_locks DELETEDelete folder lock/folder_locks/{folder_lock_id}

POSTCreate a folder/folders GETGet folder information/folders/{folder_id}POSTRestore a folder from the trash/folders/{folder_id}PUTUpdate a folder/folders/{folder_id}DELETEDelete folder/folders/{folder_id}PUTAdd a shared link to a folder/folders/{folder_id}#add_shared_link GETGet shared link for folder/folders/{folder_id}#get_shared_link PUTRemove a folder shared link/folders/{folder_id}#remove_shared_link PUTUpdate a folder shared link/folders/{folder_id}#update_shared_link

GETList folder app item associations/folders/{folder_id}/app_item_associations GETList folder collaborations/folders/{folder_id}/collaborations POSTCopy folder/folders/{folder_id}/copy GETList items in folder/folders/{folder_id}/items

GETList metadata instances on folder/folders/{folder_id}/metadata

GETGet metadata instance on folder/folders/{folder_id}/metadata/{scope}/{template_key}POSTCreate a metadata instance on a folder/folders/{folder_id}/metadata/{scope}/{template_key}PUTUpdate metadata on a folder/folders/{folder_id}/metadata/{scope}/{template_key}DELETERemove metadata from a folder/folders/{folder_id}/metadata/{scope}/{template_key}

GETGet classification on folder/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo POSTAdd classification to folder/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo PUTUpdate a folder classification/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo DELETERemove classification from folder/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo

GETGet trashed folder/folders/{folder_id}/trash DELETEPermanently remove folder/folders/{folder_id}/trash

GETList trashed items/folders/trash/items

GETGet a folder watermark/folders/{folder_id}/watermark PUTApply a watermark to a folder/folders/{folder_id}/watermark DELETERemove a watermark from a folder/folders/{folder_id}/watermark

POSTAdd user to group/group_memberships GETGet group membership/group_memberships/{group_membership_id}PUTUpdate group membership/group_memberships/{group_membership_id}DELETERemove user from group/group_memberships/{group_membership_id}

GETList groups for enterprise/groups POSTCreate group/groups GETGet group/groups/{group_id}PUTUpdate group/groups/{group_id}DELETERemove group/groups/{group_id}POSTCreate jobs to terminate user group session/groups/terminate_sessions

GETList group collaborations/groups/{group_id}/collaborations GETList members of group/groups/{group_id}/memberships

GETList Slack integration mappings/integration_mappings/slack POSTCreate a Slack integration mapping/integration_mappings/slack

PUTUpdate a Slack integration mapping/integration_mappings/slack/{integration_mapping_id}DELETEDelete Slack integration mapping/integration_mappings/slack/{integration_mapping_id}

GETList Teams integration mappings/integration_mappings/teams POSTCreate a Teams integration mapping/integration_mappings/teams

PUTUpdate a Teams integration mapping/integration_mappings/teams/{integration_mapping_id}DELETEDelete Teams integration mapping/integration_mappings/teams/{integration_mapping_id}

POSTCreate user invite/invites GETGet user invite status/invites/{invite_id}

GETList all legal hold policies/legal_hold_policies POSTCreate a legal hold policy/legal_hold_policies GETGet a legal hold policy/legal_hold_policies/{legal_hold_policy_id}PUTUpdate a legal hold policy/legal_hold_policies/{legal_hold_policy_id}DELETERemove legal hold policy/legal_hold_policies/{legal_hold_policy_id}

GETList legal hold policy assignments/legal_hold_policy_assignments POSTAssign legal hold policy/legal_hold_policy_assignments GETGet a legal hold policy assignment/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}DELETEUnassign legal hold policy/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}

GETList previous file versions for legal hold policy assignment/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold GETList files with current file versions for legal hold policy assignment/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold

GETList metadata cascade policies/metadata_cascade_policies POSTCreate metadata cascade policy/metadata_cascade_policies GETGet metadata cascade policy/metadata_cascade_policies/{metadata_cascade_policy_id}DELETERemove a metadata cascade policy/metadata_cascade_policies/{metadata_cascade_policy_id}

POSTForce-apply metadata cascade policy to folder/metadata_cascade_policies/{metadata_cascade_policy_id}/apply

POSTQuery files/folders by metadata/metadata_queries/execute_read

POSTCreate metadata taxonomy/metadata_taxonomies GETGet metadata taxonomies for namespace/metadata_taxonomies/{namespace}

GETGet metadata taxonomy by taxonomy key/metadata_taxonomies/{namespace}/{taxonomy_key}PATCHUpdate a metadata taxonomy/metadata_taxonomies/{namespace}/{taxonomy_key}DELETERemove metadata taxonomy/metadata_taxonomies/{namespace}/{taxonomy_key}

POSTAdd metadata taxonomy level/metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append POSTDelete a metadata taxonomy level/metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim

POSTCreate metadata taxonomy levels/metadata_taxonomies/{namespace}/{taxonomy_key}/levels

PATCHUpdate a metadata taxonomy level/metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}

GETList metadata taxonomy nodes/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes POSTCreate a metadata taxonomy node/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes

GETGet metadata taxonomy node by ID/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}PATCHUpdate a metadata taxonomy node/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}DELETERemove metadata taxonomy node/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}

GETFind metadata template by instance ID/metadata_templates GETGet a metadata template by ID/metadata_templates/{template_id}GETList all global metadata templates/metadata_templates/global POSTAdd initial classifications/metadata_templates/schema#classifications

GETList metadata template's options for taxonomy field/metadata_templates/{namespace}/{template_key}/fields/{field_key}/options

GETList all metadata templates for enterprise/metadata_templates/enterprise

GETList all classifications/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema PUTAdd classifications/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add PUTUpdate classifications/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update

GETGet metadata template by name/metadata_templates/{scope}/{template_key}/schema PUTUpdate a metadata template/metadata_templates/{scope}/{template_key}/schema DELETERemove metadata template/metadata_templates/{scope}/{template_key}/schema

POSTCreate metadata template/metadata_templates/schema

POSTRevoke access token/oauth2/revoke POSTRequest access token/oauth2/token POSTRefresh access token/oauth2/token#refresh

GETList recently accessed items/recent_items

GETList retention policies/retention_policies POSTCreate a retention policy/retention_policies GETGet a retention policy/retention_policies/{retention_policy_id}PUTUpdate a retention policy/retention_policies/{retention_policy_id}DELETEDelete a retention policy/retention_policies/{retention_policy_id}

GETList retention policy assignments/retention_policies/{retention_policy_id}/assignments

POSTAssign a retention policy/retention_policy_assignments GETGet a retention policy assignment/retention_policy_assignments/{retention_policy_assignment_id}DELETERemove retention policy assignment/retention_policy_assignments/{retention_policy_assignment_id}

GETGet file versions under retention/retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention GETGet files under retention/retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention

GETSearch for content/search

GETFind file for shared link/shared_items

GETFind app item for shared link/shared_items#app_items

GETFind folder for shared link/shared_items#folders

GETFind web link for shared link/shared_items#web_links

GETList shield information barrier reports/shield_information_barrier_reports POSTCreate shield information barrier report/shield_information_barrier_reports GETGet shield information barrier report by ID/shield_information_barrier_reports/{shield_information_barrier_report_id}

GETList shield information barrier segment members/shield_information_barrier_segment_members POSTCreate shield information barrier segment member/shield_information_barrier_segment_members GETGet shield information barrier segment member by ID/shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}DELETEDelete shield information barrier segment member by ID/shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}

GETList shield information barrier segment restrictions/shield_information_barrier_segment_restrictions POSTCreate shield information barrier segment restriction/shield_information_barrier_segment_restrictions GETGet shield information barrier segment restriction by ID/shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}DELETEDelete shield information barrier segment restriction by ID/shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}

GETList shield information barriers/shield_information_barriers POSTCreate shield information barrier/shield_information_barriers GETGet shield information barrier with specified ID/shield_information_barriers/{shield_information_barrier_id}POSTAdd changed status of shield information barrier with specified ID/shield_information_barriers/change_status

GETList Box Sign requests/sign_requests POSTCreate a Box Sign request/sign_requests GETGet a Box Sign request/sign_requests/{sign_request_id}

POSTCancel a Box Sign request/sign_requests/{sign_request_id}/cancel POSTResend Box Sign request/sign_requests/{sign_request_id}/resend

GETList Box Sign templates/sign_templates GETGet a Box Sign template/sign_templates/{template_id}

PUTUpdate all Box Skill cards on file/skill_invocations/{skill_id}

GETList storage policies/storage_policies GETGet a storage policy/storage_policies/{storage_policy_id}

GETList storage policy assignments/storage_policy_assignments POSTAssign storage policy/storage_policy_assignments GETGet a storage policy assignment/storage_policy_assignments/{storage_policy_assignment_id}PUTUpdate a storage policy assignment/storage_policy_assignments/{storage_policy_assignment_id}DELETEUnassign storage policy/storage_policy_assignments/{storage_policy_assignment_id}

POSTAssign task/task_assignments GETGet a task assignment/task_assignments/{task_assignment_id}PUTUpdate task assignment/task_assignments/{task_assignment_id}DELETEUnassign a task/task_assignments/{task_assignment_id}

POSTCreate task/tasks GETGet a task/tasks/{task_id}PUTUpdate task/tasks/{task_id}DELETERemove a task/tasks/{task_id}

GETList task assignments/tasks/{task_id}/assignments

GETList terms of service user statuses/terms_of_service_user_statuses POSTCreate terms of service status for new user/terms_of_service_user_statuses PUTUpdate terms of service status for existing user/terms_of_service_user_statuses/{terms_of_service_user_status_id}

GETList terms of services/terms_of_services POSTCreate terms of service/terms_of_services GETGet terms of service/terms_of_services/{terms_of_service_id}PUTUpdate terms of service/terms_of_services/{terms_of_service_id}

GETList enterprise users/users POSTCreate user/users GETGet user/users/{user_id}PUTUpdate user/users/{user_id}DELETEDelete user/users/{user_id}GETGet current user/users/me POSTCreate jobs to terminate users session/users/terminate_sessions

PUTTransfer owned folders/users/{user_id}/folders/0

GETList user's groups/users/{user_id}/memberships

GETGet a user avatar/users/{user_id}/avatar POSTAdd or update a user avatar/users/{user_id}/avatar DELETEDelete user avatar/users/{user_id}/avatar

GETList user's email aliases/users/{user_id}/email_aliases POSTCreate an email alias/users/{user_id}/email_aliases

DELETERemove an email alias/users/{user_id}/email_aliases/{email_alias_id}

GETGet trashed web link/web_links/{web_link_id}/trash DELETEPermanently remove web link/web_links/{web_link_id}/trash

GETList all webhooks/webhooks POSTCreate a webhook/webhooks GETGet a webhook/webhooks/{webhook_id}PUTUpdate a webhook/webhooks/{webhook_id}DELETERemove a webhook/webhooks/{webhook_id}

GETList workflows/workflows

POSTStarts workflow based on request body/workflows/{workflow_id}/start

POSTCreate zip download/zip_downloads

GETDownload zip archive/zip_downloads/{zip_download_id}/content GETGet zip download status/zip_downloads/{zip_download_id}/status

llms.txt Powered by Octri

Changelog

No changelogs published yet.