api.md

API Reference

Caution

box-python-sdk-gen is deprecated and no longer maintained. As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects.

Use box-python-sdk v10+ instead: pip install "boxsdk>=10". box-python-sdk v10 includes every manager listed below, plus newer ones. To migrate existing code, see the migration guide.

This file lists every manager and method exposed on BoxClient. For setup, authentication, and usage examples, see README.md. Each section links to a page in docs/ with code samples. Parameters marked ? are optional.

Client

See docs/client.md and docs/configuration.md.

Methods:

• client.make_request(fetch_options) -> FetchResponse
• client.with_as_user_header(user_id) -> BoxClient
• client.with_suppressed_notifications() -> BoxClient
• client.with_extra_headers(extra_headers?) -> BoxClient
• client.with_custom_base_urls(base_urls) -> BoxClient
• client.with_proxy(config) -> BoxClient

Authorization

Examples: docs/authorization.md

Methods:

• client.authorization.authorize_user(response_type, client_id, redirect_uri?, state?, scope?, extra_headers?) -> None
• client.authorization.request_access_token(grant_type, client_id?, client_secret?, code?, refresh_token?, assertion?, subject_token?, subject_token_type?, actor_token?, actor_token_type?, scope?, resource?, box_subject_type?, box_subject_id?, box_shared_link?, extra_headers?) -> AccessToken
• client.authorization.refresh_access_token(client_id, client_secret, refresh_token, grant_type?, extra_headers?) -> AccessToken
• client.authorization.revoke_access_token(client_id?, client_secret?, token?, extra_headers?) -> None

Files

Examples: docs/files.md

Methods:

• client.files.get_file_by_id(file_id, fields?, if_none_match?, boxapi?, x_rep_hints?, extra_headers?) -> FileFull
• client.files.update_file_by_id(file_id, name?, description?, parent?, shared_link?, lock?, disposition_at?, permissions?, collections?, tags?, fields?, if_match?, extra_headers?) -> FileFull
• client.files.delete_file_by_id(file_id, if_match?, extra_headers?) -> None
• client.files.copy_file(file_id, parent, name?, version?, fields?, extra_headers?) -> FileFull
• client.files.get_file_thumbnail_url(file_id, extension, min_height?, min_width?, max_height?, max_width?, extra_headers?) -> str
• client.files.get_file_thumbnail_by_id(file_id, extension, min_height?, min_width?, max_height?, max_width?, extra_headers?) -> Optional[ByteStream]

Trashed files

Examples: docs/trashed_files.md

Methods:

• client.trashed_files.restore_file_from_trash(file_id, name?, parent?, fields?, extra_headers?) -> TrashFileRestored
• client.trashed_files.get_trashed_file_by_id(file_id, fields?, extra_headers?) -> TrashFile
• client.trashed_files.delete_trashed_file_by_id(file_id, extra_headers?) -> None

App item associations

Examples: docs/app_item_associations.md

Methods:

• client.app_item_associations.get_file_app_item_associations(file_id, limit?, marker?, application_type?, extra_headers?) -> AppItemAssociations
• client.app_item_associations.get_folder_app_item_associations(folder_id, limit?, marker?, application_type?, extra_headers?) -> AppItemAssociations

Downloads

Examples: docs/downloads.md

Methods:

• client.downloads.get_download_file_url(file_id, version?, access_token?, range?, boxapi?, extra_headers?) -> str
• client.downloads.download_file(file_id, version?, access_token?, range?, boxapi?, extra_headers?) -> Optional[ByteStream]
• client.downloads.download_file_to_output_stream(file_id, output_stream, version?, access_token?, range?, boxapi?, extra_headers?) -> None

Uploads

Examples: docs/uploads.md

Methods:

• client.uploads.upload_file_version(file_id, attributes, file, file_file_name?, file_content_type?, fields?, if_match?, content_md_5?, extra_headers?) -> Files
• client.uploads.preflight_file_upload_check(name?, size?, parent?, extra_headers?) -> UploadUrl
• client.uploads.upload_file(attributes, file, file_file_name?, file_content_type?, fields?, content_md_5?, extra_headers?) -> Files
• client.uploads.upload_with_preflight_check(attributes, file, file_file_name?, file_content_type?, fields?, content_md_5?, extra_headers?) -> Files

Chunked uploads

Examples: docs/chunked_uploads.md

Methods:

• client.chunked_uploads.create_file_upload_session(folder_id, file_size, file_name, extra_headers?) -> UploadSession
• client.chunked_uploads.create_file_upload_session_for_existing_file(file_id, file_size, file_name?, extra_headers?) -> UploadSession
• client.chunked_uploads.get_file_upload_session_by_url(url, extra_headers?) -> UploadSession
• client.chunked_uploads.get_file_upload_session_by_id(upload_session_id, extra_headers?) -> UploadSession
• client.chunked_uploads.upload_file_part_by_url(url, request_body, digest, content_range, extra_headers?) -> UploadedPart
• client.chunked_uploads.upload_file_part(upload_session_id, request_body, digest, content_range, extra_headers?) -> UploadedPart
• client.chunked_uploads.delete_file_upload_session_by_url(url, extra_headers?) -> None
• client.chunked_uploads.delete_file_upload_session_by_id(upload_session_id, extra_headers?) -> None
• client.chunked_uploads.get_file_upload_session_parts_by_url(url, offset?, limit?, extra_headers?) -> UploadParts
• client.chunked_uploads.get_file_upload_session_parts(upload_session_id, offset?, limit?, extra_headers?) -> UploadParts
• client.chunked_uploads.create_file_upload_session_commit_by_url(url, parts, digest, if_match?, if_none_match?, extra_headers?) -> Optional[Files]
• client.chunked_uploads.create_file_upload_session_commit(upload_session_id, parts, digest, if_match?, if_none_match?, extra_headers?) -> Optional[Files]
• client.chunked_uploads.upload_big_file(file, file_name, file_size, parent_folder_id) -> FileFull

List collaborations

Examples: docs/list_collaborations.md

Methods:

• client.list_collaborations.get_file_collaborations(file_id, fields?, limit?, marker?, extra_headers?) -> Collaborations
• client.list_collaborations.get_folder_collaborations(folder_id, fields?, limit?, marker?, extra_headers?) -> Collaborations
• client.list_collaborations.get_collaborations(status, fields?, offset?, limit?, extra_headers?) -> CollaborationsOffsetPaginated
• client.list_collaborations.get_group_collaborations(group_id, limit?, offset?, extra_headers?) -> CollaborationsOffsetPaginated

