Sample - Box Platform API
01
Ai_agent_default
1 endpoint
02
Ai_agents
5 endpoints
03
Ai
4 endpoints
04
Authorize
1 endpoint
05
Collaboration_whitelist_entries
4 endpoints
- GET/collaboration_whitelist_entriesList allowed collaboration domains
- GET/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}Get allowed collaboration domain
- POST/collaboration_whitelist_entriesAdd domain to list of allowed collaboration domains
- DELETE/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}Remove domain from list of allowed collaboration domains
06
Collaboration_whitelist_exempt_targets
4 endpoints
- GET/collaboration_whitelist_exempt_targetsList users exempt from collaboration domain restrictions
- GET/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}Get user exempt from collaboration domain restrictions
- POST/collaboration_whitelist_exempt_targetsCreate user exemption from collaboration domain restrictions
- DELETE/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}Remove user from list of users exempt from domain restrictions
07
Collaborations
5 endpoints
08
Collections
3 endpoints
09
Comments
4 endpoints
10
Device_pinners
2 endpoints
11
Enterprises
1 endpoint
12
Events
2 endpoints
13
File_requests
4 endpoints
14
File_version_legal_holds
2 endpoints
15
File_version_retentions
2 endpoints
16
Files
49 endpoints
- OPTIONS/files/contentCheck a file before upload
- GET/files/{file_id}Get file information
- GET/files/{file_id}/app_item_associationsList file app item associations
- GET/files/{file_id}/collaborationsList file collaborations
- GET/files/{file_id}/commentsList file comments
- GET/files/{file_id}/contentDownload file content
- GET/files/{file_id}/metadataList metadata instances on a file
- GET/files/{file_id}/metadata/{scope}/{template_key}Get metadata instance on file
- GET/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWoGet classification on file
- GET/files/{file_id}/metadata/global/boxSkillsCardsList Box Skill cards on file
- GET/files/{file_id}/tasksList tasks on file
- GET/files/{file_id}/thumbnail.{extension}Get file thumbnail
- GET/files/{file_id}/trashGet trashed file
- GET/files/{file_id}/versionsList all file versions
- GET/files/{file_id}/versions/{file_version_id}Get file version
- GET/files/{file_id}/watermarkGet a file watermark
- GET/files/{file_id}#get_shared_linkGet a file's shared link
- GET/files/upload_sessions/{upload_session_id}Get upload session
- GET/files/upload_sessions/{upload_session_id}/partsList parts
- POST/files/{file_id}Restore a file from the trash
- POST/files/{file_id}/contentUpload file version
- POST/files/{file_id}/copyCopy a file
- POST/files/{file_id}/metadata/{scope}/{template_key}Create a metadata instance on a file
- POST/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWoAdd classification to file
- POST/files/{file_id}/metadata/global/boxSkillsCardsCreate Box Skill cards on file
- POST/files/{file_id}/upload_sessionsCreate an upload session for an existing file
- POST/files/{file_id}/versions/currentPromote file version
- POST/files/contentUpload file
- POST/files/upload_sessionsCreate an upload session
- POST/files/upload_sessions/{upload_session_id}/commitCommit upload session
- POST/files/upload_sessions/{upload_session_id}/planPlan upload session
- PUT/files/{file_id}Update file information
- PUT/files/{file_id}/metadata/{scope}/{template_key}Update metadata on a file
- PUT/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWoUpdate classification on a file
- PUT/files/{file_id}/metadata/global/boxSkillsCardsUpdate Box Skill cards on a file
- PUT/files/{file_id}/versions/{file_version_id}Restore file version
- PUT/files/{file_id}/watermarkApply a watermark to a file
- PUT/files/{file_id}#add_shared_linkAdd a shared link to a file
- PUT/files/{file_id}#remove_shared_linkRemove a file shared link
- PUT/files/{file_id}#update_shared_linkUpdate a file shared link
- PUT/files/upload_sessions/{upload_session_id}Upload a file part
- DELETE/files/{file_id}Delete file
- DELETE/files/{file_id}/metadata/{scope}/{template_key}Remove metadata from a file
- DELETE/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWoRemove classification from file
- DELETE/files/{file_id}/metadata/global/boxSkillsCardsRemove Box Skill cards from file
- DELETE/files/{file_id}/trashPermanently remove file
- DELETE/files/{file_id}/versions/{file_version_id}Remove file version
- DELETE/files/{file_id}/watermarkRemove a file watermark
- DELETE/files/upload_sessions/{upload_session_id}Remove upload session
17
Folder_locks
3 endpoints
18
Folders
28 endpoints
- GET/folders/{folder_id}Get folder information
- GET/folders/{folder_id}/app_item_associationsList folder app item associations
- GET/folders/{folder_id}/collaborationsList folder collaborations
- GET/folders/{folder_id}/itemsList items in folder
- GET/folders/{folder_id}/metadataList metadata instances on folder
- GET/folders/{folder_id}/metadata/{scope}/{template_key}Get metadata instance on folder
- GET/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWoGet classification on folder
- GET/folders/{folder_id}/trashGet trashed folder
- GET/folders/{folder_id}/watermarkGet a folder watermark
- GET/folders/{folder_id}#get_shared_linkGet shared link for folder
- GET/folders/trash/itemsList trashed items
- POST/foldersCreate a folder
- POST/folders/{folder_id}Restore a folder from the trash
- POST/folders/{folder_id}/copyCopy folder
- POST/folders/{folder_id}/metadata/{scope}/{template_key}Create a metadata instance on a folder
- POST/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWoAdd classification to folder
- PUT/folders/{folder_id}Update a folder
- PUT/folders/{folder_id}/metadata/{scope}/{template_key}Update metadata on a folder
- PUT/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWoUpdate a folder classification
- PUT/folders/{folder_id}/watermarkApply a watermark to a folder
- PUT/folders/{folder_id}#add_shared_linkAdd a shared link to a folder
- PUT/folders/{folder_id}#remove_shared_linkRemove a folder shared link
- PUT/folders/{folder_id}#update_shared_linkUpdate a folder shared link
- DELETE/folders/{folder_id}Delete folder
- DELETE/folders/{folder_id}/metadata/{scope}/{template_key}Remove metadata from a folder
- DELETE/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWoRemove classification from folder
- DELETE/folders/{folder_id}/trashPermanently remove folder
- DELETE/folders/{folder_id}/watermarkRemove a watermark from a folder
19
Group_memberships
4 endpoints
20
Groups
8 endpoints
- GET/groupsList groups for enterprise
- GET/groups/{group_id}Get group
- GET/groups/{group_id}/collaborationsList group collaborations
- GET/groups/{group_id}/membershipsList members of group
- POST/groupsCreate group
- POST/groups/terminate_sessionsCreate jobs to terminate user group session
- PUT/groups/{group_id}Update group
- DELETE/groups/{group_id}Remove group
21
Integration_mappings
8 endpoints
- GET/integration_mappings/slackList Slack integration mappings
- GET/integration_mappings/teamsList Teams integration mappings
- POST/integration_mappings/slackCreate a Slack integration mapping
- POST/integration_mappings/teamsCreate a Teams integration mapping
- PUT/integration_mappings/slack/{integration_mapping_id}Update a Slack integration mapping
- PUT/integration_mappings/teams/{integration_mapping_id}Update a Teams integration mapping
- DELETE/integration_mappings/slack/{integration_mapping_id}Delete Slack integration mapping
- DELETE/integration_mappings/teams/{integration_mapping_id}Delete Teams integration mapping
22
Invites
2 endpoints
23
Legal_hold_policies
5 endpoints
- GET/legal_hold_policiesList all legal hold policies
- GET/legal_hold_policies/{legal_hold_policy_id}Get a legal hold policy
- POST/legal_hold_policiesCreate a legal hold policy
- PUT/legal_hold_policies/{legal_hold_policy_id}Update a legal hold policy
- DELETE/legal_hold_policies/{legal_hold_policy_id}Remove legal hold policy
24
Legal_hold_policy_assignments
6 endpoints
- GET/legal_hold_policy_assignmentsList legal hold policy assignments
- GET/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}Get a legal hold policy assignment
- GET/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_holdList previous file versions for legal hold policy assignment
- GET/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_holdList files with current file versions for legal hold policy assignment
- POST/legal_hold_policy_assignmentsAssign legal hold policy
- DELETE/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}Unassign legal hold policy
25
Metadata_cascade_policies
5 endpoints
- GET/metadata_cascade_policiesList metadata cascade policies
- GET/metadata_cascade_policies/{metadata_cascade_policy_id}Get metadata cascade policy
- POST/metadata_cascade_policiesCreate metadata cascade policy
- POST/metadata_cascade_policies/{metadata_cascade_policy_id}/applyForce-apply metadata cascade policy to folder
- DELETE/metadata_cascade_policies/{metadata_cascade_policy_id}Remove a metadata cascade policy
26
Metadata_queries
1 endpoint
27
Metadata_taxonomies
14 endpoints
- GET/metadata_taxonomies/{namespace}Get metadata taxonomies for namespace
- GET/metadata_taxonomies/{namespace}/{taxonomy_key}Get metadata taxonomy by taxonomy key
- GET/metadata_taxonomies/{namespace}/{taxonomy_key}/nodesList metadata taxonomy nodes
- GET/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}Get metadata taxonomy node by ID
- POST/metadata_taxonomiesCreate metadata taxonomy
- POST/metadata_taxonomies/{namespace}/{taxonomy_key}/levelsCreate metadata taxonomy levels
- POST/metadata_taxonomies/{namespace}/{taxonomy_key}/levels:appendAdd metadata taxonomy level
- POST/metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trimDelete a metadata taxonomy level
- POST/metadata_taxonomies/{namespace}/{taxonomy_key}/nodesCreate a metadata taxonomy node
- PATCH/metadata_taxonomies/{namespace}/{taxonomy_key}Update a metadata taxonomy
- PATCH/metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}Update a metadata taxonomy level
- PATCH/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}Update a metadata taxonomy node
- DELETE/metadata_taxonomies/{namespace}/{taxonomy_key}Remove metadata taxonomy
- DELETE/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}Remove metadata taxonomy node
28
Metadata_templates
13 endpoints
- GET/metadata_templatesFind metadata template by instance ID
- GET/metadata_templates/{namespace}/{template_key}/fields/{field_key}/optionsList metadata template's options for taxonomy field
- GET/metadata_templates/{scope}/{template_key}/schemaGet metadata template by name
- GET/metadata_templates/{template_id}Get a metadata template by ID
- GET/metadata_templates/enterpriseList all metadata templates for enterprise
- GET/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schemaList all classifications
- GET/metadata_templates/globalList all global metadata templates
- POST/metadata_templates/schemaCreate metadata template
- POST/metadata_templates/schema#classificationsAdd initial classifications
- PUT/metadata_templates/{scope}/{template_key}/schemaUpdate a metadata template
- PUT/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#addAdd classifications
- PUT/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#updateUpdate classifications
- DELETE/metadata_templates/{scope}/{template_key}/schemaRemove metadata template
29
Oauth2
3 endpoints
30
Recent_items
1 endpoint
31
Retention_policies
6 endpoints
- GET/retention_policiesList retention policies
- GET/retention_policies/{retention_policy_id}Get a retention policy
- GET/retention_policies/{retention_policy_id}/assignmentsList retention policy assignments
- POST/retention_policiesCreate a retention policy
- PUT/retention_policies/{retention_policy_id}Update a retention policy
- DELETE/retention_policies/{retention_policy_id}Delete a retention policy
32
Retention_policy_assignments
5 endpoints
- GET/retention_policy_assignments/{retention_policy_assignment_id}Get a retention policy assignment
- GET/retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retentionGet file versions under retention
- GET/retention_policy_assignments/{retention_policy_assignment_id}/files_under_retentionGet files under retention
- POST/retention_policy_assignmentsAssign a retention policy
- DELETE/retention_policy_assignments/{retention_policy_assignment_id}Remove retention policy assignment
33
Search
1 endpoint
34
Shared_items
1 endpoint
35
Shared_items#app_items
1 endpoint
36
Shared_items#folders
1 endpoint
37
Shared_items#web_links
1 endpoint
38
Shield_information_barrier_reports
3 endpoints
39
Shield_information_barrier_segment_members
4 endpoints
- GET/shield_information_barrier_segment_membersList 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
- POST/shield_information_barrier_segment_membersCreate shield information barrier segment member
- DELETE/shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}Delete shield information barrier segment member by ID
40
Shield_information_barrier_segment_restrictions
4 endpoints
- GET/shield_information_barrier_segment_restrictionsList 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
- POST/shield_information_barrier_segment_restrictionsCreate shield information barrier segment restriction
- DELETE/shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}Delete shield information barrier segment restriction by ID
41
Shield_information_barrier_segments
5 endpoints
- GET/shield_information_barrier_segmentsList shield information barrier segments
- GET/shield_information_barrier_segments/{shield_information_barrier_segment_id}Get shield information barrier segment with specified ID
- POST/shield_information_barrier_segmentsCreate a shield information barrier segment
- PUT/shield_information_barrier_segments/{shield_information_barrier_segment_id}Update shield information barrier segment with specified ID
- DELETE/shield_information_barrier_segments/{shield_information_barrier_segment_id}Delete shield information barrier segment
42
Shield_information_barriers
4 endpoints
- GET/shield_information_barriersList shield information barriers
- GET/shield_information_barriers/{shield_information_barrier_id}Get shield information barrier with specified ID
- POST/shield_information_barriersCreate shield information barrier
- POST/shield_information_barriers/change_statusAdd changed status of shield information barrier with specified ID
43
Sign_requests
5 endpoints
44
Sign_templates
2 endpoints
45
Skill_invocations
1 endpoint
46
Storage_policies
2 endpoints
47
Storage_policy_assignments
5 endpoints
- GET/storage_policy_assignmentsList storage policy assignments
- GET/storage_policy_assignments/{storage_policy_assignment_id}Get a storage policy assignment
- POST/storage_policy_assignmentsAssign storage policy
- PUT/storage_policy_assignments/{storage_policy_assignment_id}Update a storage policy assignment
- DELETE/storage_policy_assignments/{storage_policy_assignment_id}Unassign storage policy
48
Task_assignments
4 endpoints
49
Tasks
5 endpoints
50
Terms_of_service_user_statuses
3 endpoints
51
Terms_of_services
4 endpoints
52
Users
15 endpoints
- GET/usersList enterprise users
- GET/users/{user_id}Get user
- GET/users/{user_id}/avatarGet a user avatar
- GET/users/{user_id}/email_aliasesList user's email aliases
- GET/users/{user_id}/membershipsList user's groups
- GET/users/meGet current user
- POST/usersCreate user
- POST/users/{user_id}/avatarAdd or update a user avatar
- POST/users/{user_id}/email_aliasesCreate an email alias
- POST/users/terminate_sessionsCreate jobs to terminate users session
- PUT/users/{user_id}Update user
- PUT/users/{user_id}/folders/0Transfer owned folders
- DELETE/users/{user_id}Delete user
- DELETE/users/{user_id}/avatarDelete user avatar
- DELETE/users/{user_id}/email_aliases/{email_alias_id}Remove an email alias
53
Web_links
11 endpoints
- GET/web_links/{web_link_id}Get a web link
- GET/web_links/{web_link_id}/trashGet trashed web link
- GET/web_links/{web_link_id}#get_shared_linkGet shared link for web link
- POST/web_linksCreate a web link
- POST/web_links/{web_link_id}Restore a web link
- PUT/web_links/{web_link_id}Update a web link
- PUT/web_links/{web_link_id}#add_shared_linkAdd a shared link to a web link
- PUT/web_links/{web_link_id}#remove_shared_linkRemove a shared link from a web link
- PUT/web_links/{web_link_id}#update_shared_linkUpdate a shared link on a web link
- DELETE/web_links/{web_link_id}Remove a web link
- DELETE/web_links/{web_link_id}/trashPermanently remove web link
54
Webhooks
5 endpoints
55
Workflows
2 endpoints
56
Zip_downloads
3 endpoints