{ "provider": "Box", "providerId": "box", "kind": "json-structure", "description": "Structural overview of the Box API surface; extracted from openapi/.", "schemaCount": 197, "operationCount": 261, "schemas": [ { "name": "PostOAuth2Token", "type": "object", "propertyCount": 15, "required": [ "grant_type" ] }, { "name": "PostOAuth2Token--RefreshAccessToken", "type": "object", "propertyCount": 4, "required": [ "grant_type", "client_id", "client_secret", "refresh_token" ] }, { "name": "PostOAuth2Revoke", "type": "object", "propertyCount": 3, "required": [ "grant_type" ] }, { "name": "ZipDownloadRequest", "type": "object", "propertyCount": 2, "required": [ "items" ] }, { "name": "MetadataQuery", "type": "object", "propertyCount": 8, "required": [ "from", "ancestor_folder_id" ] }, { "name": "FileRequestUpdateRequest", "type": "object", "propertyCount": 6, "required": [] }, { "name": "FileRequestCopyRequest", "type": "object", "propertyCount": 0, "required": [ "folder" ] }, { "name": "SignRequestCreateRequest", "type": "object", "propertyCount": 0, "required": [ "signers" ] }, { "name": "IntegrationMappingSlackCreateRequest", "type": "object", "propertyCount": 3, "required": [ "partner_item", "box_item" ] }, { "name": "ClientError", "type": "object", "propertyCount": 7, "required": [] }, { "name": "ConflictError", "type": "object", "propertyCount": 0, "required": [] }, { "name": "OAuth2Error", "type": "object", "propertyCount": 2, "required": [] }, { "name": "SkillInvocation", "type": "object", "propertyCount": 10, "required": [] }, { "name": "WebhookInvocation", "type": "object", "propertyCount": 7, "required": [] }, { "name": "AccessToken", "type": "object", "propertyCount": 6, "required": [] }, { "name": "Classification", "type": "object", "propertyCount": 8, "required": [] }, { "name": "ClassificationTemplate", "type": "object", "propertyCount": 8, "required": [ "id", "type", "scope", "displayName", "fields", "templateKey" ] }, { "name": "Collaboration", "type": "object", "propertyCount": 14, "required": [ "id", "type" ] }, { "name": "Collaborations", "type": "object", "propertyCount": 0, "required": [] }, { "name": "CollaborationAllowlistEntry", "type": "object", "propertyCount": 6, "required": [] }, { "name": "CollaborationAllowlistEntries", "type": "object", "propertyCount": 0, "required": [] }, { "name": "CollaborationAllowlistExemptTarget", "type": "object", "propertyCount": 6, "required": [] }, { "name": "CollaborationAllowlistExemptTargets", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Collection", "type": "object", "propertyCount": 4, "required": [] }, { "name": "Collections", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Comment", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Comments", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Comment--Base", "type": "object", "propertyCount": 2, "required": [] }, { "name": "Comment--Full", "type": "object", "propertyCount": 0, "required": [] }, { "name": "DevicePinner", "type": "object", "propertyCount": 4, "required": [] }, { "name": "DevicePinners", "type": "object", "propertyCount": 4, "required": [] }, { "name": "EmailAlias", "type": "object", "propertyCount": 4, "required": [] }, { "name": "EmailAliases", "type": "object", "propertyCount": 2, "required": [] }, { "name": "Enterprise--Base", "type": "object", "propertyCount": 2, "required": [] }, { "name": "Event", "type": "object", "propertyCount": 9, "required": [] }, { "name": "Events", "type": "object", "propertyCount": 3, "required": [] }, { "name": "File", "type": "object", "propertyCount": 0, "required": [] }, { "name": "FileConflict", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Files", "type": "object", "propertyCount": 2, "required": [] }, { "name": "File--Full", "type": "object", "propertyCount": 0, "required": [] }, { "name": "File--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "File--Base", "type": "object", "propertyCount": 3, "required": [ "id", "type" ] }, { "name": "FileRequest", "type": "object", "propertyCount": 15, "required": [ "id", "type", "folder", "created_at", "updated_at" ] }, { "name": "FilesUnderRetention", "type": "object", "propertyCount": 0, "required": [] }, { "name": "FileVersion", "type": "object", "propertyCount": 0, "required": [] }, { "name": "FileVersion--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "FileVersion--Base", "type": "object", "propertyCount": 2, "required": [ "id", "type" ] }, { "name": "FileVersion--Full", "type": "object", "propertyCount": 0, "required": [] }, { "name": "FileVersions", "type": "object", "propertyCount": 0, "required": [] }, { "name": "FileVersionLegalHold", "type": "object", "propertyCount": 6, "required": [] }, { "name": "FileVersionLegalHolds", "type": "object", "propertyCount": 0, "required": [] }, { "name": "FileVersionRetention", "type": "object", "propertyCount": 7, "required": [] }, { "name": "FileVersionRetentions", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Folder", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Folder--Full", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Folder--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Folder--Base", "type": "object", "propertyCount": 3, "required": [ "id", "type" ] }, { "name": "FolderLock", "type": "object", "propertyCount": 7, "required": [] }, { "name": "FolderLocks", "type": "object", "propertyCount": 3, "required": [] }, { "name": "GenericSource", "type": "object", "propertyCount": 0, "required": [] }, { "name": "IntegrationMapping", "type": "object", "propertyCount": 0, "required": [ "type", "partner_item", "box_item" ] }, { "name": "IntegrationMapping--Base", "type": "object", "propertyCount": 2, "required": [] }, { "name": "IntegrationMapping--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "IntegrationMappings", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Group", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Groups", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Group--Base", "type": "object", "propertyCount": 2, "required": [ "id", "type" ] }, { "name": "Group--Full", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Group--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "GroupMembership", "type": "object", "propertyCount": 7, "required": [] }, { "name": "GroupMemberships", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Invite", "type": "object", "propertyCount": 8, "required": [ "id", "type" ] }, { "name": "Items", "type": "object", "propertyCount": 0, "required": [] }, { "name": "LegalHoldPolicy", "type": "object", "propertyCount": 0, "required": [] }, { "name": "LegalHoldPolicies", "type": "object", "propertyCount": 0, "required": [] }, { "name": "LegalHoldPolicy--Mini", "type": "object", "propertyCount": 2, "required": [ "id", "type" ] }, { "name": "LegalHoldPolicyAssignment", "type": "object", "propertyCount": 0, "required": [] }, { "name": "LegalHoldPolicyAssignment--Base", "type": "object", "propertyCount": 2, "required": [] }, { "name": "LegalHoldPolicyAssignments", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Metadata", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Metadata--Full", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Metadata--Base", "type": "object", "propertyCount": 4, "required": [] }, { "name": "Metadatas", "type": "object", "propertyCount": 2, "required": [] }, { "name": "MetadataCascadePolicy", "type": "object", "propertyCount": 6, "required": [ "id", "type" ] }, { "name": "MetadataCascadePolicies", "type": "object", "propertyCount": 0, "required": [] }, { "name": "MetadataQueryIndex", "type": "object", "propertyCount": 4, "required": [ "type", "status" ] }, { "name": "MetadataQueryResults", "type": "object", "propertyCount": 3, "required": [] }, { "name": "MetadataTemplate", "type": "object", "propertyCount": 8, "required": [ "type", "id" ] }, { "name": "MetadataTemplates", "type": "object", "propertyCount": 0, "required": [] }, { "name": "RealtimeServer", "type": "object", "propertyCount": 5, "required": [] }, { "name": "RealtimeServers", "type": "object", "propertyCount": 2, "required": [] }, { "name": "RecentItem", "type": "object", "propertyCount": 5, "required": [] }, { "name": "RecentItems", "type": "object", "propertyCount": 0, "required": [] }, { "name": "RetentionPolicies", "type": "object", "propertyCount": 0, "required": [] }, { "name": "RetentionPolicy", "type": "object", "propertyCount": 0, "required": [] }, { "name": "RetentionPolicy--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "RetentionPolicy--Base", "type": "object", "propertyCount": 2, "required": [ "id", "type" ] }, { "name": "RetentionPolicyAssignment--Base", "type": "object", "propertyCount": 2, "required": [ "id", "type" ] }, { "name": "RetentionPolicyAssignment", "type": "object", "propertyCount": 8, "required": [ "id", "type" ] }, { "name": "RetentionPolicyAssignments", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ShieldInformationBarrier", "type": "object", "propertyCount": 10, "required": [] }, { "name": "ShieldInformationBarrier--Base", "type": "object", "propertyCount": 2, "required": [] }, { "name": "ShieldInformationBarriers", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ShieldInformationBarrierReport", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ShieldInformationBarrierReport--Base", "type": "object", "propertyCount": 2, "required": [] }, { "name": "ShieldInformationBarrierReports", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ShieldInformationBarrierSegment", "type": "object", "propertyCount": 9, "required": [] }, { "name": "ShieldInformationBarrierSegments", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ShieldInformationBarrierSegmentMember", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ShieldInformationBarrierSegmentMember--Base", "type": "object", "propertyCount": 2, "required": [] }, { "name": "ShieldInformationBarrierSegmentMember--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ShieldInformationBarrierSegmentMembers", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ShieldInformationBarrierSegmentRestriction", "type": "object", "propertyCount": 0, "required": [ "shield_information_barrier_segment", "restricted_segment" ] }, { "name": "ShieldInformationBarrierSegmentRestriction--Base", "type": "object", "propertyCount": 2, "required": [ "shield_information_barrier_segment", "restricted_segment" ] }, { "name": "ShieldInformationBarrierSegmentRestriction--Mini", "type": "object", "propertyCount": 0, "required": [ "shield_information_barrier_segment", "restricted_segment" ] }, { "name": "ShieldInformationBarrierSegmentRestrictions", "type": "object", "propertyCount": 0, "required": [] }, { "name": "SearchResults", "type": "object", "propertyCount": 0, "required": [ "type" ] }, { "name": "SearchResultsWithSharedLinks", "type": "object", "propertyCount": 0, "required": [ "type" ] }, { "name": "SearchResultWithSharedLink", "type": "object", "propertyCount": 3, "required": [] }, { "name": "SessionTerminationMessage", "type": "object", "propertyCount": 1, "required": [] }, { "name": "SkillCardsMetadata", "type": "object", "propertyCount": 9, "required": [] }, { "name": "StoragePolicy", "type": "object", "propertyCount": 0, "required": [] }, { "name": "StoragePolicies", "type": "object", "propertyCount": 0, "required": [] }, { "name": "StoragePolicy--Mini", "type": "object", "propertyCount": 2, "required": [ "id", "type" ] }, { "name": "StoragePolicyAssignment", "type": "object", "propertyCount": 4, "required": [ "id", "type" ] }, { "name": "StoragePolicyAssignments", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Task", "type": "object", "propertyCount": 11, "required": [] }, { "name": "Tasks", "type": "object", "propertyCount": 2, "required": [] }, { "name": "TaskAssignment", "type": "object", "propertyCount": 10, "required": [] }, { "name": "TaskAssignments", "type": "object", "propertyCount": 2, "required": [] }, { "name": "TermsOfService", "type": "object", "propertyCount": 0, "required": [] }, { "name": "TermsOfServices", "type": "object", "propertyCount": 2, "required": [] }, { "name": "TermsOfService--Base", "type": "object", "propertyCount": 2, "required": [ "id", "type" ] }, { "name": "TermsOfServiceUserStatus", "type": "object", "propertyCount": 7, "required": [ "id", "type" ] }, { "name": "TermsOfServiceUserStatuses", "type": "object", "propertyCount": 2, "required": [] }, { "name": "SignTemplate", "type": "object", "propertyCount": 0, "required": [] }, { "name": "SignTemplates", "type": "object", "propertyCount": 0, "required": [] }, { "name": "TemplateSigner", "type": "object", "propertyCount": 0, "required": [] }, { "name": "TemplateSignerInput", "type": "object", "propertyCount": 0, "required": [ "page_index" ] }, { "name": "TrashFile", "type": "object", "propertyCount": 22, "required": [ "id", "type", "sequence_id", "sha1", "description", "size", "path_collection", "created_at", "modified_at", "modified_by", "owned_by", "item_status" ] }, { "name": "TrashFolder", "type": "object", "propertyCount": 21, "required": [ "id", "type", "name", "description", "size", "path_collection", "created_by", "modified_by", "owned_by", "item_status" ] }, { "name": "TrashWebLink", "type": "object", "propertyCount": 18, "required": [] }, { "name": "TrashFileRestored", "type": "object", "propertyCount": 22, "required": [ "id", "type", "sequence_id", "sha1", "description", "size", "path_collection", "created_at", "modified_at", "modified_by", "owned_by", "item_status" ] }, { "name": "TrashFolderRestored", "type": "object", "propertyCount": 21, "required": [] }, { "name": "TrashWebLinkRestored", "type": "object", "propertyCount": 18, "required": [ "sequence_id", "path_collection" ] }, { "name": "UploadPart", "type": "object", "propertyCount": 0, "required": [] }, { "name": "UploadPart--Mini", "type": "object", "propertyCount": 3, "required": [] }, { "name": "UploadedPart", "type": "object", "propertyCount": 1, "required": [] }, { "name": "UploadParts", "type": "object", "propertyCount": 0, "required": [] }, { "name": "UploadSession", "type": "object", "propertyCount": 7, "required": [] }, { "name": "UploadUrl", "type": "object", "propertyCount": 2, "required": [] }, { "name": "User", "type": "object", "propertyCount": 0, "required": [] }, { "name": "UserAvatar", "type": "object", "propertyCount": 1, "required": [] }, { "name": "Users", "type": "object", "propertyCount": 0, "required": [] }, { "name": "User--Full", "type": "object", "propertyCount": 0, "required": [] }, { "name": "User--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "User--Base", "type": "object", "propertyCount": 2, "required": [ "type", "id" ] }, { "name": "User--Collaborations", "type": "object", "propertyCount": 0, "required": [] }, { "name": "UserIntegrationMappings", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Watermark", "type": "object", "propertyCount": 1, "required": [] }, { "name": "Webhook", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Webhook--Mini", "type": "object", "propertyCount": 3, "required": [] }, { "name": "Webhooks", "type": "object", "propertyCount": 0, "required": [] }, { "name": "WebLink", "type": "object", "propertyCount": 0, "required": [] }, { "name": "WebLink--Base", "type": "object", "propertyCount": 3, "required": [ "id", "type" ] }, { "name": "WebLink--Mini", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Workflow", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Workflow--Full", "type": "object", "propertyCount": 0, "required": [] }, { "name": "Workflow--Mini", "type": "object", "propertyCount": 5, "required": [] }, { "name": "Workflows", "type": "object", "propertyCount": 0, "required": [] }, { "name": "ZipDownload", "type": "object", "propertyCount": 4, "required": [] }, { "name": "ZipDownloadStatus", "type": "object", "propertyCount": 5, "required": [] }, { "name": "SignRequest--Base", "type": "object", "propertyCount": 13, "required": [] }, { "name": "SignRequest", "type": "object", "propertyCount": 0, "required": [] }, { "name": "SignRequests", "type": "object", "propertyCount": 0, "required": [] }, { "name": "FileOrFolderScope", "type": "object", "propertyCount": 2, "required": [] }, { "name": "EventSource", "type": "object", "propertyCount": 6, "required": [ "item_type", "item_id", "item_name" ] }, { "name": "KeywordSkillCard", "type": "object", "propertyCount": 7, "required": [ "type", "skill_card_type", "skill", "invocation", "entries" ] }, { "name": "IntegrationMappingSlackOptions", "type": "object", "propertyCount": 1, "required": [] }, { "name": "IntegrationMappingPartnerItemSlack", "type": "object", "propertyCount": 4, "required": [ "id", "type" ] }, { "name": "IntegrationMappingBoxItemSlack", "type": "object", "propertyCount": 2, "required": [ "id", "type" ] }, { "name": "TimelineSkillCard", "type": "object", "propertyCount": 8, "required": [ "type", "skill_card_type", "skill", "invocation", "entries" ] }, { "name": "TranscriptSkillCard", "type": "object", "propertyCount": 8, "required": [ "type", "skill_card_type", "skill", "invocation", "entries" ] }, { "name": "StatusSkillCard", "type": "object", "propertyCount": 7, "required": [ "type", "skill_card_type", "skill", "invocation", "status" ] }, { "name": "SignRequestCreateSigner", "type": "object", "propertyCount": 11, "required": [] }, { "name": "SignRequestPrefillTag", "type": "object", "propertyCount": 4, "required": [] }, { "name": "SignRequestSignerInput", "type": "object", "propertyCount": 0, "required": [ "page_index" ] }, { "name": "SignRequestSigner", "type": "object", "propertyCount": 0, "required": [ "email" ] }, { "name": "ShieldInformationBarrierReference", "type": "object", "propertyCount": 1, "required": [] }, { "name": "ShieldInformationBarrierReportDetails", "type": "object", "propertyCount": 1, "required": [] }, { "name": "TrackingCode", "type": "object", "propertyCount": 3, "required": [] }, { "name": "MetadataFilter", "type": "object", "propertyCount": 3, "required": [] }, { "name": "MetadataFieldFilterString", "type": "object", "propertyCount": 0, "required": [] }, { "name": "MetadataFieldFilterFloat", "type": "object", "propertyCount": 0, "required": [] }, { "name": "MetadataFieldFilterMultiSelect", "type": "object", "propertyCount": 0, "required": [] }, { "name": "MetadataFieldFilterFloatRange", "type": "object", "propertyCount": 0, "required": [] }, { "name": "MetadataFieldFilterDateRange", "type": "object", "propertyCount": 0, "required": [] } ], "operations": [ { "method": "GET", "path": "/authorize", "operationId": "get_authorize", "summary": "Box Authorize user", "tags": [ "Authorization" ] }, { "method": "POST", "path": "/oauth2/token", "operationId": "post_oauth2_token", "summary": "Box Request access token", "tags": [ "Authorization" ] }, { "method": "POST", "path": "/oauth2/token#refresh", "operationId": "post_oauth2_token#refresh", "summary": "Box Refresh access token", "tags": [ "Authorization" ] }, { "method": "POST", "path": "/oauth2/revoke", "operationId": "post_oauth2_revoke", "summary": "Box Revoke access token", "tags": [ "Authorization" ] }, { "method": "GET", "path": "/files/{file_id}", "operationId": "get_files_id", "summary": "Box Get file information", "tags": [ "Files" ] }, { "method": "POST", "path": "/files/{file_id}", "operationId": "post_files_id", "summary": "Box Restore file", "tags": [ "Trashed Files" ] }, { "method": "PUT", "path": "/files/{file_id}", "operationId": "put_files_id", "summary": "Box Update file", "tags": [ "Files" ] }, { "method": "DELETE", "path": "/files/{file_id}", "operationId": "delete_files_id", "summary": "Box Delete file", "tags": [ "Files" ] }, { "method": "GET", "path": "/files/{file_id}/content", "operationId": "get_files_id_content", "summary": "Box Download file", "tags": [ "Downloads" ] }, { "method": "POST", "path": "/files/{file_id}/content", "operationId": "post_files_id_content", "summary": "Box Upload file version", "tags": [ "Uploads" ] }, { "method": "POST", "path": "/files/content", "operationId": "post_files_content", "summary": "Box Upload file", "tags": [ "Uploads" ] }, { "method": "POST", "path": "/files/upload_sessions", "operationId": "post_files_upload_sessions", "summary": "Box Create upload session", "tags": [ "Uploads (Chunked)" ] }, { "method": "POST", "path": "/files/{file_id}/upload_sessions", "operationId": "post_files_id_upload_sessions", "summary": "Box Create upload session for existing file", "tags": [ "Uploads (Chunked)" ] }, { "method": "GET", "path": "/files/upload_sessions/{upload_session_id}", "operationId": "get_files_upload_sessions_id", "summary": "Box Get upload session", "tags": [ "Uploads (Chunked)" ] }, { "method": "PUT", "path": "/files/upload_sessions/{upload_session_id}", "operationId": "put_files_upload_sessions_id", "summary": "Box Upload part of file", "tags": [ "Uploads (Chunked)" ] }, { "method": "DELETE", "path": "/files/upload_sessions/{upload_session_id}", "operationId": "delete_files_upload_sessions_id", "summary": "Box Remove upload session", "tags": [ "Uploads (Chunked)" ] }, { "method": "GET", "path": "/files/upload_sessions/{upload_session_id}/parts", "operationId": "get_files_upload_sessions_id_parts", "summary": "Box List parts", "tags": [ "Uploads (Chunked)" ] }, { "method": "POST", "path": "/files/upload_sessions/{upload_session_id}/commit", "operationId": "post_files_upload_sessions_id_commit", "summary": "Box Commit upload session", "tags": [ "Uploads (Chunked)" ] }, { "method": "POST", "path": "/files/{file_id}/copy", "operationId": "post_files_id_copy", "summary": "Box Copy file", "tags": [ "Files" ] }, { "method": "GET", "path": "/files/{file_id}/thumbnail.{extension}", "operationId": "get_files_id_thumbnail_id", "summary": "Box Get file thumbnail", "tags": [ "Files" ] }, { "method": "GET", "path": "/files/{file_id}/collaborations", "operationId": "get_files_id_collaborations", "summary": "Box List file collaborations", "tags": [ "Collaborations (List)" ] }, { "method": "GET", "path": "/files/{file_id}/comments", "operationId": "get_files_id_comments", "summary": "Box List file comments", "tags": [ "Comments" ] }, { "method": "GET", "path": "/files/{file_id}/tasks", "operationId": "get_files_id_tasks", "summary": "Box List tasks on file", "tags": [ "Tasks" ] }, { "method": "GET", "path": "/files/{file_id}/trash", "operationId": "get_files_id_trash", "summary": "Box Get trashed file", "tags": [ "Trashed Files" ] }, { "method": "DELETE", "path": "/files/{file_id}/trash", "operationId": "delete_files_id_trash", "summary": "Box Permanently remove file", "tags": [ "Trashed Files" ] }, { "method": "GET", "path": "/files/{file_id}/versions", "operationId": "get_files_id_versions", "summary": "Box List all file versions", "tags": [ "File Versions" ] }, { "method": "GET", "path": "/files/{file_id}/versions/{file_version_id}", "operationId": "get_files_id_versions_id", "summary": "Box Get file version", "tags": [ "File Versions" ] }, { "method": "PUT", "path": "/files/{file_id}/versions/{file_version_id}", "operationId": "put_files_id_versions_id", "summary": "Box Restore file version", "tags": [ "File Versions" ] }, { "method": "DELETE", "path": "/files/{file_id}/versions/{file_version_id}", "operationId": "delete_files_id_versions_id", "summary": "Box Remove file version", "tags": [ "File Versions" ] }, { "method": "POST", "path": "/files/{file_id}/versions/current", "operationId": "post_files_id_versions_current", "summary": "Box Promote file version", "tags": [ "File Versions" ] }, { "method": "GET", "path": "/files/{file_id}/metadata", "operationId": "get_files_id_metadata", "summary": "Box List metadata instances on file", "tags": [ "Metadata Instances (Files)" ] }, { "method": "GET", "path": "/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo", "operationId": "get_files_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "Box Get classification on file", "tags": [ "Classifications on Files" ] }, { "method": "POST", "path": "/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo", "operationId": "post_files_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "Box Add classification to file", "tags": [ "Classifications on Files" ] }, { "method": "PUT", "path": "/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo", "operationId": "put_files_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "Box Update classification on file", "tags": [ "Classifications on Files" ] }, { "method": "DELETE", "path": "/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo", "operationId": "delete_files_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "Box Remove classification from file", "tags": [ "Classifications on Files" ] }, { "method": "GET", "path": "/files/{file_id}/metadata/{scope}/{template_key}", "operationId": "get_files_id_metadata_id_id", "summary": "Box Get metadata instance on file", "tags": [ "Metadata Instances (Files)" ] }, { "method": "POST", "path": "/files/{file_id}/metadata/{scope}/{template_key}", "operationId": "post_files_id_metadata_id_id", "summary": "Box Create metadata instance on file", "tags": [ "Metadata Instances (Files)" ] }, { "method": "PUT", "path": "/files/{file_id}/metadata/{scope}/{template_key}", "operationId": "put_files_id_metadata_id_id", "summary": "Box Update metadata instance on file", "tags": [ "Metadata Instances (Files)" ] }, { "method": "DELETE", "path": "/files/{file_id}/metadata/{scope}/{template_key}", "operationId": "delete_files_id_metadata_id_id", "summary": "Box Remove metadata instance from file", "tags": [ "Metadata Instances (Files)" ] }, { "method": "GET", "path": "/files/{file_id}/metadata/global/boxSkillsCards", "operationId": "get_files_id_metadata_global_boxSkillsCards", "summary": "List Box Skill cards on file", "tags": [ "Skills" ] }, { "method": "POST", "path": "/files/{file_id}/metadata/global/boxSkillsCards", "operationId": "post_files_id_metadata_global_boxSkillsCards", "summary": "Create Box Skill cards on file", "tags": [ "Skills" ] }, { "method": "PUT", "path": "/files/{file_id}/metadata/global/boxSkillsCards", "operationId": "put_files_id_metadata_global_boxSkillsCards", "summary": "Update Box Skill cards on file", "tags": [ "Skills" ] }, { "method": "DELETE", "path": "/files/{file_id}/metadata/global/boxSkillsCards", "operationId": "delete_files_id_metadata_global_boxSkillsCards", "summary": "Remove Box Skill cards from file", "tags": [ "Skills" ] }, { "method": "GET", "path": "/files/{file_id}/watermark", "operationId": "get_files_id_watermark", "summary": "Box Get watermark on file", "tags": [ "Watermarks (Files)" ] }, { "method": "PUT", "path": "/files/{file_id}/watermark", "operationId": "put_files_id_watermark", "summary": "Box Apply watermark to file", "tags": [ "Watermarks (Files)" ] }, { "method": "DELETE", "path": "/files/{file_id}/watermark", "operationId": "delete_files_id_watermark", "summary": "Box Remove watermark from file", "tags": [ "Watermarks (Files)" ] }, { "method": "GET", "path": "/file_requests/{file_request_id}", "operationId": "get_file_requests_id", "summary": "Box Get file request", "tags": [ "File Requests" ] }, { "method": "PUT", "path": "/file_requests/{file_request_id}", "operationId": "put_file_requests_id", "summary": "Box Update file request", "tags": [ "File Requests" ] }, { "method": "DELETE", "path": "/file_requests/{file_request_id}", "operationId": "delete_file_requests_id", "summary": "Box Delete file request", "tags": [ "File Requests" ] }, { "method": "POST", "path": "/file_requests/{file_request_id}/copy", "operationId": "post_file_requests_id_copy", "summary": "Box Copy file request", "tags": [ "File Requests" ] }, { "method": "GET", "path": "/folders/{folder_id}", "operationId": "get_folders_id", "summary": "Box Get folder information", "tags": [ "Folders" ] }, { "method": "POST", "path": "/folders/{folder_id}", "operationId": "post_folders_id", "summary": "Box Restore folder", "tags": [ "Trashed Folders" ] }, { "method": "PUT", "path": "/folders/{folder_id}", "operationId": "put_folders_id", "summary": "Box Update folder", "tags": [ "Folders" ] }, { "method": "DELETE", "path": "/folders/{folder_id}", "operationId": "delete_folders_id", "summary": "Box Delete folder", "tags": [ "Folders" ] }, { "method": "GET", "path": "/folders/{folder_id}/items", "operationId": "get_folders_id_items", "summary": "Box List items in folder", "tags": [ "Folders" ] }, { "method": "POST", "path": "/folders", "operationId": "post_folders", "summary": "Box Create folder", "tags": [ "Folders" ] }, { "method": "POST", "path": "/folders/{folder_id}/copy", "operationId": "post_folders_id_copy", "summary": "Box Copy folder", "tags": [ "Folders" ] }, { "method": "GET", "path": "/folders/{folder_id}/collaborations", "operationId": "get_folders_id_collaborations", "summary": "Box List folder collaborations", "tags": [ "Collaborations (List)" ] }, { "method": "GET", "path": "/folders/{folder_id}/trash", "operationId": "get_folders_id_trash", "summary": "Box Get trashed folder", "tags": [ "Trashed Folders" ] }, { "method": "DELETE", "path": "/folders/{folder_id}/trash", "operationId": "delete_folders_id_trash", "summary": "Box Permanently remove folder", "tags": [ "Trashed Folders" ] }, { "method": "GET", "path": "/folders/{folder_id}/metadata", "operationId": "get_folders_id_metadata", "summary": "Box List metadata instances on folder", "tags": [ "Metadata Instances (Folders)" ] }, { "method": "GET", "path": "/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo", "operationId": "get_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "Box Get classification on folder", "tags": [ "Classifications on Folders" ] }, { "method": "POST", "path": "/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo", "operationId": "post_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "Box Add classification to folder", "tags": [ "Classifications on Folders" ] }, { "method": "PUT", "path": "/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo", "operationId": "put_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "Box Update classification on folder", "tags": [ "Classifications on Folders" ] }, { "method": "DELETE", "path": "/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo", "operationId": "delete_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "Box Remove classification from folder", "tags": [ "Classifications on Folders" ] }, { "method": "GET", "path": "/folders/{folder_id}/metadata/{scope}/{template_key}", "operationId": "get_folders_id_metadata_id_id", "summary": "Box Get metadata instance on folder", "tags": [ "Metadata Instances (Folders)" ] }, { "method": "POST", "path": "/folders/{folder_id}/metadata/{scope}/{template_key}", "operationId": "post_folders_id_metadata_id_id", "summary": "Box Create metadata instance on folder", "tags": [ "Metadata Instances (Folders)" ] }, { "method": "PUT", "path": "/folders/{folder_id}/metadata/{scope}/{template_key}", "operationId": "put_folders_id_metadata_id_id", "summary": "Box Update metadata instance on folder", "tags": [ "Metadata Instances (Folders)" ] }, { "method": "DELETE", "path": "/folders/{folder_id}/metadata/{scope}/{template_key}", "operationId": "delete_folders_id_metadata_id_id", "summary": "Box Remove metadata instance from folder", "tags": [ "Metadata Instances (Folders)" ] }, { "method": "GET", "path": "/folders/trash/items", "operationId": "get_folders_trash_items", "summary": "Box List trashed items", "tags": [ "Trashed Items" ] }, { "method": "GET", "path": "/folders/{folder_id}/watermark", "operationId": "get_folders_id_watermark", "summary": "Box Get watermark for folder", "tags": [ "Watermarks (Folders)" ] }, { "method": "PUT", "path": "/folders/{folder_id}/watermark", "operationId": "put_folders_id_watermark", "summary": "Box Apply watermark to folder", "tags": [ "Watermarks (Folders)" ] }, { "method": "DELETE", "path": "/folders/{folder_id}/watermark", "operationId": "delete_folders_id_watermark", "summary": "Box Remove watermark from folder", "tags": [ "Watermarks (Folders)" ] }, { "method": "GET", "path": "/folder_locks", "operationId": "get_folder_locks", "summary": "Box List folder locks", "tags": [ "Folder Locks" ] }, { "method": "POST", "path": "/folder_locks", "operationId": "post_folder_locks", "summary": "Box Create folder lock", "tags": [ "Folder Locks" ] }, { "method": "DELETE", "path": "/folder_locks/{folder_lock_id}", "operationId": "delete_folder_locks_id", "summary": "Box Delete folder lock", "tags": [ "Folder Locks" ] }, { "method": "GET", "path": "/metadata_templates", "operationId": "get_metadata_templates", "summary": "Box Find metadata template by instance ID", "tags": [ "Metadata Templates" ] }, { "method": "GET", "path": "/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema", "operationId": "get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema", "summary": "Box List all classifications", "tags": [ "Classifications" ] }, { "method": "PUT", "path": "/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add", "operationId": "put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#add", "summary": "Box Add classification", "tags": [ "Classifications" ] }, { "method": "PUT", "path": "/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update", "operationId": "put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#update", "summary": "Box Update classification", "tags": [ "Classifications" ] }, { "method": "GET", "path": "/metadata_templates/{scope}/{template_key}/schema", "operationId": "get_metadata_templates_id_id_schema", "summary": "Box Get metadata template by name", "tags": [ "Metadata Templates" ] }, { "method": "PUT", "path": "/metadata_templates/{scope}/{template_key}/schema", "operationId": "put_metadata_templates_id_id_schema", "summary": "Box Update metadata template", "tags": [ "Metadata Templates" ] }, { "method": "DELETE", "path": "/metadata_templates/{scope}/{template_key}/schema", "operationId": "delete_metadata_templates_id_id_schema", "summary": "Box Remove metadata template", "tags": [ "Metadata Templates" ] }, { "method": "GET", "path": "/metadata_templates/{template_id}", "operationId": "get_metadata_templates_id", "summary": "Box Get metadata template by ID", "tags": [ "Metadata Templates" ] }, { "method": "GET", "path": "/metadata_templates/global", "operationId": "get_metadata_templates_global", "summary": "Box List all global metadata templates", "tags": [ "Metadata Templates" ] }, { "method": "GET", "path": "/metadata_templates/enterprise", "operationId": "get_metadata_templates_enterprise", "summary": "Box List all metadata templates for enterprise", "tags": [ "Metadata Templates" ] }, { "method": "POST", "path": "/metadata_templates/schema", "operationId": "post_metadata_templates_schema", "summary": "Box Create metadata template", "tags": [ "Metadata Templates" ] }, { "method": "POST", "path": "/metadata_templates/schema#classifications", "operationId": "post_metadata_templates_schema#classifications", "summary": "Box Add initial classifications", "tags": [ "Classifications" ] }, { "method": "GET", "path": "/metadata_cascade_policies", "operationId": "get_metadata_cascade_policies", "summary": "Box List metadata cascade policies", "tags": [ "Metadata Cascade Policies" ] }, { "method": "POST", "path": "/metadata_cascade_policies", "operationId": "post_metadata_cascade_policies", "summary": "Box Create metadata cascade policy", "tags": [ "Metadata Cascade Policies" ] }, { "method": "GET", "path": "/metadata_cascade_policies/{metadata_cascade_policy_id}", "operationId": "get_metadata_cascade_policies_id", "summary": "Box Get metadata cascade policy", "tags": [ "Metadata Cascade Policies" ] }, { "method": "DELETE", "path": "/metadata_cascade_policies/{metadata_cascade_policy_id}", "operationId": "delete_metadata_cascade_policies_id", "summary": "Box Remove metadata cascade policy", "tags": [ "Metadata Cascade Policies" ] }, { "method": "POST", "path": "/metadata_cascade_policies/{metadata_cascade_policy_id}/apply", "operationId": "post_metadata_cascade_policies_id_apply", "summary": "Box Force-apply metadata cascade policy to folder", "tags": [ "Metadata Cascade Policies" ] }, { "method": "POST", "path": "/metadata_queries/execute_read", "operationId": "post_metadata_queries_execute_read", "summary": "Box Query files/folders by metadata", "tags": [ "Search" ] }, { "method": "GET", "path": "/comments/{comment_id}", "operationId": "get_comments_id", "summary": "Box Get comment", "tags": [ "Comments" ] }, { "method": "PUT", "path": "/comments/{comment_id}", "operationId": "put_comments_id", "summary": "Box Update comment", "tags": [ "Comments" ] }, { "method": "DELETE", "path": "/comments/{comment_id}", "operationId": "delete_comments_id", "summary": "Box Remove comment", "tags": [ "Comments" ] }, { "method": "POST", "path": "/comments", "operationId": "post_comments", "summary": "Box Create comment", "tags": [ "Comments" ] }, { "method": "GET", "path": "/collaborations/{collaboration_id}", "operationId": "get_collaborations_id", "summary": "Box Get collaboration", "tags": [ "Collaborations" ] }, { "method": "PUT", "path": "/collaborations/{collaboration_id}", "operationId": "put_collaborations_id", "summary": "Box Update collaboration", "tags": [ "Collaborations" ] }, { "method": "DELETE", "path": "/collaborations/{collaboration_id}", "operationId": "delete_collaborations_id", "summary": "Box Remove collaboration", "tags": [ "Collaborations" ] }, { "method": "GET", "path": "/collaborations", "operationId": "get_collaborations", "summary": "Box List pending collaborations", "tags": [ "Collaborations (List)" ] }, { "method": "POST", "path": "/collaborations", "operationId": "post_collaborations", "summary": "Box Create collaboration", "tags": [ "Collaborations" ] }, { "method": "GET", "path": "/search", "operationId": "get_search", "summary": "Box Search for content", "tags": [ "Search" ] }, { "method": "POST", "path": "/tasks", "operationId": "post_tasks", "summary": "Box Create task", "tags": [ "Tasks" ] }, { "method": "GET", "path": "/tasks/{task_id}", "operationId": "get_tasks_id", "summary": "Box Get task", "tags": [ "Tasks" ] }, { "method": "PUT", "path": "/tasks/{task_id}", "operationId": "put_tasks_id", "summary": "Box Update task", "tags": [ "Tasks" ] }, { "method": "DELETE", "path": "/tasks/{task_id}", "operationId": "delete_tasks_id", "summary": "Box Remove task", "tags": [ "Tasks" ] }, { "method": "GET", "path": "/tasks/{task_id}/assignments", "operationId": "get_tasks_id_assignments", "summary": "Box List task assignments", "tags": [ "Task Assignments" ] }, { "method": "POST", "path": "/task_assignments", "operationId": "post_task_assignments", "summary": "Box Assign task", "tags": [ "Task Assignments" ] }, { "method": "GET", "path": "/task_assignments/{task_assignment_id}", "operationId": "get_task_assignments_id", "summary": "Box Get task assignment", "tags": [ "Task Assignments" ] }, { "method": "PUT", "path": "/task_assignments/{task_assignment_id}", "operationId": "put_task_assignments_id", "summary": "Box Update task assignment", "tags": [ "Task Assignments" ] }, { "method": "DELETE", "path": "/task_assignments/{task_assignment_id}", "operationId": "delete_task_assignments_id", "summary": "Box Unassign task", "tags": [ "Task Assignments" ] }, { "method": "GET", "path": "/shared_items", "operationId": "get_shared_items", "summary": "Box Find file for shared link", "tags": [ "Shared Links (Files)" ] }, { "method": "GET", "path": "/files/{file_id}#get_shared_link", "operationId": "get_files_id#get_shared_link", "summary": "Box Get shared link for file", "tags": [ "Shared Links (Files)" ] }, { "method": "PUT", "path": "/files/{file_id}#add_shared_link", "operationId": "put_files_id#add_shared_link", "summary": "Box Add shared link to file", "tags": [ "Shared Links (Files)" ] }, { "method": "PUT", "path": "/files/{file_id}#update_shared_link", "operationId": "put_files_id#update_shared_link", "summary": "Box Update shared link on file", "tags": [ "Shared Links (Files)" ] }, { "method": "PUT", "path": "/files/{file_id}#remove_shared_link", "operationId": "put_files_id#remove_shared_link", "summary": "Box Remove shared link from file", "tags": [ "Shared Links (Files)" ] }, { "method": "GET", "path": "/shared_items#folders", "operationId": "get_shared_items#folders", "summary": "Box Find folder for shared link", "tags": [ "Shared Links (Folders)" ] }, { "method": "GET", "path": "/folders/{folder_id}#get_shared_link", "operationId": "get_folders_id#get_shared_link", "summary": "Box Get shared link for folder", "tags": [ "Shared Links (Folders)" ] }, { "method": "PUT", "path": "/folders/{folder_id}#add_shared_link", "operationId": "put_folders_id#add_shared_link", "summary": "Box Add shared link to folder", "tags": [ "Shared Links (Folders)" ] }, { "method": "PUT", "path": "/folders/{folder_id}#update_shared_link", "operationId": "put_folders_id#update_shared_link", "summary": "Box Update shared link on folder", "tags": [ "Shared Links (Folders)" ] }, { "method": "PUT", "path": "/folders/{folder_id}#remove_shared_link", "operationId": "put_folders_id#remove_shared_link", "summary": "Box Remove shared link from folder", "tags": [ "Shared Links (Folders)" ] }, { "method": "POST", "path": "/web_links", "operationId": "post_web_links", "summary": "Box Create web link", "tags": [ "Web Links" ] }, { "method": "GET", "path": "/web_links/{web_link_id}", "operationId": "get_web_links_id", "summary": "Box Get web link", "tags": [ "Web Links" ] }, { "method": "POST", "path": "/web_links/{web_link_id}", "operationId": "post_web_links_id", "summary": "Box Restore web link", "tags": [ "Trashed Web Links" ] }, { "method": "PUT", "path": "/web_links/{web_link_id}", "operationId": "put_web_links_id", "summary": "Box Update web link", "tags": [ "Web Links" ] }, { "method": "DELETE", "path": "/web_links/{web_link_id}", "operationId": "delete_web_links_id", "summary": "Box Remove web link", "tags": [ "Web Links" ] }, { "method": "GET", "path": "/web_links/{web_link_id}/trash", "operationId": "get_web_links_id_trash", "summary": "Box Get trashed web link", "tags": [ "Trashed Web Links" ] }, { "method": "DELETE", "path": "/web_links/{web_link_id}/trash", "operationId": "delete_web_links_id_trash", "summary": "Box Permanently remove web link", "tags": [ "Trashed Web Links" ] }, { "method": "GET", "path": "/shared_items#web_links", "operationId": "get_shared_items#web_links", "summary": "Box Find web link for shared link", "tags": [ "Shared Links (Web Links)" ] }, { "method": "GET", "path": "/web_links/{web_link_id}#get_shared_link", "operationId": "get_web_links_id#get_shared_link", "summary": "Box Get shared link for web link", "tags": [ "Shared Links (Web Links)" ] }, { "method": "PUT", "path": "/web_links/{web_link_id}#add_shared_link", "operationId": "put_web_links_id#add_shared_link", "summary": "Box Add shared link to web link", "tags": [ "Shared Links (Web Links)" ] }, { "method": "PUT", "path": "/web_links/{web_link_id}#update_shared_link", "operationId": "put_web_links_id#update_shared_link", "summary": "Box Update shared link on web link", "tags": [ "Shared Links (Web Links)" ] }, { "method": "PUT", "path": "/web_links/{web_link_id}#remove_shared_link", "operationId": "put_web_links_id#remove_shared_link", "summary": "Box Remove shared link from web link", "tags": [ "Shared Links (Web Links)" ] }, { "method": "GET", "path": "/users", "operationId": "get_users", "summary": "Box List enterprise users", "tags": [ "Users" ] }, { "method": "POST", "path": "/users", "operationId": "post_users", "summary": "Box Create user", "tags": [ "Users" ] }, { "method": "GET", "path": "/users/me", "operationId": "get_users_me", "summary": "Box Get current user", "tags": [ "Users" ] }, { "method": "POST", "path": "/users/terminate_sessions", "operationId": "post_users_terminate_sessions", "summary": "Box Create jobs to terminate users session", "tags": [ "Session Termination" ] }, { "method": "GET", "path": "/users/{user_id}", "operationId": "get_users_id", "summary": "Box Get user", "tags": [ "Users" ] }, { "method": "PUT", "path": "/users/{user_id}", "operationId": "put_users_id", "summary": "Box Update user", "tags": [ "Users" ] }, { "method": "DELETE", "path": "/users/{user_id}", "operationId": "delete_users_id", "summary": "Box Delete user", "tags": [ "Users" ] }, { "method": "GET", "path": "/users/{user_id}/avatar", "operationId": "get_users_id_avatar", "summary": "Box Get user avatar", "tags": [ "User Avatars" ] }, { "method": "POST", "path": "/users/{user_id}/avatar", "operationId": "post_users_id_avatar", "summary": "Box Add or update user avatar", "tags": [ "User Avatars" ] }, { "method": "DELETE", "path": "/users/{user_id}/avatar", "operationId": "delete_users_id_avatar", "summary": "Box Delete user avatar", "tags": [ "User Avatars" ] }, { "method": "PUT", "path": "/users/{user_id}/folders/0", "operationId": "put_users_id_folders_0", "summary": "Box Transfer owned folders", "tags": [ "Transfer Folders" ] }, { "method": "GET", "path": "/users/{user_id}/email_aliases", "operationId": "get_users_id_email_aliases", "summary": "Box List user's email aliases", "tags": [ "Email Aliases" ] }, { "method": "POST", "path": "/users/{user_id}/email_aliases", "operationId": "post_users_id_email_aliases", "summary": "Box Create email alias", "tags": [ "Email Aliases" ] }, { "method": "DELETE", "path": "/users/{user_id}/email_aliases/{email_alias_id}", "operationId": "delete_users_id_email_aliases_id", "summary": "Box Remove email alias", "tags": [ "Email Aliases" ] }, { "method": "GET", "path": "/users/{user_id}/memberships", "operationId": "get_users_id_memberships", "summary": "Box List user's groups", "tags": [ "Group Memberships" ] }, { "method": "POST", "path": "/invites", "operationId": "post_invites", "summary": "Box Create user invite", "tags": [ "Invites" ] }, { "method": "GET", "path": "/invites/{invite_id}", "operationId": "get_invites_id", "summary": "Box Get user invite status", "tags": [ "Invites" ] }, { "method": "GET", "path": "/groups", "operationId": "get_groups", "summary": "Box List groups for enterprise", "tags": [ "Groups" ] }, { "method": "POST", "path": "/groups", "operationId": "post_groups", "summary": "Box Create group", "tags": [ "Groups" ] }, { "method": "POST", "path": "/groups/terminate_sessions", "operationId": "post_groups_terminate_sessions", "summary": "Box Create jobs to terminate user group session", "tags": [ "Session Termination" ] }, { "method": "GET", "path": "/groups/{group_id}", "operationId": "get_groups_id", "summary": "Box Get group", "tags": [ "Groups" ] }, { "method": "PUT", "path": "/groups/{group_id}", "operationId": "put_groups_id", "summary": "Box Update group", "tags": [ "Groups" ] }, { "method": "DELETE", "path": "/groups/{group_id}", "operationId": "delete_groups_id", "summary": "Box Remove group", "tags": [ "Groups" ] }, { "method": "GET", "path": "/groups/{group_id}/memberships", "operationId": "get_groups_id_memberships", "summary": "Box List members of group", "tags": [ "Group Memberships" ] }, { "method": "GET", "path": "/groups/{group_id}/collaborations", "operationId": "get_groups_id_collaborations", "summary": "Box List group collaborations", "tags": [ "Collaborations (List)" ] }, { "method": "POST", "path": "/group_memberships", "operationId": "post_group_memberships", "summary": "Box Add user to group", "tags": [ "Group Memberships" ] }, { "method": "GET", "path": "/group_memberships/{group_membership_id}", "operationId": "get_group_memberships_id", "summary": "Box Get group membership", "tags": [ "Group Memberships" ] }, { "method": "PUT", "path": "/group_memberships/{group_membership_id}", "operationId": "put_group_memberships_id", "summary": "Box Update group membership", "tags": [ "Group Memberships" ] }, { "method": "DELETE", "path": "/group_memberships/{group_membership_id}", "operationId": "delete_group_memberships_id", "summary": "Box Remove user from group", "tags": [ "Group Memberships" ] }, { "method": "GET", "path": "/webhooks", "operationId": "get_webhooks", "summary": "Box List all webhooks", "tags": [ "Webhooks" ] }, { "method": "POST", "path": "/webhooks", "operationId": "post_webhooks", "summary": "Box Create webhook", "tags": [ "Webhooks" ] }, { "method": "GET", "path": "/webhooks/{webhook_id}", "operationId": "get_webhooks_id", "summary": "Box Get webhook", "tags": [ "Webhooks" ] }, { "method": "PUT", "path": "/webhooks/{webhook_id}", "operationId": "put_webhooks_id", "summary": "Box Update webhook", "tags": [ "Webhooks" ] }, { "method": "DELETE", "path": "/webhooks/{webhook_id}", "operationId": "delete_webhooks_id", "summary": "Box Remove webhook", "tags": [ "Webhooks" ] }, { "method": "PUT", "path": "/skill_invocations/{skill_id}", "operationId": "put_skill_invocations_id", "summary": "Update all Box Skill cards on file", "tags": [ "Skills" ] }, { "method": "GET", "path": "/events", "operationId": "get_events", "summary": "Box List user and enterprise events", "tags": [ "Events" ] }, { "method": "GET", "path": "/collections", "operationId": "get_collections", "summary": "Box List all collections", "tags": [ "Collections" ] }, { "method": "GET", "path": "/collections/{collection_id}/items", "operationId": "get_collections_id_items", "summary": "Box List collection items", "tags": [ "Collections" ] }, { "method": "GET", "path": "/recent_items", "operationId": "get_recent_items", "summary": "Box List recently accessed items", "tags": [ "Recent Items" ] }, { "method": "GET", "path": "/retention_policies", "operationId": "get_retention_policies", "summary": "Box List retention policies", "tags": [ "Retention Policies" ] }, { "method": "POST", "path": "/retention_policies", "operationId": "post_retention_policies", "summary": "Box Create retention policy", "tags": [ "Retention Policies" ] }, { "method": "GET", "path": "/retention_policies/{retention_policy_id}", "operationId": "get_retention_policies_id", "summary": "Box Get retention policy", "tags": [ "Retention Policies" ] }, { "method": "PUT", "path": "/retention_policies/{retention_policy_id}", "operationId": "put_retention_policies_id", "summary": "Box Update retention policy", "tags": [ "Retention Policies" ] }, { "method": "DELETE", "path": "/retention_policies/{retention_policy_id}", "operationId": "delete_retention_policies_id", "summary": "Box Delete retention policy", "tags": [ "Retention Policies" ] }, { "method": "GET", "path": "/retention_policies/{retention_policy_id}/assignments", "operationId": "get_retention_policies_id_assignments", "summary": "Box List retention policy assignments", "tags": [ "Retention Policy Assignments" ] }, { "method": "POST", "path": "/retention_policy_assignments", "operationId": "post_retention_policy_assignments", "summary": "Box Assign retention policy", "tags": [ "Retention Policy Assignments" ] }, { "method": "GET", "path": "/retention_policy_assignments/{retention_policy_assignment_id}", "operationId": "get_retention_policy_assignments_id", "summary": "Box Get retention policy assignment", "tags": [ "Retention Policy Assignments" ] }, { "method": "DELETE", "path": "/retention_policy_assignments/{retention_policy_assignment_id}", "operationId": "delete_retention_policy_assignments_id", "summary": "Box Remove retention policy assignment", "tags": [ "Retention Policy Assignments" ] }, { "method": "GET", "path": "/retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention", "operationId": "get_retention_policy_assignments_id_files_under_retention", "summary": "Box Get files under retention", "tags": [ "Retention Policy Assignments" ] }, { "method": "GET", "path": "/retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention", "operationId": "get_retention_policy_assignments_id_file_versions_under_retention", "summary": "Box Get file versions under retention", "tags": [ "Retention Policy Assignments" ] }, { "method": "GET", "path": "/legal_hold_policies", "operationId": "get_legal_hold_policies", "summary": "Box List all legal hold policies", "tags": [ "Legal Hold Policies" ] }, { "method": "POST", "path": "/legal_hold_policies", "operationId": "post_legal_hold_policies", "summary": "Box Create legal hold policy", "tags": [ "Legal Hold Policies" ] }, { "method": "GET", "path": "/legal_hold_policies/{legal_hold_policy_id}", "operationId": "get_legal_hold_policies_id", "summary": "Box Get legal hold policy", "tags": [ "Legal Hold Policies" ] }, { "method": "PUT", "path": "/legal_hold_policies/{legal_hold_policy_id}", "operationId": "put_legal_hold_policies_id", "summary": "Box Update legal hold policy", "tags": [ "Legal Hold Policies" ] }, { "method": "DELETE", "path": "/legal_hold_policies/{legal_hold_policy_id}", "operationId": "delete_legal_hold_policies_id", "summary": "Box Remove legal hold policy", "tags": [ "Legal Hold Policies" ] }, { "method": "GET", "path": "/legal_hold_policy_assignments", "operationId": "get_legal_hold_policy_assignments", "summary": "Box List legal hold policy assignments", "tags": [ "Legal Hold Policy Assignments" ] }, { "method": "POST", "path": "/legal_hold_policy_assignments", "operationId": "post_legal_hold_policy_assignments", "summary": "Box Assign legal hold policy", "tags": [ "Legal Hold Policy Assignments" ] }, { "method": "GET", "path": "/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}", "operationId": "get_legal_hold_policy_assignments_id", "summary": "Box Get legal hold policy assignment", "tags": [ "Legal Hold Policy Assignments" ] }, { "method": "DELETE", "path": "/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}", "operationId": "delete_legal_hold_policy_assignments_id", "summary": "Box Unassign legal hold policy", "tags": [ "Legal Hold Policy Assignments" ] }, { "method": "GET", "path": "/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold", "operationId": "get_legal_hold_policy_assignments_id_files_on_hold", "summary": "Box List current file versions for legal hold policy assignment", "tags": [ "Legal Hold Policy Assignments" ] }, { "method": "GET", "path": "/file_version_retentions", "operationId": "get_file_version_retentions", "summary": "Box List file version retentions", "tags": [ "File Version Retentions" ] }, { "method": "GET", "path": "/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold", "operationId": "get_legal_hold_policy_assignments_id_file_versions_on_hold", "summary": "Box List previous file versions for legal hold policy assignment", "tags": [ "Legal Hold Policy Assignments" ] }, { "method": "GET", "path": "/file_version_retentions/{file_version_retention_id}", "operationId": "get_file_version_retentions_id", "summary": "Box Get retention on file", "tags": [ "File Version Retentions" ] }, { "method": "GET", "path": "/file_version_legal_holds/{file_version_legal_hold_id}", "operationId": "get_file_version_legal_holds_id", "summary": "Box Get file version legal hold", "tags": [ "File Version Legal Holds" ] }, { "method": "GET", "path": "/file_version_legal_holds", "operationId": "get_file_version_legal_holds", "summary": "Box List file version legal holds", "tags": [ "File Version Legal Holds" ] }, { "method": "GET", "path": "/shield_information_barriers/{shield_information_barrier_id}", "operationId": "get_shield_information_barriers_id", "summary": "Box Get shield information barrier with specified ID", "tags": [ "Shield Information Barriers" ] }, { "method": "POST", "path": "/shield_information_barriers/change_status", "operationId": "post_shield_information_barriers_change_status", "summary": "Box Add changed status of shield information barrier with specified ID", "tags": [ "Shield Information Barriers" ] }, { "method": "GET", "path": "/shield_information_barriers", "operationId": "get_shield_information_barriers", "summary": "Box List shield information barriers", "tags": [ "Shield Information Barriers" ] }, { "method": "POST", "path": "/shield_information_barriers", "operationId": "post_shield_information_barriers", "summary": "Box Create shield information barrier", "tags": [ "Shield Information Barriers" ] }, { "method": "GET", "path": "/shield_information_barrier_reports", "operationId": "get_shield_information_barrier_reports", "summary": "Box List shield information barrier reports", "tags": [ "Shield Information Barrier Reports" ] }, { "method": "POST", "path": "/shield_information_barrier_reports", "operationId": "post_shield_information_barrier_reports", "summary": "Box Create shield information barrier report", "tags": [ "Shield Information Barrier Reports" ] }, { "method": "GET", "path": "/shield_information_barrier_reports/{shield_information_barrier_report_id}", "operationId": "get_shield_information_barrier_reports_id", "summary": "Box Get shield information barrier report by ID", "tags": [ "Shield Information Barrier Reports" ] }, { "method": "GET", "path": "/shield_information_barrier_segments/{shield_information_barrier_segment_id}", "operationId": "get_shield_information_barrier_segments_id", "summary": "Box Get shield information barrier segment with specified ID", "tags": [ "Shield Information Barrier Segments" ] }, { "method": "PUT", "path": "/shield_information_barrier_segments/{shield_information_barrier_segment_id}", "operationId": "put_shield_information_barrier_segments_id", "summary": "Box Update shield information barrier segment with specified ID", "tags": [ "Shield Information Barrier Segments" ] }, { "method": "DELETE", "path": "/shield_information_barrier_segments/{shield_information_barrier_segment_id}", "operationId": "delete_shield_information_barrier_segments_id", "summary": "Box Delete shield information barrier segment", "tags": [ "Shield Information Barrier Segments" ] }, { "method": "GET", "path": "/shield_information_barrier_segments", "operationId": "get_shield_information_barrier_segments", "summary": "Box List shield information barrier segments", "tags": [ "Shield Information Barrier Segments" ] }, { "method": "POST", "path": "/shield_information_barrier_segments", "operationId": "post_shield_information_barrier_segments", "summary": "Box Create shield information barrier segment", "tags": [ "Shield Information Barrier Segments" ] }, { "method": "GET", "path": "/shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}", "operationId": "get_shield_information_barrier_segment_members_id", "summary": "Box Get shield information barrier segment member by ID", "tags": [ "Shield Information Barrier Segment Members" ] }, { "method": "DELETE", "path": "/shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}", "operationId": "delete_shield_information_barrier_segment_members_id", "summary": "Box Delete shield information barrier segment member by ID", "tags": [ "Shield Information Barrier Segment Members" ] }, { "method": "GET", "path": "/shield_information_barrier_segment_members", "operationId": "get_shield_information_barrier_segment_members", "summary": "Box List shield information barrier segment members", "tags": [ "Shield Information Barrier Segment Members" ] }, { "method": "POST", "path": "/shield_information_barrier_segment_members", "operationId": "post_shield_information_barrier_segment_members", "summary": "Box Create shield information barrier segment member", "tags": [ "Shield Information Barrier Segment Members" ] }, { "method": "GET", "path": "/shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}", "operationId": "get_shield_information_barrier_segment_restrictions_id", "summary": "Box Get shield information barrier segment restriction by ID", "tags": [ "Shield Information Barrier Segment Restrictions" ] }, { "method": "DELETE", "path": "/shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}", "operationId": "delete_shield_information_barrier_segment_restrictions_id", "summary": "Box Delete shield information barrier segment restriction by ID", "tags": [ "Shield Information Barrier Segment Restrictions" ] }, { "method": "GET", "path": "/shield_information_barrier_segment_restrictions", "operationId": "get_shield_information_barrier_segment_restrictions", "summary": "Box List shield information barrier segment restrictions", "tags": [ "Shield Information Barrier Segment Restrictions" ] }, { "method": "POST", "path": "/shield_information_barrier_segment_restrictions", "operationId": "post_shield_information_barrier_segment_restrictions", "summary": "Box Create shield information barrier segment restriction", "tags": [ "Shield Information Barrier Segment Restrictions" ] }, { "method": "GET", "path": "/device_pinners/{device_pinner_id}", "operationId": "get_device_pinners_id", "summary": "Box Get device pin", "tags": [ "Device Pinners" ] }, { "method": "DELETE", "path": "/device_pinners/{device_pinner_id}", "operationId": "delete_device_pinners_id", "summary": "Box Remove device pin", "tags": [ "Device Pinners" ] }, { "method": "GET", "path": "/enterprises/{enterprise_id}/device_pinners", "operationId": "get_enterprises_id_device_pinners", "summary": "Box List enterprise device pins", "tags": [ "Device Pinners" ] }, { "method": "GET", "path": "/terms_of_services", "operationId": "get_terms_of_services", "summary": "Box List terms of services", "tags": [ "Terms of Service" ] }, { "method": "POST", "path": "/terms_of_services", "operationId": "post_terms_of_services", "summary": "Box Create terms of service", "tags": [ "Terms of Service" ] }, { "method": "GET", "path": "/terms_of_services/{terms_of_service_id}", "operationId": "get_terms_of_services_id", "summary": "Box Get terms of service", "tags": [ "Terms of Service" ] }, { "method": "PUT", "path": "/terms_of_services/{terms_of_service_id}", "operationId": "put_terms_of_services_id", "summary": "Box Update terms of service", "tags": [ "Terms of Service" ] }, { "method": "GET", "path": "/terms_of_service_user_statuses", "operationId": "get_terms_of_service_user_statuses", "summary": "Box List terms of service user statuses", "tags": [ "Terms of Service User Statuses" ] }, { "method": "POST", "path": "/terms_of_service_user_statuses", "operationId": "post_terms_of_service_user_statuses", "summary": "Box Create terms of service status for new user", "tags": [ "Terms of Service User Statuses" ] }, { "method": "PUT", "path": "/terms_of_service_user_statuses/{terms_of_service_user_status_id}", "operationId": "put_terms_of_service_user_statuses_id", "summary": "Box Update terms of service status for existing user", "tags": [ "Terms of Service User Statuses" ] }, { "method": "GET", "path": "/collaboration_whitelist_entries", "operationId": "get_collaboration_whitelist_entries", "summary": "Box List allowed collaboration domains", "tags": [ "Domain Restrictions for Collaborations" ] }, { "method": "POST", "path": "/collaboration_whitelist_entries", "operationId": "post_collaboration_whitelist_entries", "summary": "Box Add domain to list of allowed collaboration domains", "tags": [ "Domain Restrictions for Collaborations" ] }, { "method": "GET", "path": "/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}", "operationId": "get_collaboration_whitelist_entries_id", "summary": "Box Get allowed collaboration domain", "tags": [ "Domain Restrictions for Collaborations" ] }, { "method": "DELETE", "path": "/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}", "operationId": "delete_collaboration_whitelist_entries_id", "summary": "Box Remove domain from list of allowed collaboration domains", "tags": [ "Domain Restrictions for Collaborations" ] }, { "method": "GET", "path": "/collaboration_whitelist_exempt_targets", "operationId": "get_collaboration_whitelist_exempt_targets", "summary": "Box List users exempt from collaboration domain restrictions", "tags": [ "Domain Restrictions (User Exemptions)" ] }, { "method": "POST", "path": "/collaboration_whitelist_exempt_targets", "operationId": "post_collaboration_whitelist_exempt_targets", "summary": "Box Create user exemption from collaboration domain restrictions", "tags": [ "Domain Restrictions (User Exemptions)" ] }, { "method": "GET", "path": "/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}", "operationId": "get_collaboration_whitelist_exempt_targets_id", "summary": "Box Get user exempt from collaboration domain restrictions", "tags": [ "Domain Restrictions (User Exemptions)" ] }, { "method": "DELETE", "path": "/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}", "operationId": "delete_collaboration_whitelist_exempt_targets_id", "summary": "Box Remove user from list of users exempt from domain restrictions", "tags": [ "Domain Restrictions (User Exemptions)" ] }, { "method": "GET", "path": "/storage_policies", "operationId": "get_storage_policies", "summary": "Box List storage policies", "tags": [ "Standard and Zones Storage Policies" ] }, { "method": "GET", "path": "/storage_policies/{storage_policy_id}", "operationId": "get_storage_policies_id", "summary": "Box Get storage policy", "tags": [ "Standard and Zones Storage Policies" ] }, { "method": "GET", "path": "/storage_policy_assignments", "operationId": "get_storage_policy_assignments", "summary": "Box List storage policy assignments", "tags": [ "Standard and Zones Storage Policy Assignments" ] }, { "method": "POST", "path": "/storage_policy_assignments", "operationId": "post_storage_policy_assignments", "summary": "Box Assign storage policy", "tags": [ "Standard and Zones Storage Policy Assignments" ] }, { "method": "GET", "path": "/storage_policy_assignments/{storage_policy_assignment_id}", "operationId": "get_storage_policy_assignments_id", "summary": "Box Get storage policy assignment", "tags": [ "Standard and Zones Storage Policy Assignments" ] }, { "method": "PUT", "path": "/storage_policy_assignments/{storage_policy_assignment_id}", "operationId": "put_storage_policy_assignments_id", "summary": "Box Update storage policy assignment", "tags": [ "Standard and Zones Storage Policy Assignments" ] }, { "method": "DELETE", "path": "/storage_policy_assignments/{storage_policy_assignment_id}", "operationId": "delete_storage_policy_assignments_id", "summary": "Box Unassign storage policy", "tags": [ "Standard and Zones Storage Policy Assignments" ] }, { "method": "POST", "path": "/zip_downloads", "operationId": "post_zip_downloads", "summary": "Box Create zip download", "tags": [ "Zip Downloads" ] }, { "method": "GET", "path": "/zip_downloads/{zip_download_id}/content", "operationId": "get_zip_downloads_id_content", "summary": "Box Download zip archive", "tags": [ "Zip Downloads" ] }, { "method": "GET", "path": "/zip_downloads/{zip_download_id}/status", "operationId": "get_zip_downloads_id_status", "summary": "Box Get zip download status", "tags": [ "Zip Downloads" ] }, { "method": "POST", "path": "/sign_requests/{sign_request_id}/cancel", "operationId": "post_sign_requests_id_cancel", "summary": "Box Cancel sign request", "tags": [ "Sign Requests" ] }, { "method": "POST", "path": "/sign_requests/{sign_request_id}/resend", "operationId": "post_sign_requests_id_resend", "summary": "Box Resend sign request", "tags": [ "Sign Requests" ] }, { "method": "GET", "path": "/sign_requests/{sign_request_id}", "operationId": "get_sign_requests_id", "summary": "Box Get sign request by ID", "tags": [ "Sign Requests" ] }, { "method": "GET", "path": "/sign_requests", "operationId": "get_sign_requests", "summary": "Box List sign requests", "tags": [ "Sign Requests" ] }, { "method": "POST", "path": "/sign_requests", "operationId": "post_sign_requests", "summary": "Box Create sign request", "tags": [ "Sign Requests" ] }, { "method": "GET", "path": "/workflows", "operationId": "get_workflows", "summary": "Box List workflows", "tags": [ "Workflows" ] }, { "method": "POST", "path": "/workflows/{workflow_id}/start", "operationId": "post_workflows_id_start", "summary": "Box Starts workflow based on request body", "tags": [ "Workflows" ] }, { "method": "GET", "path": "/sign_templates", "operationId": "get_sign_templates", "summary": "List Box Sign templates", "tags": [ "Sign Templates" ] }, { "method": "GET", "path": "/sign_templates/{template_id}", "operationId": "get_sign_templates_id", "summary": "Get Box Sign template by ID", "tags": [ "Sign Templates" ] }, { "method": "GET", "path": "/integration_mappings/slack", "operationId": "get_integration_mappings_slack", "summary": "Box List Slack integration mappings", "tags": [ "Integration Mappings" ] }, { "method": "POST", "path": "/integration_mappings/slack", "operationId": "post_integration_mappings_slack", "summary": "Box Create Slack integration mapping", "tags": [ "Integration Mappings" ] }, { "method": "PUT", "path": "/integration_mappings/slack/{integration_mapping_id}", "operationId": "put_integration_mappings_slack_id", "summary": "Box Update Slack integration mapping", "tags": [ "Integration Mappings" ] }, { "method": "DELETE", "path": "/integration_mappings/slack/{integration_mapping_id}", "operationId": "delete_integration_mappings_slack_id", "summary": "Box Delete Slack integration mapping", "tags": [ "Integration Mappings" ] } ] }