Comments

Examples: docs/comments.md

Methods:

• client.comments.get_file_comments(file_id, fields?, limit?, offset?, extra_headers?) -> Comments
• client.comments.get_comment_by_id(comment_id, fields?, extra_headers?) -> CommentFull
• client.comments.update_comment_by_id(comment_id, message?, fields?, extra_headers?) -> CommentFull
• client.comments.delete_comment_by_id(comment_id, extra_headers?) -> None
• client.comments.create_comment(message, item, tagged_message?, fields?, extra_headers?) -> CommentFull

Tasks

Examples: docs/tasks.md

Methods:

• client.tasks.get_file_tasks(file_id, extra_headers?) -> Tasks
• client.tasks.create_task(item, action?, message?, due_at?, completion_rule?, extra_headers?) -> Task
• client.tasks.get_task_by_id(task_id, extra_headers?) -> Task
• client.tasks.update_task_by_id(task_id, action?, message?, due_at?, completion_rule?, extra_headers?) -> Task
• client.tasks.delete_task_by_id(task_id, extra_headers?) -> None

File versions

Examples: docs/file_versions.md

Methods:

• client.file_versions.get_file_versions(file_id, fields?, limit?, offset?, extra_headers?) -> FileVersions
• client.file_versions.get_file_version_by_id(file_id, file_version_id, fields?, extra_headers?) -> FileVersionFull
• client.file_versions.delete_file_version_by_id(file_id, file_version_id, if_match?, extra_headers?) -> None
• client.file_versions.update_file_version_by_id(file_id, file_version_id, trashed_at?, extra_headers?) -> FileVersionFull
• client.file_versions.promote_file_version(file_id, id?, type?, fields?, extra_headers?) -> FileVersionFull

File metadata

Examples: docs/file_metadata.md

Methods:

• client.file_metadata.get_file_metadata(file_id, extra_headers?) -> Metadatas
• client.file_metadata.get_file_metadata_by_id(file_id, scope, template_key, extra_headers?) -> MetadataFull
• client.file_metadata.create_file_metadata_by_id(file_id, scope, template_key, request_body, extra_headers?) -> MetadataFull
• client.file_metadata.update_file_metadata_by_id(file_id, scope, template_key, request_body, extra_headers?) -> MetadataFull
• client.file_metadata.delete_file_metadata_by_id(file_id, scope, template_key, extra_headers?) -> None

File classifications

Examples: docs/file_classifications.md

Methods:

• client.file_classifications.get_classification_on_file(file_id, extra_headers?) -> Classification
• client.file_classifications.add_classification_to_file(file_id, box_security_classification_key?, extra_headers?) -> Classification
• client.file_classifications.update_classification_on_file(file_id, request_body, extra_headers?) -> Classification
• client.file_classifications.delete_classification_from_file(file_id, extra_headers?) -> None

Skills

Examples: docs/skills.md

Methods:

• client.skills.get_box_skill_cards_on_file(file_id, extra_headers?) -> SkillCardsMetadata
• client.skills.create_box_skill_cards_on_file(file_id, cards, extra_headers?) -> SkillCardsMetadata
• client.skills.update_box_skill_cards_on_file(file_id, request_body, extra_headers?) -> SkillCardsMetadata
• client.skills.delete_box_skill_cards_from_file(file_id, extra_headers?) -> None
• client.skills.update_all_skill_cards_on_file(skill_id, status, metadata, file, file_version?, usage?, extra_headers?) -> None

File watermarks

Examples: docs/file_watermarks.md

Methods:

• client.file_watermarks.get_file_watermark(file_id, extra_headers?) -> Watermark
• client.file_watermarks.update_file_watermark(file_id, watermark, extra_headers?) -> Watermark
• client.file_watermarks.delete_file_watermark(file_id, extra_headers?) -> None

File requests

Examples: docs/file_requests.md

Methods:

• client.file_requests.get_file_request_by_id(file_request_id, extra_headers?) -> FileRequest
• client.file_requests.update_file_request_by_id(file_request_id, title?, description?, status?, is_email_required?, is_description_required?, expires_at?, if_match?, extra_headers?) -> FileRequest
• client.file_requests.delete_file_request_by_id(file_request_id, extra_headers?) -> None
• client.file_requests.create_file_request_copy(file_request_id, folder, title?, description?, status?, is_email_required?, is_description_required?, expires_at?, extra_headers?) -> FileRequest

Folders

Examples: docs/folders.md

Methods:

• client.folders.get_folder_by_id(folder_id, fields?, sort?, direction?, offset?, limit?, if_none_match?, boxapi?, extra_headers?) -> FolderFull
• client.folders.update_folder_by_id(folder_id, name?, description?, sync_state?, can_non_owners_invite?, parent?, shared_link?, folder_upload_email?, tags?, is_collaboration_restricted_to_enterprise?, collections?, can_non_owners_view_collaborators?, fields?, if_match?, extra_headers?) -> FolderFull
• client.folders.delete_folder_by_id(folder_id, recursive?, if_match?, extra_headers?) -> None
• client.folders.get_folder_items(folder_id, fields?, usemarker?, marker?, offset?, limit?, sort?, direction?, boxapi?, extra_headers?) -> Items
• client.folders.create_folder(name, parent, folder_upload_email?, sync_state?, fields?, extra_headers?) -> FolderFull
• client.folders.copy_folder(folder_id, parent, name?, fields?, extra_headers?) -> FolderFull

Trashed folders

Examples: docs/trashed_folders.md

Methods:

• client.trashed_folders.restore_folder_from_trash(folder_id, name?, parent?, fields?, extra_headers?) -> TrashFolderRestored
• client.trashed_folders.get_trashed_folder_by_id(folder_id, fields?, extra_headers?) -> TrashFolder
• client.trashed_folders.delete_trashed_folder_by_id(folder_id, extra_headers?) -> None

Folder metadata

Examples: docs/folder_metadata.md

Methods:

• client.folder_metadata.get_folder_metadata(folder_id, extra_headers?) -> Metadatas
• client.folder_metadata.get_folder_metadata_by_id(folder_id, scope, template_key, extra_headers?) -> MetadataFull
• client.folder_metadata.create_folder_metadata_by_id(folder_id, scope, template_key, request_body, extra_headers?) -> MetadataFull
• client.folder_metadata.update_folder_metadata_by_id(folder_id, scope, template_key, request_body, extra_headers?) -> MetadataFull
• client.folder_metadata.delete_folder_metadata_by_id(folder_id, scope, template_key, extra_headers?) -> None

Folder classifications

Examples: docs/folder_classifications.md

Methods:

• client.folder_classifications.get_classification_on_folder(folder_id, extra_headers?) -> Classification
• client.folder_classifications.add_classification_to_folder(folder_id, box_security_classification_key?, extra_headers?) -> Classification
• client.folder_classifications.update_classification_on_folder(folder_id, request_body, extra_headers?) -> Classification
• client.folder_classifications.delete_classification_from_folder(folder_id, extra_headers?) -> None

Trashed items

Examples: docs/trashed_items.md

Methods:

• client.trashed_items.get_trashed_items(fields?, limit?, offset?, usemarker?, marker?, direction?, sort?, extra_headers?) -> Items

Folder watermarks

Examples: docs/folder_watermarks.md

Methods:

• client.folder_watermarks.get_folder_watermark(folder_id, extra_headers?) -> Watermark
• client.folder_watermarks.update_folder_watermark(folder_id, watermark, extra_headers?) -> Watermark
• client.folder_watermarks.delete_folder_watermark(folder_id, extra_headers?) -> None

Folder locks

Examples: docs/folder_locks.md

Methods:

• client.folder_locks.get_folder_locks(folder_id, extra_headers?) -> FolderLocks
• client.folder_locks.create_folder_lock(folder, locked_operations?, extra_headers?) -> FolderLock
• client.folder_locks.delete_folder_lock_by_id(folder_lock_id, extra_headers?) -> None

Metadata templates

Examples: docs/metadata_templates.md

Methods:

• client.metadata_templates.get_metadata_templates_by_instance_id(metadata_instance_id, marker?, limit?, extra_headers?) -> MetadataTemplates
• client.metadata_templates.get_metadata_template(scope, template_key, extra_headers?) -> MetadataTemplate
• client.metadata_templates.update_metadata_template(scope, template_key, request_body, extra_headers?) -> MetadataTemplate
• client.metadata_templates.delete_metadata_template(scope, template_key, extra_headers?) -> None
• client.metadata_templates.get_metadata_template_by_id(template_id, extra_headers?) -> MetadataTemplate
• client.metadata_templates.get_global_metadata_templates(marker?, limit?, extra_headers?) -> MetadataTemplates
• client.metadata_templates.get_enterprise_metadata_templates(marker?, limit?, extra_headers?) -> MetadataTemplates
• client.metadata_templates.create_metadata_template(scope, display_name, template_key?, hidden?, fields?, copy_instance_on_item_copy?, extra_headers?) -> MetadataTemplate

Classifications

Examples: docs/classifications.md

Methods:

• client.classifications.get_classification_template(extra_headers?) -> ClassificationTemplate
• client.classifications.add_classification(request_body, extra_headers?) -> ClassificationTemplate
• client.classifications.update_classification(request_body, extra_headers?) -> ClassificationTemplate
• client.classifications.create_classification_template(fields, scope?, template_key?, display_name?, hidden?, copy_instance_on_item_copy?, extra_headers?) -> ClassificationTemplate

Metadata cascade policies

Examples: docs/metadata_cascade_policies.md

Methods:

• client.metadata_cascade_policies.get_metadata_cascade_policies(folder_id, owner_enterprise_id?, marker?, offset?, extra_headers?) -> MetadataCascadePolicies
• client.metadata_cascade_policies.create_metadata_cascade_policy(folder_id, scope, template_key, extra_headers?) -> MetadataCascadePolicy
• client.metadata_cascade_policies.get_metadata_cascade_policy_by_id(metadata_cascade_policy_id, extra_headers?) -> MetadataCascadePolicy
• client.metadata_cascade_policies.delete_metadata_cascade_policy_by_id(metadata_cascade_policy_id, extra_headers?) -> None
• client.metadata_cascade_policies.apply_metadata_cascade_policy(metadata_cascade_policy_id, conflict_resolution, extra_headers?) -> None

Search

Examples: docs/search.md

Methods:

• client.search.search_by_metadata_query(from_, ancestor_folder_id, query?, query_params?, order_by?, limit?, marker?, fields?, extra_headers?) -> MetadataQueryResults
• client.search.search_for_content(query?, scope?, file_extensions?, created_at_range?, updated_at_range?, size_range?, owner_user_ids?, recent_updater_user_ids?, ancestor_folder_ids?, content_types?, type?, trash_content?, mdfilters?, sort?, direction?, limit?, include_recent_shared_links?, fields?, offset?, deleted_user_ids?, deleted_at_range?, extra_headers?) -> Union[SearchResults, SearchResultsWithSharedLinks]

User collaborations

Examples: docs/user_collaborations.md

Methods:

• client.user_collaborations.get_collaboration_by_id(collaboration_id, fields?, extra_headers?) -> Collaboration
• client.user_collaborations.update_collaboration_by_id(collaboration_id, role, status?, expires_at?, can_view_path?, extra_headers?) -> Optional[Collaboration]
• client.user_collaborations.delete_collaboration_by_id(collaboration_id, extra_headers?) -> None
• client.user_collaborations.create_collaboration(item, accessible_by, role, is_access_only?, can_view_path?, expires_at?, fields?, notify?, extra_headers?) -> Collaboration

Task assignments

Examples: docs/task_assignments.md

Methods:

• client.task_assignments.get_task_assignments(task_id, extra_headers?) -> TaskAssignments
• client.task_assignments.create_task_assignment(task, assign_to, extra_headers?) -> TaskAssignment
• client.task_assignments.get_task_assignment_by_id(task_assignment_id, extra_headers?) -> TaskAssignment
• client.task_assignments.update_task_assignment_by_id(task_assignment_id, message?, resolution_state?, extra_headers?) -> TaskAssignment
• client.task_assignments.delete_task_assignment_by_id(task_assignment_id, extra_headers?) -> None

Shared links files

Examples: docs/shared_links_files.md

Methods:

• client.shared_links_files.find_file_for_shared_link(boxapi, fields?, if_none_match?, extra_headers?) -> FileFull
• client.shared_links_files.get_shared_link_for_file(file_id, fields, extra_headers?) -> FileFull
• client.shared_links_files.add_share_link_to_file(file_id, fields, shared_link?, extra_headers?) -> FileFull
• client.shared_links_files.update_shared_link_on_file(file_id, fields, shared_link?, extra_headers?) -> FileFull
• client.shared_links_files.remove_shared_link_from_file(file_id, fields, shared_link?, extra_headers?) -> FileFull

Shared links folders

Examples: docs/shared_links_folders.md

Methods:

• client.shared_links_folders.find_folder_for_shared_link(boxapi, fields?, if_none_match?, extra_headers?) -> FolderFull
• client.shared_links_folders.get_shared_link_for_folder(folder_id, fields, extra_headers?) -> FolderFull
• client.shared_links_folders.add_share_link_to_folder(folder_id, fields, shared_link?, extra_headers?) -> FolderFull
• client.shared_links_folders.update_shared_link_on_folder(folder_id, fields, shared_link?, extra_headers?) -> FolderFull
• client.shared_links_folders.remove_shared_link_from_folder(folder_id, fields, shared_link?, extra_headers?) -> FolderFull

Web links

Examples: docs/web_links.md

Methods:

• client.web_links.create_web_link(url, parent, name?, description?, extra_headers?) -> WebLink
• client.web_links.get_web_link_by_id(web_link_id, boxapi?, extra_headers?) -> WebLink
• client.web_links.update_web_link_by_id(web_link_id, url?, parent?, name?, description?, shared_link?, extra_headers?) -> WebLink
• client.web_links.delete_web_link_by_id(web_link_id, extra_headers?) -> None

Trashed web links

Examples: docs/trashed_web_links.md

Methods:

• client.trashed_web_links.restore_weblink_from_trash(web_link_id, name?, parent?, fields?, extra_headers?) -> TrashWebLinkRestored
• client.trashed_web_links.get_trashed_web_link_by_id(web_link_id, fields?, extra_headers?) -> TrashWebLink
• client.trashed_web_links.delete_trashed_web_link_by_id(web_link_id, extra_headers?) -> None

Shared links web links

Examples: docs/shared_links_web_links.md

Methods:

• client.shared_links_web_links.find_web_link_for_shared_link(boxapi, fields?, if_none_match?, extra_headers?) -> WebLink
• client.shared_links_web_links.get_shared_link_for_web_link(web_link_id, fields, extra_headers?) -> WebLink
• client.shared_links_web_links.add_share_link_to_web_link(web_link_id, fields, shared_link?, extra_headers?) -> WebLink
• client.shared_links_web_links.update_shared_link_on_web_link(web_link_id, fields, shared_link?, extra_headers?) -> WebLink
• client.shared_links_web_links.remove_shared_link_from_web_link(web_link_id, fields, shared_link?, extra_headers?) -> WebLink

Shared links app items

Examples: docs/shared_links_app_items.md

Methods:

• client.shared_links_app_items.find_app_item_for_shared_link(boxapi, extra_headers?) -> AppItem

Users

Examples: docs/users.md

Methods:

• client.users.get_users(filter_term?, user_type?, external_app_user_id?, fields?, offset?, limit?, usemarker?, marker?, extra_headers?) -> Users
• client.users.create_user(name, login?, is_platform_access_only?, role?, language?, is_sync_enabled?, job_title?, phone?, address?, space_amount?, tracking_codes?, can_see_managed_users?, timezone?, is_external_collab_restricted?, is_exempt_from_device_limits?, is_exempt_from_login_verification?, status?, external_app_user_id?, fields?, extra_headers?) -> UserFull
• client.users.get_user_me(fields?, extra_headers?) -> UserFull
• client.users.get_user_by_id(user_id, fields?, extra_headers?) -> UserFull
• client.users.update_user_by_id(user_id, enterprise?, notify?, name?, login?, role?, language?, is_sync_enabled?, job_title?, phone?, address?, tracking_codes?, can_see_managed_users?, timezone?, is_external_collab_restricted?, is_exempt_from_device_limits?, is_exempt_from_login_verification?, is_password_reset_required?, status?, space_amount?, notification_email?, external_app_user_id?, fields?, extra_headers?) -> UserFull
• client.users.delete_user_by_id(user_id, notify?, force?, extra_headers?) -> None

Session termination

Examples: docs/session_termination.md

Methods:

• client.session_termination.terminate_users_sessions(user_ids, user_logins, extra_headers?) -> SessionTerminationMessage
• client.session_termination.terminate_groups_sessions(group_ids, extra_headers?) -> SessionTerminationMessage

Avatars

Examples: docs/avatars.md

Methods:

• client.avatars.get_user_avatar(user_id, extra_headers?) -> ByteStream
• client.avatars.create_user_avatar(user_id, pic, pic_file_name?, pic_content_type?, extra_headers?) -> UserAvatar
• client.avatars.delete_user_avatar(user_id, extra_headers?) -> None

Transfer

Examples: docs/transfer.md

Methods:

• client.transfer.transfer_owned_folder(user_id, owned_by, fields?, notify?, extra_headers?) -> FolderFull

Email aliases

Examples: docs/email_aliases.md

Methods:

• client.email_aliases.get_user_email_aliases(user_id, extra_headers?) -> EmailAliases
• client.email_aliases.create_user_email_alias(user_id, email, extra_headers?) -> EmailAlias
• client.email_aliases.delete_user_email_alias_by_id(user_id, email_alias_id, extra_headers?) -> None

Memberships

Examples: docs/memberships.md

Methods:

• client.memberships.get_user_memberships(user_id, limit?, offset?, extra_headers?) -> GroupMemberships
• client.memberships.get_group_memberships(group_id, limit?, offset?, extra_headers?) -> GroupMemberships
• client.memberships.create_group_membership(user, group, role?, configurable_permissions?, fields?, extra_headers?) -> GroupMembership
• client.memberships.get_group_membership_by_id(group_membership_id, fields?, extra_headers?) -> GroupMembership
• client.memberships.update_group_membership_by_id(group_membership_id, role?, configurable_permissions?, fields?, extra_headers?) -> GroupMembership
• client.memberships.delete_group_membership_by_id(group_membership_id, extra_headers?) -> None

Invites

Examples: docs/invites.md

Methods:

• client.invites.create_invite(enterprise, actionable_by, fields?, extra_headers?) -> Invite
• client.invites.get_invite_by_id(invite_id, fields?, extra_headers?) -> Invite

Groups

Examples: docs/groups.md

Methods:

• client.groups.get_groups(filter_term?, fields?, limit?, offset?, extra_headers?) -> Groups
• client.groups.create_group(name, provenance?, external_sync_identifier?, description?, invitability_level?, member_viewability_level?, fields?, extra_headers?) -> GroupFull
• client.groups.get_group_by_id(group_id, fields?, extra_headers?) -> GroupFull
• client.groups.update_group_by_id(group_id, name?, provenance?, external_sync_identifier?, description?, invitability_level?, member_viewability_level?, fields?, extra_headers?) -> GroupFull
• client.groups.delete_group_by_id(group_id, extra_headers?) -> None

Webhooks

Examples: docs/webhooks.md

Methods:

• client.webhooks.get_webhooks(marker?, limit?, extra_headers?) -> Webhooks
• client.webhooks.create_webhook(target, address, triggers, extra_headers?) -> Webhook
• client.webhooks.get_webhook_by_id(webhook_id, extra_headers?) -> Webhook
• client.webhooks.update_webhook_by_id(webhook_id, target?, address?, triggers?, extra_headers?) -> Webhook
• client.webhooks.delete_webhook_by_id(webhook_id, extra_headers?) -> None
• client.webhooks.validate_message(body, headers, primary_key, secondary_key?, max_age?) -> bool

Events

Examples: docs/events.md

Methods:

• client.events.get_events_with_long_polling(extra_headers?) -> RealtimeServers
• client.events.get_events(stream_type?, stream_position?, limit?, event_type?, created_after?, created_before?, extra_headers?) -> Events
• client.events.get_event_stream(query_params?, headers?) -> EventStream

Collections

Examples: docs/collections.md

Methods:

• client.collections.get_collections(fields?, offset?, limit?, extra_headers?) -> Collections
• client.collections.get_collection_items(collection_id, fields?, offset?, limit?, extra_headers?) -> ItemsOffsetPaginated
• client.collections.get_collection_by_id(collection_id, extra_headers?) -> Collection

Recent items

Examples: docs/recent_items.md

Methods:

• client.recent_items.get_recent_items(fields?, limit?, marker?, extra_headers?) -> RecentItems

Retention policies

Examples: docs/retention_policies.md

Methods:

• client.retention_policies.get_retention_policies(policy_name?, policy_type?, created_by_user_id?, fields?, limit?, marker?, extra_headers?) -> RetentionPolicies
• client.retention_policies.create_retention_policy(policy_name, policy_type, disposition_action, description?, retention_length?, retention_type?, can_owner_extend_retention?, are_owners_notified?, custom_notification_recipients?, extra_headers?) -> RetentionPolicy
• client.retention_policies.get_retention_policy_by_id(retention_policy_id, fields?, extra_headers?) -> RetentionPolicy
• client.retention_policies.update_retention_policy_by_id(retention_policy_id, policy_name?, description?, disposition_action?, retention_type?, retention_length?, status?, can_owner_extend_retention?, are_owners_notified?, custom_notification_recipients?, extra_headers?) -> RetentionPolicy
• client.retention_policies.delete_retention_policy_by_id(retention_policy_id, extra_headers?) -> None

Retention policy assignments

Examples: docs/retention_policy_assignments.md

Methods:

• client.retention_policy_assignments.get_retention_policy_assignments(retention_policy_id, type?, fields?, marker?, limit?, extra_headers?) -> RetentionPolicyAssignments
• client.retention_policy_assignments.create_retention_policy_assignment(policy_id, assign_to, filter_fields?, start_date_field?, extra_headers?) -> RetentionPolicyAssignment
• client.retention_policy_assignments.get_retention_policy_assignment_by_id(retention_policy_assignment_id, fields?, extra_headers?) -> RetentionPolicyAssignment
• client.retention_policy_assignments.delete_retention_policy_assignment_by_id(retention_policy_assignment_id, extra_headers?) -> None
• client.retention_policy_assignments.get_files_under_retention_policy_assignment(retention_policy_assignment_id, marker?, limit?, extra_headers?) -> FilesUnderRetention

Legal hold policies

Examples: docs/legal_hold_policies.md

Methods:

• client.legal_hold_policies.get_legal_hold_policies(policy_name?, fields?, marker?, limit?, extra_headers?) -> LegalHoldPolicies
• client.legal_hold_policies.create_legal_hold_policy(policy_name, description?, filter_started_at?, filter_ended_at?, is_ongoing?, extra_headers?) -> LegalHoldPolicy
• client.legal_hold_policies.get_legal_hold_policy_by_id(legal_hold_policy_id, extra_headers?) -> LegalHoldPolicy
• client.legal_hold_policies.update_legal_hold_policy_by_id(legal_hold_policy_id, policy_name?, description?, release_notes?, extra_headers?) -> LegalHoldPolicy
• client.legal_hold_policies.delete_legal_hold_policy_by_id(legal_hold_policy_id, extra_headers?) -> None

Legal hold policy assignments

Examples: docs/legal_hold_policy_assignments.md

Methods:

• client.legal_hold_policy_assignments.get_legal_hold_policy_assignments(policy_id, assign_to_type?, assign_to_id?, marker?, limit?, fields?, extra_headers?) -> LegalHoldPolicyAssignments
• client.legal_hold_policy_assignments.create_legal_hold_policy_assignment(policy_id, assign_to, extra_headers?) -> LegalHoldPolicyAssignment
• client.legal_hold_policy_assignments.get_legal_hold_policy_assignment_by_id(legal_hold_policy_assignment_id, extra_headers?) -> LegalHoldPolicyAssignment
• client.legal_hold_policy_assignments.delete_legal_hold_policy_assignment_by_id(legal_hold_policy_assignment_id, extra_headers?) -> None
• client.legal_hold_policy_assignments.get_legal_hold_policy_assignment_file_on_hold(legal_hold_policy_assignment_id, marker?, limit?, fields?, extra_headers?) -> FilesOnHold

File version retentions

Examples: docs/file_version_retentions.md

Methods:

• client.file_version_retentions.get_file_version_retentions(file_id?, file_version_id?, policy_id?, disposition_action?, disposition_before?, disposition_after?, limit?, marker?, extra_headers?) -> FileVersionRetentions
• client.file_version_retentions.get_file_version_retention_by_id(file_version_retention_id, extra_headers?) -> FileVersionRetention

File version legal holds

Examples: docs/file_version_legal_holds.md

Methods:

• client.file_version_legal_holds.get_file_version_legal_hold_by_id(file_version_legal_hold_id, extra_headers?) -> FileVersionLegalHold
• client.file_version_legal_holds.get_file_version_legal_holds(policy_id, marker?, limit?, extra_headers?) -> FileVersionLegalHolds

Shield information barriers

Examples: docs/shield_information_barriers.md

Methods:

• client.shield_information_barriers.get_shield_information_barrier_by_id(shield_information_barrier_id, extra_headers?) -> ShieldInformationBarrier
• client.shield_information_barriers.update_shield_information_barrier_status(id, status, extra_headers?) -> ShieldInformationBarrier
• client.shield_information_barriers.get_shield_information_barriers(marker?, limit?, extra_headers?) -> ShieldInformationBarriers
• client.shield_information_barriers.create_shield_information_barrier(enterprise, extra_headers?) -> ShieldInformationBarrier

Shield information barrier reports

Examples: docs/shield_information_barrier_reports.md

Methods:

• client.shield_information_barrier_reports.get_shield_information_barrier_reports(shield_information_barrier_id, marker?, limit?, extra_headers?) -> ShieldInformationBarrierReports
• client.shield_information_barrier_reports.create_shield_information_barrier_report(shield_information_barrier?, extra_headers?) -> ShieldInformationBarrierReport
• client.shield_information_barrier_reports.get_shield_information_barrier_report_by_id(shield_information_barrier_report_id, extra_headers?) -> ShieldInformationBarrierReport

Shield information barrier segments

Examples: docs/shield_information_barrier_segments.md

Methods:

• client.shield_information_barrier_segments.get_shield_information_barrier_segment_by_id(shield_information_barrier_segment_id, extra_headers?) -> ShieldInformationBarrierSegment
• client.shield_information_barrier_segments.delete_shield_information_barrier_segment_by_id(shield_information_barrier_segment_id, extra_headers?) -> None
• client.shield_information_barrier_segments.update_shield_information_barrier_segment_by_id(shield_information_barrier_segment_id, name?, description?, extra_headers?) -> ShieldInformationBarrierSegment
• client.shield_information_barrier_segments.get_shield_information_barrier_segments(shield_information_barrier_id, marker?, limit?, extra_headers?) -> ShieldInformationBarrierSegments
• client.shield_information_barrier_segments.create_shield_information_barrier_segment(shield_information_barrier, name, description?, extra_headers?) -> ShieldInformationBarrierSegment

Shield information barrier segment members

Examples: docs/shield_information_barrier_segment_members.md

Methods:

• client.shield_information_barrier_segment_members.get_shield_information_barrier_segment_member_by_id(shield_information_barrier_segment_member_id, extra_headers?) -> ShieldInformationBarrierSegmentMember
• client.shield_information_barrier_segment_members.delete_shield_information_barrier_segment_member_by_id(shield_information_barrier_segment_member_id, extra_headers?) -> None
• client.shield_information_barrier_segment_members.get_shield_information_barrier_segment_members(shield_information_barrier_segment_id, marker?, limit?, extra_headers?) -> ShieldInformationBarrierSegmentMembers
• client.shield_information_barrier_segment_members.create_shield_information_barrier_segment_member(shield_information_barrier_segment, user, type?, shield_information_barrier?, extra_headers?) -> ShieldInformationBarrierSegmentMember

Shield information barrier segment restrictions

Examples: docs/shield_information_barrier_segment_restrictions.md

Methods:

• client.shield_information_barrier_segment_restrictions.get_shield_information_barrier_segment_restriction_by_id(shield_information_barrier_segment_restriction_id, extra_headers?) -> ShieldInformationBarrierSegmentRestriction
• client.shield_information_barrier_segment_restrictions.delete_shield_information_barrier_segment_restriction_by_id(shield_information_barrier_segment_restriction_id, extra_headers?) -> None
• client.shield_information_barrier_segment_restrictions.get_shield_information_barrier_segment_restrictions(shield_information_barrier_segment_id, marker?, limit?, extra_headers?) -> ShieldInformationBarrierSegmentRestrictions
• client.shield_information_barrier_segment_restrictions.create_shield_information_barrier_segment_restriction(shield_information_barrier_segment, restricted_segment, type?, shield_information_barrier?, extra_headers?) -> ShieldInformationBarrierSegmentRestriction

Device pinners

Examples: docs/device_pinners.md

Methods:

• client.device_pinners.get_device_pinner_by_id(device_pinner_id, extra_headers?) -> DevicePinner
• client.device_pinners.delete_device_pinner_by_id(device_pinner_id, extra_headers?) -> None
• client.device_pinners.get_enterprise_device_pinners(enterprise_id, marker?, limit?, direction?, extra_headers?) -> DevicePinners

Terms of services

Examples: docs/terms_of_services.md

Methods:

• client.terms_of_services.get_terms_of_service(tos_type?, extra_headers?) -> TermsOfServices
• client.terms_of_services.create_terms_of_service(status, text, tos_type?, extra_headers?) -> TermsOfService
• client.terms_of_services.get_terms_of_service_by_id(terms_of_service_id, extra_headers?) -> TermsOfService
• client.terms_of_services.update_terms_of_service_by_id(terms_of_service_id, status, text, extra_headers?) -> TermsOfService

Terms of service user statuses

Examples: docs/terms_of_service_user_statuses.md

Methods:

• client.terms_of_service_user_statuses.get_terms_of_service_user_statuses(tos_id, user_id?, extra_headers?) -> TermsOfServiceUserStatuses
• client.terms_of_service_user_statuses.create_terms_of_service_status_for_user(tos, user, is_accepted, extra_headers?) -> TermsOfServiceUserStatus
• client.terms_of_service_user_statuses.update_terms_of_service_status_for_user_by_id(terms_of_service_user_status_id, is_accepted, extra_headers?) -> TermsOfServiceUserStatus

Collaboration allowlist entries

Examples: docs/collaboration_allowlist_entries.md

Methods:

• client.collaboration_allowlist_entries.get_collaboration_whitelist_entries(marker?, limit?, extra_headers?) -> CollaborationAllowlistEntries
• client.collaboration_allowlist_entries.create_collaboration_whitelist_entry(domain, direction, extra_headers?) -> CollaborationAllowlistEntry
• client.collaboration_allowlist_entries.get_collaboration_whitelist_entry_by_id(collaboration_whitelist_entry_id, extra_headers?) -> CollaborationAllowlistEntry
• client.collaboration_allowlist_entries.delete_collaboration_whitelist_entry_by_id(collaboration_whitelist_entry_id, extra_headers?) -> None

Collaboration allowlist exempt targets

Examples: docs/collaboration_allowlist_exempt_targets.md

Methods:

• client.collaboration_allowlist_exempt_targets.get_collaboration_whitelist_exempt_targets(marker?, limit?, extra_headers?) -> CollaborationAllowlistExemptTargets
• client.collaboration_allowlist_exempt_targets.create_collaboration_whitelist_exempt_target(user, extra_headers?) -> CollaborationAllowlistExemptTarget
• client.collaboration_allowlist_exempt_targets.get_collaboration_whitelist_exempt_target_by_id(collaboration_whitelist_exempt_target_id, extra_headers?) -> CollaborationAllowlistExemptTarget
• client.collaboration_allowlist_exempt_targets.delete_collaboration_whitelist_exempt_target_by_id(collaboration_whitelist_exempt_target_id, extra_headers?) -> None

Storage policies

Examples: docs/storage_policies.md

Methods:

• client.storage_policies.get_storage_policies(fields?, marker?, limit?, extra_headers?) -> StoragePolicies
• client.storage_policies.get_storage_policy_by_id(storage_policy_id, extra_headers?) -> StoragePolicy

Storage policy assignments

Examples: docs/storage_policy_assignments.md

Methods:

• client.storage_policy_assignments.get_storage_policy_assignments(resolved_for_type, resolved_for_id, marker?, extra_headers?) -> StoragePolicyAssignments
• client.storage_policy_assignments.create_storage_policy_assignment(storage_policy, assigned_to, extra_headers?) -> StoragePolicyAssignment
• client.storage_policy_assignments.get_storage_policy_assignment_by_id(storage_policy_assignment_id, extra_headers?) -> StoragePolicyAssignment
• client.storage_policy_assignments.update_storage_policy_assignment_by_id(storage_policy_assignment_id, storage_policy, extra_headers?) -> StoragePolicyAssignment
• client.storage_policy_assignments.delete_storage_policy_assignment_by_id(storage_policy_assignment_id, extra_headers?) -> None

Zip downloads

Examples: docs/zip_downloads.md

Methods:

• client.zip_downloads.create_zip_download(items, download_file_name?, extra_headers?) -> ZipDownload
• client.zip_downloads.get_zip_download_content(download_url, extra_headers?) -> ByteStream
• client.zip_downloads.get_zip_download_status(status_url, extra_headers?) -> ZipDownloadStatus
• client.zip_downloads.download_zip(items, download_file_name?, extra_headers?) -> ByteStream

Sign requests

Examples: docs/sign_requests.md

Methods:

• client.sign_requests.cancel_sign_request(sign_request_id, extra_headers?) -> SignRequest
• client.sign_requests.resend_sign_request(sign_request_id, extra_headers?) -> None
• client.sign_requests.get_sign_request_by_id(sign_request_id, extra_headers?) -> SignRequest
• client.sign_requests.get_sign_requests(marker?, limit?, senders?, shared_requests?, extra_headers?) -> SignRequests
• client.sign_requests.create_sign_request(signers, source_files?, signature_color?, parent_folder?, is_document_preparation_needed?, redirect_url?, declined_redirect_url?, are_text_signatures_enabled?, email_subject?, email_message?, are_reminders_enabled?, name?, prefill_tags?, days_valid?, external_id?, template_id?, external_system_name?, extra_headers?) -> SignRequest

Workflows

Examples: docs/workflows.md

Methods:

• client.workflows.get_workflows(folder_id, trigger_type?, limit?, marker?, extra_headers?) -> Workflows
• client.workflows.start_workflow(workflow_id, flow, files, folder, type?, outcomes?, extra_headers?) -> None

Sign templates

Examples: docs/sign_templates.md

Methods:

• client.sign_templates.get_sign_templates(marker?, limit?, extra_headers?) -> SignTemplates
• client.sign_templates.get_sign_template_by_id(template_id, extra_headers?) -> SignTemplate

Integration mappings

Examples: docs/integration_mappings.md

Methods:

• client.integration_mappings.get_slack_integration_mapping(marker?, limit?, partner_item_type?, partner_item_id?, box_item_id?, box_item_type?, is_manually_created?, extra_headers?) -> IntegrationMappings
• client.integration_mappings.create_slack_integration_mapping(partner_item, box_item, options?, extra_headers?) -> IntegrationMapping
• client.integration_mappings.update_slack_integration_mapping_by_id(integration_mapping_id, box_item?, options?, extra_headers?) -> IntegrationMapping
• client.integration_mappings.delete_slack_integration_mapping_by_id(integration_mapping_id, extra_headers?) -> None
• client.integration_mappings.get_teams_integration_mapping(partner_item_type?, partner_item_id?, box_item_id?, box_item_type?, extra_headers?) -> IntegrationMappingsTeams
• client.integration_mappings.create_teams_integration_mapping(partner_item, box_item, extra_headers?) -> IntegrationMappingTeams
• client.integration_mappings.update_teams_integration_mapping_by_id(integration_mapping_id, box_item?, extra_headers?) -> IntegrationMappingTeams
• client.integration_mappings.delete_teams_integration_mapping_by_id(integration_mapping_id, extra_headers?) -> None

Ai

Examples: docs/ai.md

Methods:

• client.ai.create_ai_ask(mode, prompt, items, dialogue_history?, include_citations?, ai_agent?, extra_headers?) -> Optional[AiResponseFull]
• client.ai.create_ai_text_gen(prompt, items, dialogue_history?, ai_agent?, extra_headers?) -> AiResponse
• client.ai.get_ai_agent_default_config(mode, language?, model?, extra_headers?) -> Union[AiAgentAsk, AiAgentTextGen, AiAgentExtract, AiAgentExtractStructured]
• client.ai.create_ai_extract(prompt, items, ai_agent?, extra_headers?) -> AiResponse
• client.ai.create_ai_extract_structured(items, metadata_template?, fields?, ai_agent?, extra_headers?) -> AiExtractStructuredResponse

Ai studio

Examples: docs/ai_studio.md

Methods:

• client.ai_studio.get_ai_agents(mode?, fields?, agent_state?, include_box_default?, marker?, limit?, extra_headers?) -> AiMultipleAgentResponse
• client.ai_studio.create_ai_agent(name, access_state, type?, icon_reference?, allowed_entities?, ask?, text_gen?, extract?, extra_headers?) -> AiSingleAgentResponseFull
• client.ai_studio.update_ai_agent_by_id(agent_id, name, access_state, type?, icon_reference?, allowed_entities?, ask?, text_gen?, extract?, extra_headers?) -> AiSingleAgentResponseFull
• client.ai_studio.get_ai_agent_by_id(agent_id, fields?, extra_headers?) -> AiSingleAgentResponseFull
• client.ai_studio.delete_ai_agent_by_id(agent_id, extra_headers?) -> None

Docgen template

Examples: docs/docgen_template.md

Methods:

• client.docgen_template.create_docgen_template_v2025_r0(file, box_version?, extra_headers?) -> DocGenTemplateBaseV2025R0
• client.docgen_template.get_docgen_templates_v2025_r0(marker?, limit?, box_version?, extra_headers?) -> DocGenTemplatesV2025R0
• client.docgen_template.delete_docgen_template_by_id_v2025_r0(template_id, box_version?, extra_headers?) -> None
• client.docgen_template.get_docgen_template_by_id_v2025_r0(template_id, box_version?, extra_headers?) -> DocGenTemplateV2025R0
• client.docgen_template.get_docgen_template_tags_v2025_r0(template_id, template_version_id?, marker?, limit?, box_version?, extra_headers?) -> DocGenTagsV2025R0
• client.docgen_template.get_docgen_template_job_by_id_v2025_r0(template_id, marker?, limit?, box_version?, extra_headers?) -> DocGenJobsV2025R0

Docgen

Examples: docs/docgen.md

Methods:

• client.docgen.get_docgen_job_by_id_v2025_r0(job_id, box_version?, extra_headers?) -> DocGenJobV2025R0
• client.docgen.get_docgen_jobs_v2025_r0(marker?, limit?, box_version?, extra_headers?) -> DocGenJobsFullV2025R0
• client.docgen.get_docgen_batch_job_by_id_v2025_r0(batch_id, marker?, limit?, box_version?, extra_headers?) -> DocGenJobsV2025R0
• client.docgen.create_docgen_batch_v2025_r0(file, input_source, destination_folder, output_type, document_generation_data, file_version?, box_version?, extra_headers?) -> DocGenBatchBaseV2025R0

Hubs

Examples: docs/hubs.md

Methods:

• client.hubs.get_hubs_v2025_r0(query?, scope?, sort?, direction?, marker?, limit?, box_version?, extra_headers?) -> HubsV2025R0
• client.hubs.create_hub_v2025_r0(title, description?, box_version?, extra_headers?) -> HubV2025R0
• client.hubs.get_enterprise_hubs_v2025_r0(query?, sort?, direction?, marker?, limit?, box_version?, extra_headers?) -> HubsV2025R0
• client.hubs.get_hub_by_id_v2025_r0(hub_id, box_version?, extra_headers?) -> HubV2025R0
• client.hubs.update_hub_by_id_v2025_r0(hub_id, title?, description?, is_ai_enabled?, is_collaboration_restricted_to_enterprise?, can_non_owners_invite?, can_shared_link_be_created?, box_version?, extra_headers?) -> HubV2025R0
• client.hubs.delete_hub_by_id_v2025_r0(hub_id, box_version?, extra_headers?) -> None
• client.hubs.copy_hub_v2025_r0(hub_id, title?, description?, box_version?, extra_headers?) -> HubV2025R0

Hub collaborations

Examples: docs/hub_collaborations.md

Methods:

• client.hub_collaborations.get_hub_collaborations_v2025_r0(hub_id, marker?, limit?, box_version?, extra_headers?) -> HubCollaborationsV2025R0
• client.hub_collaborations.create_hub_collaboration_v2025_r0(hub, accessible_by, role, box_version?, extra_headers?) -> HubCollaborationV2025R0
• client.hub_collaborations.get_hub_collaboration_by_id_v2025_r0(hub_collaboration_id, box_version?, extra_headers?) -> HubCollaborationV2025R0
• client.hub_collaborations.update_hub_collaboration_by_id_v2025_r0(hub_collaboration_id, role?, box_version?, extra_headers?) -> HubCollaborationV2025R0
• client.hub_collaborations.delete_hub_collaboration_by_id_v2025_r0(hub_collaboration_id, box_version?, extra_headers?) -> None

Hub items

Examples: docs/hub_items.md

Methods:

• client.hub_items.get_hub_items_v2025_r0(hub_id, marker?, limit?, box_version?, extra_headers?) -> HubItemsV2025R0
• client.hub_items.manage_hub_items_v2025_r0(hub_id, operations?, box_version?, extra_headers?) -> HubItemsManageResponseV2025R0

Shield lists

Examples: docs/shield_lists.md

Methods:

• client.shield_lists.get_shield_lists_v2025_r0(box_version?, extra_headers?) -> ShieldListsV2025R0
• client.shield_lists.create_shield_list_v2025_r0(name, content, description?, box_version?, extra_headers?) -> ShieldListV2025R0
• client.shield_lists.get_shield_list_by_id_v2025_r0(shield_list_id, box_version?, extra_headers?) -> ShieldListV2025R0
• client.shield_lists.delete_shield_list_by_id_v2025_r0(shield_list_id, box_version?, extra_headers?) -> None
• client.shield_lists.update_shield_list_by_id_v2025_r0(shield_list_id, name, content, description?, box_version?, extra_headers?) -> ShieldListV2025R0

Archives

Examples: docs/archives.md

Methods:

• client.archives.get_archives_v2025_r0(limit?, marker?, box_version?, extra_headers?) -> ArchivesV2025R0
• client.archives.create_archive_v2025_r0(name, box_version?, extra_headers?) -> ArchiveV2025R0
• client.archives.delete_archive_by_id_v2025_r0(archive_id, box_version?, extra_headers?) -> None