Connect Claude & ChatGPT to ONLYOFFICE DocSpace

484 tools for ONLYOFFICE DocSpace

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

• add_a_file_to_the_recent_sectionChanges dataCreate a new document for a document. API summary: Add a file to the "Recent" section.
• approve_authenticationVisible to othersConfirm a authentication. Has effects visible outside this system. API summary: Open confirmation email URL.
• approve_licenseVisible to othersAccept a license. Has effects visible outside this system. API summary: Activate a license.
• approve_shareVisible to othersApprove a share. Has effects visible outside this system. API summary: Approve a guest sharing link.
• approve_tfaappVisible to othersConfirm a tfaapp. Has effects visible outside this system. API summary: Get confirmation email.
• archive_roomVisible to othersMove a room (`room_id`) to the archive. It can be restored later.
• attach_accountVisible to othersAttach a account. Has effects visible outside this system. API summary: Link a third-pary account.
• attach_documentChanges dataLink a document (file id). Results are paginated. API summary: Get primary external link.
• attach_folderChanges dataLink a folder (folder id). Results are paginated. API summary: Get primary external link.
• attach_folder_linkChanges dataLink a folder (folder id). API summary: Create primary external link.
• attach_telegramChanges dataLink a telegram. API summary: Get the Telegram link.
• attach_telegram_linkMoves moneyLink a telegram. Financial or irreversible action; may require approval. API summary: Unlink Telegram.
• attach_userChanges dataLink a user (room id). API summary: Get the room primary external link.
• cancel_migrationDeletesCancel a migration. Destructive action; may require approval. API summary: Cancel migration.
• copy_itemsDeletesCopy files (`file_ids`) and folders (`folder_ids`) into a destination folder (`dest_folder_id`).
• create_a_new_oauth2_clientChanges dataCreate a new customer. Required: redirect uris or allowed origins. API summary: Create a new OAuth2 client.
• create_accountChanges dataCreate a new account. Required: key or serialized profile. API summary: Create a third-pary account.
• create_additionalChanges dataCreate a new additional. API summary: Save the additional white label settings.
• create_aiagentquotasettingChanges dataCreate a new aiagentquotasetting. Required: default quota. API summary: Save the AI Agent quota settings.
• create_an_html_fileChanges dataCreate a new document for a document. Required: title. API summary: Create an HTML file.
• create_authenticationChanges dataCreate a new authentication. API summary: Authenticate a user.
• create_authserviceChanges dataCreate a new authservice. API summary: Save the authorization keys.
• create_backupChanges dataCreate a new backup. API summary: Save a third-party account backup.
• create_clearChanges dataCreate a new clear. API summary: Clear migration.
• create_companyChanges dataCreate a new company. API summary: Save the company white label settings.
• create_contactChanges dataCreate a new contact. Search contacts first to avoid duplicates. API summary: Add a user.
• create_createbackupscheduleChanges dataCreate a new createbackupschedule. API summary: Create the backup schedule.
• create_cspChanges dataCreate a new csp. API summary: Configure CSP settings.
• create_customerChanges dataCreate a new customer. API summary: Start the customer operations report generation.
• create_deeplinkChanges dataCreate a new deeplink. API summary: Configure the deep link settings.
• create_depositChanges dataCreate a new deposit. API summary: Put money on deposit.
• create_docregisterdeviceChanges dataCreate a new docregisterdevice. API summary: Save the Documents Firebase device token.
• create_documentChanges dataCreate a new document for a document. Required: dest title or dest folder id. API summary: Copy a file.
• create_document_change_file_ownerChanges dataCreate a new document. Required: user id. API summary: Change the file owner.
• create_document_check_uploadChanges dataCreate a new document. API summary: Check file uploads.
• create_document_create_html_file_in_my_documentsChanges dataCreate a new document. Required: title. API summary: Create an HTML file in the "My documents" section.
• create_document_create_text_file_in_my_documentsChanges dataCreate a new document. Required: title. API summary: Create a text file in the "My documents" section.
• create_document_formrolemappingDeletesCreate a new formrolemapping for a document. Required: form id or roles. Destructive action; may require approval. API summary: Save form role mapping.
• create_document_insert_fileChanges dataCreate a new document for a document. API summary: Insert a file.
• create_document_insert_file_to_my_from_bodyChanges dataCreate a new document. API summary: Insert a file to the "My documents" section.
• create_document_sessionChanges dataCreate a new document. Required: file name. API summary: Chunked upload.
• create_document_starteditChanges dataCreate a new startedit for a document. API summary: Start file editing.
• create_favoriteChanges dataCreate a new favorite. Search favorites first to avoid duplicates. API summary: Add favorite files and folders.
• create_fileChanges dataCreate a new file in a folder (`folder_id`) with a `title` including the extension, e.g. Report.docx or Budget.xlsx.
• create_file_in_my_documentsChanges dataCreate a new file in My documents with a `title` including the extension, e.g. Notes.docx.
• create_file_share_linkChanges dataCreate or update an external sharing link for a file (`file_id`), with optional `title`, `access`, `password`, `expiration_date` and `deny_download`. Anyone with the link can open the file.
• create_file_thumbnailsChanges dataCreate a new thumbnail. API summary: Create file thumbnails.
• create_finishChanges dataCreate a new finish. Required: is send welcome email. API summary: Finish migration.
• create_fromtemplateChanges dataCreate a new fromtemplate. Required: template id or title. API summary: Create a room from the template.
• create_greetingsettingChanges dataCreate a new greetingsetting. Required: title. API summary: Save the greeting settings.
• create_groupChanges dataCreate a new group. Required: group manager. Search groups first to avoid duplicates. API summary: Add a new group.
• create_group_userChanges dataCreate a new user for a group. Search users first to avoid duplicates. API summary: Replace group members.
• create_keyChanges dataCreate a new key. Required: name. API summary: Create a user API key.
• create_lifetimeChanges dataCreate a new lifetime. API summary: Set the audit trail settings.
• create_maildomainsettingChanges dataCreate a new maildomainsetting. Required: type, domains or invite users as visitors. API summary: Save the mail domain settings.
• create_markVisible to othersCreate a new mark. Has effects visible outside this system. API summary: Mark a gift message as read.
• create_masterform_checkfillformdraftChanges dataCreate a new checkfillformdraft for a masterform. Required: version. API summary: Check the form draft filling.
• create_migrateChanges dataCreate a new migrate. API summary: Start migration.
• create_notificationChanges dataCreate a new notification. Required: type. API summary: Enable notifications.
• create_referencedatumChanges dataCreate a new referencedatum. Required: file key or instance id. API summary: Get reference data.
• create_reportChanges dataCreate a new report. API summary: Generate the audit trail report.
• create_report_create_login_history_reportChanges dataCreate a new report. API summary: Generate the login history report.
• create_report_create_report_folder_historyChanges dataCreate a new report. API summary: Generates folder history.
• create_roomChanges dataCreate a room with a `title` and `room_type`, plus optional `tags`, `private`, `quota` and `deny_download`.
• create_roomquotasettingChanges dataCreate a new roomquotasetting. Required: default quota. API summary: Save the room quota settings.
• create_roomtemplateChanges dataCreate a new roomtemplate. Required: room id. API summary: Start creating room template.
• create_saveChanges dataCreate a new save. API summary: Save the white label logos.
• create_save_save_white_label_logo_textChanges dataCreate a new save. API summary: Save the white label logo text settings.
• create_savefromfileChanges dataCreate a new savefromfile. API summary: Save the white label logos from files.
• create_setphoneChanges dataCreate a new setphone. API summary: Set a mobile phone.
• create_shareChanges dataCreate a new share. Search shares first to avoid duplicates. API summary: Get the sharing rights.
• create_share_passwordDeletesCreate a new password for a share. Destructive action; may require approval. API summary: Apply external data password.
• create_smtpChanges dataCreate a new smtp. API summary: Save the SMTP settings.
• create_ssov2Changes dataCreate a new ssov2. Required: serialize settings. API summary: Save the SSO settings.
• create_startChanges dataCreate a new start. API summary: Start the storage encryption process.
• create_startbackupChanges dataCreate a new startbackup. API summary: Start the backup.
• create_startrestoreChanges dataCreate a new startrestore. Required: backup id. API summary: Start the restoring process.
• create_tagChanges dataCreate a new tag. Required: name. Search tags first to avoid duplicates. API summary: Create a room tag.
• create_templateChanges dataCreate a new template. API summary: Add template files.
• create_tenantChanges dataCreate a new tenant. API summary: Set wallet auto top-up settings.
• create_tenant_change_tenant_wallet_service_stateChanges dataCreate a new tenant. API summary: Change wallet service state.
• create_text_fileChanges dataCreate a text file in a folder (`folder_id`) with a `title` and its `content`.
• create_thirdpartyChanges dataCreate a new thirdparty. Required: customer title or provider key. API summary: Save a third-party account.
• create_thumbnailChanges dataCreate a new thumbnail. API summary: Create photo thumbnails.
• create_userChanges dataCreate a new user. Search users first to avoid duplicates. API summary: Set room notification status.
• create_user_coverChanges dataCreate a new cover for a user. API summary: Change the room cover.
• create_user_indexexportChanges dataCreate a new indexexport for a user. API summary: Start the room index export.
• create_user_invite_usersVisible to othersCreate a new user. Required: invitations. Search users first to avoid duplicates. Has effects visible outside this system. API summary: Invite users.
• create_user_logoChanges dataCreate a new logo for a user. API summary: Create a room logo.
• create_webhookDeletesCreate a new webhook. Required: name or uri. Destructive action; may require approval. API summary: Create a webhook.
• create_webpluginChanges dataCreate a new webplugin. API summary: Add a web plugin.
• delete_additionalsMoves moneyPermanently delete a additional. Financial or irreversible action; may require approval. API summary: Delete the additional white label settings.
• delete_cdnsMoves moneyPermanently delete a cdn. Financial or irreversible action; may require approval. API summary: Reset the CDN storage settings.
• delete_colorthemesMoves moneyPermanently delete a colortheme. Financial or irreversible action; may require approval. API summary: Delete a color theme.
• delete_companiesMoves moneyPermanently delete a company. Financial or irreversible action; may require approval. API summary: Delete the company white label settings.
• delete_contactDeletesPermanently delete a contact by userid. Destructive action; may require approval. API summary: Delete a user.
• delete_contact_photosMoves moneyPermanently delete a photo by userid. Financial or irreversible action; may require approval. API summary: Delete a user photo.
• delete_customerDeletesPermanently delete a customer by customer id. Destructive action; may require approval. API summary: Delete an OAuth2 client.
• delete_customer_revokesMoves moneyPermanently delete a revoke by client id. Financial or irreversible action; may require approval. API summary: Revoke client consent.
• delete_customersMoves moneyPermanently delete a customer. Financial or irreversible action; may require approval. API summary: Terminate the customer operations report generation.
• delete_deletebackupDeletesPermanently delete a deletebackup by deletebackup id. Destructive action; may require approval. API summary: Delete the backup.
• delete_deletebackuphistoriesMoves moneyPermanently delete a deletebackuphistory. Financial or irreversible action; may require approval. API summary: Delete the backup history.
• delete_deletebackupschedulesMoves moneyPermanently delete a deletebackupschedule. Financial or irreversible action; may require approval. API summary: Delete the backup schedule.
• delete_documentsMoves moneyPermanently delete a document. Financial or irreversible action; may require approval. API summary: Delete file versions.
• delete_favoritesMoves moneyPermanently delete a favorite. Financial or irreversible action; may require approval. API summary: Delete favorite files and folders (using body parameters).
• delete_fileDeletesDelete a file by `document_id`. It goes to Trash unless `immediately` is true, which deletes it permanently.
• delete_folderDeletesPermanently delete a folder by folder id. Destructive action; may require approval.
• delete_groupDeletesPermanently delete a group by group id. Destructive action; may require approval.
• delete_group_usersMoves moneyPermanently delete a user by group id. Financial or irreversible action; may require approval. API summary: Remove group members.
• delete_guestsMoves moneyPermanently delete a guest. Financial or irreversible action; may require approval. API summary: Delete guests.
• delete_indexexportsMoves moneyPermanently delete a indexexport. Financial or irreversible action; may require approval. API summary: Terminate the room index export.
• delete_keyDeletesPermanently delete a key by key id. Destructive action; may require approval. API summary: Delete a user API key.
• delete_loginsettingsMoves moneyPermanently delete a loginsetting. Financial or irreversible action; may require approval. API summary: Reset the login settings.
• delete_recentsMoves moneyPermanently delete a recent. Financial or irreversible action; may require approval. API summary: Delete recent files.
• delete_selvesMoves moneyPermanently delete a self. Financial or irreversible action; may require approval. API summary: Delete my profile.
• delete_sharesMoves moneyPermanently delete a share. Financial or irreversible action; may require approval. API summary: Remove the sharing rights.
• delete_smtpsMoves moneyPermanently delete a smtp. Financial or irreversible action; may require approval. API summary: Reset the SMTP settings.
• delete_ssov2sMoves moneyPermanently delete a ssov2. Financial or irreversible action; may require approval. API summary: Reset the SSO settings.
• delete_storagesMoves moneyPermanently delete a storage. Financial or irreversible action; may require approval. API summary: Reset the storage settings.
• delete_tagsMoves moneyPermanently delete a tag. Financial or irreversible action; may require approval. API summary: Delete the custom room tags.
• delete_templatesMoves moneyPermanently delete a template. Financial or irreversible action; may require approval. API summary: Delete template files.
• delete_the_personal_folderChanges dataCreate a new start. API summary: Delete the personal folder.
• delete_thirdpartyDeletesPermanently delete a thirdparty by provider id. Destructive action; may require approval. API summary: Remove a third-party account.
• delete_userDeletesPermanently delete a user by user id. Destructive action; may require approval. API summary: Remove a room.
• delete_user_logosMoves moneyPermanently delete a logo by room id. Financial or irreversible action; may require approval. API summary: Remove a room logo.
• delete_user_tagsMoves moneyPermanently delete a tag by room id. Financial or irreversible action; may require approval. API summary: Remove the room tags.
• delete_usersMoves moneyPermanently delete a user. Financial or irreversible action; may require approval. API summary: Delete a portal.
• delete_webhookDeletesPermanently delete a webhook by webhook id. Destructive action; may require approval. API summary: Remove a webhook.
• delete_webpluginDeletesPermanently delete a webplugin by name. Destructive action; may require approval. API summary: Delete a web plugin.
• detach_tfaappnewappVisible to othersDetach a tfaappnewapp. Has effects visible outside this system. API summary: Unlink the TFA application.
• detach_unlinkaccountMoves moneyDetach a unlinkaccount. Financial or irreversible action; may require approval. API summary: Unlink a third-pary account.
• get_a_portal_quotaList quota. API summary: Get a portal quota.
• get_a_third_party_account_backupList backups. API summary: Get a third-party account backup.
• get_account_entriesGet one user by room id. Results are paginated. API summary: Get account entries.
• get_account_entries_with_file_sharing_settingsGet one document by file id. Results are paginated. API summary: Get account entries with file sharing settings.
• get_account_entries_with_folder_sharing_settingsGet one folder by folder id. Results are paginated. API summary: Get account entries with folder sharing settings.
• get_all_providersList accounts. Optional filters: excludewebdav. API summary: Get all providers.
• get_an_invitation_linkGet one user by employee type. API summary: Get an invitation link.
• get_clientsList customers. Optional filters: last client id or last created on. Results are paginated. API summary: Get clients.
• get_customerGet one customer by customer id. API summary: Get client details.
• get_detailed_client_informationList customers for a customer. API summary: Get detailed client information.
• get_detailed_information_of_clientsList customers. Optional filters: last client id or last created on. Results are paginated. API summary: Get detailed information of clients.
• get_documentGet one document by document id. Results are paginated. API summary: Get groups with file sharing settings.
• get_favoriteGet one favorite by file id. API summary: Change the file favorite status.
• get_fileGet a file's details by `document_id`, optionally for a specific `version`.
• get_file_download_linkGet a temporary download link for a file by `file_id`.
• get_file_external_linksList documents for a document. Optional filters: start index. Results are paginated. API summary: Get file external links.
• get_file_group_members_with_security_informationSearch shares for a group by start index or filter value. Use this to find existing shares before creating a new share. Results are paginated. API summary: Get file group members with security information.
• get_file_settingsList documents. API summary: Get file settings.
• get_filtered_login_eventsSearch filters by user id, action, from, to or start index. Use this to find existing filters before creating a new filter. Results are paginated. API summary: Get filtered login events.
• get_folderGet a folder's details by `folder_id`.
• get_folder_2Get one folder by folder id. Results are paginated. API summary: Get groups with folder sharing settings.
• get_fromtemplate_statusGet the current status of a fromtemplate. API summary: Get the room creation progress.
• get_groupGet one group by group id. API summary: Get a group.
• get_groups_with_room_sharing_settingsGet one user by user id. Results are paginated. API summary: Get groups with room sharing settings.
• get_licenseGet one license. API summary: Refresh the license.
• get_login_historyList lasts. API summary: Get login history.
• get_migration_statusGet the current status of a migration. API summary: Get migration status.
• get_my_profileGet the signed-in DocSpace user's own profile.
• get_notificationGet one notification by type. API summary: Check notification availability.
• get_operation_statusCheck the progress of a running move or copy by `operation_type`, optionally with its `id`.
• get_productGet one product by productid. API summary: Get the product administrators.
• get_profiles_by_statusGet one user by status. Results are paginated. API summary: Get profiles by status.
• get_progressGet one progress by userid. API summary: Get the reassignment progress.
• get_providersList capabilities. API summary: Get providers.
• get_public_client_informationList customers. API summary: Get public client information.
• get_roomGet one room's details; pass the room ID in `user_id`.
• get_room_notification_settingsList users. API summary: Get room notification settings.
• get_roomtemplate_statusGet the current status of a roomtemplate. API summary: Get status of room template creation.
• get_securityGet one security by security id. API summary: Get the module availability.
• get_shareGet one share by share key. API summary: Get the external data.
• get_spaceusageGet one spaceusage by spaceusage id. API summary: Get the space usage statistics.
• get_test_statusGet the current status of a test. API summary: Get the SMTP testing process status.
• get_the_banners_visibilityList tenants. API summary: Get the banners visibility.
• get_the_deletion_progressGet one progress by userid. API summary: Get the deletion progress.
• get_the_developer_tools_access_settingsList tenants. API summary: Get the Developer Tools access settings.
• get_the_documents_informationList customers. API summary: Get the "Documents" information.
• get_the_ip_restriction_settingsList documents. API summary: Get the IP restriction settings.
• get_the_progress_of_deleting_the_personal_folderList progress. API summary: Get the progress of deleting the personal folder.
• get_the_progress_of_updating_user_typeGet one progress by userid. API summary: Get the progress of updating user type.
• get_the_shared_file_informationList documents for a document. Optional filters: start index. Results are paginated. API summary: Get the shared file information.
• get_the_storage_encryption_settingsList documents. API summary: Get the storage encryption settings.
• get_the_storage_progressList progress. API summary: Get the storage progress.
• get_the_user_invitation_settingsList users. API summary: Get the user invitation settings.
• get_the_user_quota_settingsList users. API summary: Get the user quota settings.
• get_the_white_label_logosList logos. Optional filters: is dark or is default. API summary: Get the white label logos.
• get_third_party_accountsList accounts. Optional filters: invite view, settings view, client callback or from only. API summary: Get third-party accounts.
• get_thirdpartyGet one thirdparty by provider. API summary: Get the code request.
• get_trackeditfile_statusGet the current status of a trackeditfile by file id. API summary: Track file editing.
• get_used_space_of_filesList documents. API summary: Get used space of files.
• get_userGet one user's profile by `userid`.
• get_user_2Get one user by user id. API summary: Get a user by ID.
• get_user_groupsGet one user by userid. API summary: Get user groups.
• get_users_with_file_sharing_settingsGet one document by document id. Results are paginated. API summary: Get users with file sharing settings.
• get_users_with_folder_sharing_settingsGet one folder by folder id. Results are paginated. API summary: Get users with folder sharing settings.
• get_users_with_room_sharing_settingsGet one user by user id. Results are paginated. API summary: Get users with room sharing settings.
• get_wallet_serviceList walletservices. Optional filters: service. API summary: Get wallet service.
• get_wallet_services_settingsList tenants. API summary: Get wallet services settings.
• get_webhook_logsList logs. Optional filters: delivery from, delivery to, hook uri, config id, event id or group status. Results are paginated. API summary: Get webhook logs.
• get_webpluginGet one webplugin by name. API summary: Get a web plugin by name.
• list_accountsList accounts. Optional filters: back url. API summary: Get the payment account.
• list_activeconnectionsList activeconnections. API summary: Get active connections.
• list_additionalsList additionals. API summary: Get the additional white label settings.
• list_authenticationsList authentications. API summary: Check authentication.
• list_authservicesList authservices. API summary: Get the authorization services.
• list_autocleanupsList autocleanups. API summary: Get the trash bin auto-clearing setting.
• list_availablesList availables. API summary: Check the "Private Room" availability.
• list_backupsList backups. Optional filters: dump. API summary: Get the backup storages.
• list_balancesList balances. Optional filters: refresh. API summary: Get the customer balance.
• list_capabilitiesList capabilities. API summary: Get portal capabilities.
• list_cdnsList cdns. API summary: Get the CDN storages.
• list_channelsList channels. API summary: Get notification channels.
• list_chechoutsetupurlsList chechoutsetupurls. Optional filters: back url. API summary: Get the checkout setup page URL.
• list_checkdestfoldersList checkdestfolders. Optional filters: in dto. API summary: Check for moving or copying files to a folder.
• list_colorthemesList colorthemes. API summary: Get a color theme.
• list_commonsList commons. API summary: Get the common third-party services.
• list_companiesList companies. API summary: Get the company white label settings.
• list_companywhitelabelsList companywhitelabels. API summary: Get the licensor data.
• list_consentsList consents. Optional filters: last modified on. Results are paginated. API summary: Get user consents.
• list_constantsList constants. API summary: Get the SSO settings constants.
• list_contact_photosList photos for a contact. API summary: Get a user photo.
• list_cookiesettingsList cookiesettings. API summary: Get cookies lifetime.
• list_coversList covers. API summary: Get covers.
• list_cspsList csps. API summary: Get CSP settings.
• list_culturesList cultures. API summary: Get supported languages.
• list_currenciesList currencies. API summary: Get currencies.
• list_customersList customers. Optional filters: refresh. API summary: Get the customer information.
• list_customers_get_customer_operations_reportList customers. API summary: Get the status of the customer operations report generation.
• list_deeplinksList deeplinks. API summary: Get the deep link settings.
• list_defaultsList defaults. API summary: Get the default SSO settings.
• list_diffsList diffs. Optional filters: version. API summary: Get changes URL.
• list_docservicesList docservices. Optional filters: version. API summary: Get the document service URL.
• list_document_checkconversionsList checkconversions for a document. Optional filters: start. API summary: Get conversion status.
• list_document_formfiltersList formfilters for a document. API summary: Get folder form filter.
• list_document_formrolesList formroles for a document. API summary: Get form roles.
• list_document_isformpdfsList isformpdfs for a document. API summary: Check the PDF file.
• list_document_logsList logs for a document. Optional filters: from date, to date or start index. Results are paginated. API summary: Get file history.
• list_document_newsList news for a document. API summary: Get new folder items.
• list_document_openeditsList openedits for a document. Optional filters: version, view, editor type, edit or fill. API summary: Open a file configuration.
• list_document_presignedurisList presigneduris for a document. API summary: Get file download link.
• list_document_protectusersList protectusers for a document. API summary: Get users access rights to the protected file.
• list_document_sharedusersList sharedusers for a document. API summary: Get user access rights by file ID.
• list_document_subfoldersList subfolders for a document. API summary: Get subfolders.
• list_documentsList documents. API summary: Get the portal settings.
• list_documents_check_telegramList documents. API summary: Check the Telegram connection.
• list_enablewhitelabelsList enablewhitelabels. API summary: Check the white label availability.
• list_file_versionsList the version history of a file by `file_id`.
• list_fileopsList fileops. Optional filters: id. API summary: Get active file operations.
• list_fillresultsList fillresults. API summary: Get form-filling result.
• list_folder_contentsList the files and subfolders in a folder or room by `folder_id`, with optional `filter_value` search text, `filter_type`, sorting and paging.
• list_folder_linksList links for a folder. API summary: Get the folder links.
• list_folder_logsList logs for a folder. Optional filters: from date, to date or start index. Results are paginated. API summary: Get folder history.
• list_folder_pathsList paths for a folder. API summary: Get the folder path.
• list_folder_sharesList shares for a folder. Optional filters: start index. Results are paginated. API summary: Get the shared folder information.
• list_getbackuphistoriesList getbackuphistories. Optional filters: dump. API summary: Get the backup history.
• list_getbackupprogressesList getbackupprogresses. Optional filters: dump. API summary: Get the backup progress.
• list_getbackupschedulesList getbackupschedules. Optional filters: dump. API summary: Get the backup schedule.
• list_getbackupscountsList getbackupscounts. Optional filters: from, to or paid. API summary: Get the number of backups.
• list_getrestoreprogressesList getrestoreprogresses. Optional filters: dump. API summary: Get the restoring progress.
• list_getservicestatesList getservicestates. API summary: Get the backup service state.
• list_greetingsettingsList greetingsettings. API summary: Get greeting settings.
• list_guest_sharesList shares for a guest. API summary: Get a guest sharing link.
• list_historiesList histories. API summary: Get version history.
• list_indexexportsList indexexports. API summary: Get the room index export.
• list_iprestrictionsList iprestrictions. API summary: Get the IP portal restrictions.
• list_isdefaultsList isdefaults. API summary: Check the default greeting settings.
• list_isdefaults_get_is_default_white_label_logo_textList isdefaults. Optional filters: is dark or is default. API summary: Check the default white label logo text.
• list_isdefaults_get_is_default_white_label_logosList isdefaults. Optional filters: is dark or is default. API summary: Check the default white label logos.
• list_keysList keys. API summary: Get current user's API keys.
• list_lastsList lasts. API summary: Get audit trail data.
• list_lifetimesList lifetimes. API summary: Get the audit trail settings.
• list_listsList lists. API summary: Get migrations.
• list_loginsettingsList loginsettings. API summary: Get the login settings.
• list_logosList logos. API summary: Get a portal logo.
• list_logotextsList logotexts. Optional filters: is dark or is default. API summary: Get the white label logo text.
• list_logsList logs. API summary: Get migration logs.
• list_machinesList machines. API summary: Get hostname.
• list_mappersList mappers. Optional filters: product type or module type. API summary: Get audit trail mappers.
• list_modulesList modules. API summary: Get the enabled modules.
• list_movesList moves. Optional filters: in dto. API summary: Move or copy files to a folder.
• list_my_documentsList files and folders in the user's My documents section, filtered by `filter_value` or `filter_type`.
• list_necessariesList necessaries. Optional filters: user id or type. API summary: Check data for reassignment need.
• list_newsList news. API summary: Get the room new items.
• list_operationsList operations. Optional filters: start date, end date, participant name, credit or debit. Results are paginated. API summary: Get the customer operations.
• list_passwordsList passwords. API summary: Get the password settings.
• list_pathsList paths. Optional filters: virtual path. API summary: Get a path to the portal.
• list_paymentsList payments. API summary: Get the payment settings.
• list_permissionsList permissions. API summary: Get API key permissions.
• list_portalsList portals. API summary: Get a portal.
• list_pricesList prices. API summary: Get prices.
• list_productsList products. Optional filters: productid or userid. API summary: Check a product administrator.
• list_progressList progress. API summary: Get the storage encryption progress.
• list_quotaList quota. Optional filters: refresh. API summary: Get quota payment information.
• list_quotasList quotas. Optional filters: wallet. API summary: Get quotas.
• list_recent_filesList recently opened files, filtered by `filter_value` or `extension`.
• list_regionsList regions. API summary: Get Amazon regions.
• list_requiredsList requireds. API summary: Request a license.
• list_rightsList rights. API summary: Get the recommended quota.
• list_room_membersList the users and groups who have access to a room by `room_id`.
• list_roomsList rooms, filtered by `filter_value` (name text), `type`, `tags` or `search_area`. Paginated with `start_index` and `limit`.
• list_roomtemplate_publicsList publics for a roomtemplate. API summary: Get public settings.
• list_root_foldersList the top-level sections (My documents, Rooms, Trash and so on) with their folder IDs.
• list_scopesList scopes. API summary: Get available OAuth2 scopes.
• list_securitiesList securities. Optional filters: ids. API summary: Get the security settings.
• list_selvesList selves. API summary: Get current user's API key.
• list_setupsList setups. API summary: Generate setup code.
• list_smtpsList smtps. API summary: Get the SMTP settings.
• list_socketsList sockets. API summary: Get the socket settings.
• list_ssov2sList ssov2s. API summary: Get the SSO settings.
• list_storagesList storages. API summary: Get storages.
• list_tariffsList tariffs. Optional filters: refresh. API summary: Get a portal tariff.
• list_tenantsList tenants. API summary: Get wallet auto top-up settings.
• list_testsList tests. API summary: Test the SMTP settings.
• list_tfaappcodesList tfaappcodes. API summary: Get the TFA codes.
• list_tfaappsList tfaapps. API summary: Get the TFA settings.
• list_themesList themes. API summary: Get the portal theme.
• list_thirdpartiesList thirdparties. API summary: Get the third-party accounts.
• list_timezonesList timezones. API summary: Get time zones.
• list_tokendiagnosticsList tokendiagnostics. API summary: Get user claims.
• list_triggersList triggers. API summary: Get webhook triggers.
• list_usedspacesList usedspaces. API summary: Get the portal used space.
• list_user_linksList links for a user. Optional filters: type. API summary: Get the room links.
• list_user_newsList news for a user. API summary: Get the new room items.
• list_usersList users in the DocSpace, filtered by `filter_value` and `filter_by`, with sorting and paging.
• list_users_2List users. API summary: Get audit trail types.
• list_userscountsList userscounts. API summary: Get a number of portal users.
• list_walletservicesList walletservices. API summary: Get wallet services.
• list_webhooksList webhooks. API summary: Get webhooks.
• list_webpluginsList webplugins. Optional filters: enabled. API summary: Get web plugins.
• move_itemsVisible to othersMove files (`file_ids`) and folders (`folder_ids`) into a destination folder (`dest_folder_id`).
• rename_fileChanges dataRename a file by `document_id` to a new `title`.
• rename_folderChanges dataRename a folder by `folder_id` to a new `title`.
• restore_greetingsettingChanges dataRestore a greetingsetting. API summary: Restore the greeting settings.
• restore_logoVisible to othersRestore a logo. Has effects visible outside this system. API summary: Restore the white label logos.
• restore_logotextVisible to othersRestore a logotext. Has effects visible outside this system. API summary: Restore the white label logo text.
• restore_messageDeletesRestore a message. Destructive action; may require approval. API summary: Enable the administrator message settings.
• restore_restoreversionChanges dataRestore a restoreversion (file id). API summary: Restore a file version.
• restore_userChanges dataUnarchive a user (room id). API summary: Unarchive a room.
• restore_webhookMoves moneyEnable a webhook. Financial or irreversible action; may require approval.
• save_file_as_pdfChanges dataSave a copy of a file (`file_id`) as a PDF with a new `title` in a folder (`folder_id`).
• search_favoritesSearch favorites by user id or group id, filter type, start index, sort by, sort order or filter value. Use this to find existing favorites before creating a new favorite. Results are paginated. API summary: Get the "Favorites" section.
• search_filtersSearch filters by user id, module type, action type, action, entry type or target. Use this to find existing filters before creating a new filter. Results are paginated. API summary: Get filtered audit trail data.
• search_group_sharesSearch shares for a group by start index or filter value. Use this to find existing shares before creating a new share. Results are paginated. API summary: Get folder group members with security information.
• search_groupsSearch groups by user id, manager, start index, sort by, sort order or filter value. Use this to find existing groups before creating a new group. Results are paginated. API summary: Get groups.
• search_privaciesSearch privacies by user id or group id, filter type, start index, sort by, sort order or filter value. Use this to find existing privacies before creating a new privacy. Results are paginated. API summary: Get the "Private Room" section.
• search_tagsSearch tags by start index or filter value. Use this to find existing tags before creating a new tag. Results are paginated. API summary: Get the room tags.
• search_trashesSearch trashes by user id or group id, filter type, apply filter option, start index, sort by or sort order. Use this to find existing trashes before creating a new trash. Results are paginated. API summary: Get the "Trash" section.
• search_usersSearch users by name or email text in `query`.
• search_users_by_extended_filterSearch filters by employee status, group id, activation status, employee type, employee types or is administrator. Use this to find existing filters before creating a new filter. Results are paginated. API summary: Search users by extended filter.
• search_users_by_status_filterGet one user by status. API summary: Search users by status filter.
• search_users_using_query_parametersSearch contacts by query. Use this to find existing contacts before creating a new contact. API summary: Search users (using query parameters).
• search_users_with_detailed_information_by_extended_filterSearch filters by employee status, group id, activation status, employee type, employee types or is administrator. Use this to find existing filters before creating a new filter. Results are paginated. API summary: Search users with detailed information by extended filter.
• send_contactVisible to othersEmail a contact. Has effects visible outside this system. API summary: Get a profile by user email.
• send_documentVisible to othersSend a document. Has effects visible outside this system. API summary: Send the owner change instructions.
• send_instructions_to_change_emailVisible to othersEmail a contact. Has effects visible outside this system. API summary: Send instructions to change email.
• send_messageDeletesSend a message. Destructive action; may require approval. API summary: Send a message to the administrator.
• send_message_send_join_invite_mailVisible to othersSend a message. Has effects visible outside this system. API summary: Sends an invitation email.
• send_passwordDeletesSend a password. Destructive action; may require approval. API summary: Remind a user password.
• send_requestVisible to othersSend a request. Has effects visible outside this system. API summary: Send a payment request.
• send_sendcongratulationVisible to othersSend a sendcongratulation. Has effects visible outside this system. API summary: Send congratulations.
• send_sendeditornotifyVisible to othersSend a sendeditornotify (file id). Has effects visible outside this system. API summary: Send the mention message.
• send_sendsmVisible to othersSend a sendsm. Has effects visible outside this system. API summary: Send SMS code.
• send_suspendVisible to othersSend a suspend. Has effects visible outside this system. API summary: Send suspension instructions.
• send_userVisible to othersSend a user. Has effects visible outside this system. API summary: Send removal instructions.
• set_an_activation_status_to_the_usersChanges dataUpdate an existing user identified by activationstatus. API summary: Set an activation status to the users.
• set_an_external_linkVisible to othersUpdate an existing document identified by file id. Has effects visible outside this system. API summary: Set an external link.
• set_the_banners_visibilityChanges dataCreate a new tenant. API summary: Set the banners visibility.
• set_the_developer_tools_access_settingsChanges dataCreate a new tenant. API summary: Set the Developer Tools access settings.
• start_file_fillingVisible to othersUpdate an existing document identified by file id. Has effects visible outside this system. API summary: Start file filling.
• start_the_data_deletionChanges dataCreate a new start. Required: user id. API summary: Start the data deletion.
• start_the_data_reassignmentChanges dataCreate a new start. Required: from user id or to user id. API summary: Start the data reassignment.
• start_updating_user_typeChanges dataCreate a new user. Search users first to avoid duplicates. API summary: Start updating user type.
• submit_documentVisible to othersLock a document (file id). Has effects visible outside this system. API summary: Lock a file.
• submit_fileop_duplicateDeletesDuplicate a fileop. Destructive action; may require approval. API summary: Duplicate files and folders.
• submit_tfaappVisible to othersValidate a tfaapp. Has effects visible outside this system. API summary: Validate the TFA code.
• submit_userVisible to othersResend a user (room id). Has effects visible outside this system. API summary: Resend the room invitations.
• submit_wizardDeletesComplete a wizard. Destructive action; may require approval. API summary: Complete the Wizard settings.
• update_accessesVisible to othersUpdate an existing access. Has effects visible outside this system. API summary: Set the security settings to modules.
• update_authenticationChanges dataUpdate an existing authentication identified by authentication code. API summary: Authenticate a user by code.
• update_autocleanupsVisible to othersUpdate an existing autocleanup. Has effects visible outside this system. API summary: Update the trash bin auto-clearing setting.
• update_bulkdownloadsVisible to othersUpdate an existing bulkdownload. Has effects visible outside this system. API summary: Bulk download.
• update_cdnsVisible to othersUpdate an existing cdn. Has effects visible outside this system. API summary: Update the CDN storage.
• update_changedeleteconfrimsVisible to othersUpdate an existing changedeleteconfrim. Has effects visible outside this system. API summary: Confirm the file deletion.
• update_closeadminhelpersMoves moneyUpdate an existing closeadminhelper. Financial or irreversible action; may require approval. API summary: Close the admin helper.
• update_colorthemesVisible to othersUpdate an existing colortheme. Has effects visible outside this system. API summary: Save a color theme.
• update_contactChanges dataUpdate an existing contact identified by userid. API summary: Update a user.
• update_contact_culturesVisible to othersUpdate an existing culture identified by userid. Has effects visible outside this system. API summary: Update a user culture code.
• update_contact_passwordsMoves moneyUpdate an existing password identified by userid. Financial or irreversible action; may require approval. API summary: Change a user password.
• update_contact_photosVisible to othersUpdate an existing photo identified by userid. Has effects visible outside this system. API summary: Update a user photo.
• update_continuesVisible to othersUpdate an existing continue. Has effects visible outside this system. API summary: Restore a portal.
• update_cookiesettingsVisible to othersUpdate an existing cookiesetting. Has effects visible outside this system. API summary: Update cookies lifetime.
• update_customerChanges dataUpdate an existing customer identified by customer id. API summary: Update an existing OAuth2 client.
• update_customer_activationsVisible to othersUpdate an existing activation identified by client id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Change the client activation status.
• update_customer_regeneratesVisible to othersUpdate an existing regenerate identified by client id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Regenerate the client secret.
• update_dafaultaccessrightsVisible to othersUpdate an existing dafaultaccessright. Has effects visible outside this system. API summary: Change the default access rights.
• update_displayfileextensionsVisible to othersUpdate an existing displayfileextension. Has effects visible outside this system. API summary: Display a file extension.
• update_displayrecentsVisible to othersUpdate an existing displayrecent. Has effects visible outside this system. API summary: Display the "Recent" folder.
• update_dnsVisible to othersUpdate an existing dn. Has effects visible outside this system. API summary: Save the DNS settings.
• update_docservicesVisible to othersUpdate an existing docservice. Has effects visible outside this system. API summary: Check the document service URL.
• update_docsubscribesVisible to othersUpdate an existing docsubscribe. Has effects visible outside this system. API summary: Subscribe to Documents push notification.
• update_document_checkconversionsVisible to othersUpdate an existing checkconversion identified by file id. Has effects visible outside this system. API summary: Start file conversion.
• update_document_customfiltersVisible to othersUpdate an existing customfilter identified by file id. Has effects visible outside this system. API summary: Set the Custom Filter editing mode.
• update_document_manageformfillingsVisible to othersUpdate an existing manageformfilling identified by file id. Has effects visible outside this system. API summary: Perform form filling action.
• update_document_messagesVisible to othersUpdate an existing message identified by file id. Has effects visible outside this system. API summary: Update a comment.
• update_document_ordersVisible to othersUpdate an existing order identified by file id. Has effects visible outside this system. API summary: Set file order.
• update_document_sessionChanges dataUpdate an existing document identified by file id. API summary: Create the editing session.
• update_documentsVisible to othersUpdate an existing document. Has effects visible outside this system. API summary: Update the IP restriction settings.
• update_documents_change_version_historyVisible to othersUpdate an existing document identified by file id. Has effects visible outside this system. API summary: Change version history.
• update_documents_save_editing_file_from_formVisible to othersUpdate an existing document identified by file id. Has effects visible outside this system. API summary: Save file edits.
• update_documents_set_file_security_infoVisible to othersUpdate an existing document identified by file id. Has effects visible outside this system. API summary: Share a file.
• update_downloadtargzsVisible to othersUpdate an existing downloadtargz. Has effects visible outside this system. API summary: Change the archive format (using body parameters).
• update_emailactivationsDeletesUpdate an existing emailactivation. Destructive action; may require approval. API summary: Update the email activation settings.
• update_emptytrashesVisible to othersUpdate an existing emptytrash. Has effects visible outside this system. API summary: Empty the "Trash" folder.
• update_externalsVisible to othersUpdate an existing external. Has effects visible outside this system. API summary: Change the external sharing ability.
• update_externalsocialmediaVisible to othersUpdate an existing externalsocialmedia. Has effects visible outside this system. API summary: Change the external sharing ability on social networks.
• update_folder_linksVisible to othersUpdate an existing link identified by folder id. Has effects visible outside this system. API summary: Set the folder external link.
• update_folder_ordersVisible to othersUpdate an existing order identified by folder id. Has effects visible outside this system. API summary: Set folder order.
• update_folder_sharesVisible to othersUpdate an existing share identified by folder id. Has effects visible outside this system. API summary: Share a folder.
• update_forcesavesVisible to othersUpdate an existing forcesave. Has effects visible outside this system. API summary: Change the forcesaving ability.
• update_groupChanges dataUpdate an existing group identified by group id. API summary: Update a group.
• update_group_managersVisible to othersUpdate an existing manager identified by group id. Has effects visible outside this system. API summary: Set a group manager.
• update_group_userChanges dataUpdate an existing user identified by to id. API summary: Move group members.
• update_group_usersVisible to othersUpdate an existing user identified by group id. Has effects visible outside this system. API summary: Add group members.
• update_hideconfirmcanceloperationsVisible to othersUpdate an existing hideconfirmcanceloperation. Has effects visible outside this system. API summary: Hide confirmation dialog when canceling operations.
• update_hideconfirmconvertsVisible to othersUpdate an existing hideconfirmconvert. Has effects visible outside this system. API summary: Hide the confirmation dialog when converting.
• update_hideconfirmroomlifetimesVisible to othersUpdate an existing hideconfirmroomlifetime. Has effects visible outside this system. API summary: Hide confirmation dialog when changing room lifetime settings.
• update_iprestrictionsVisible to othersUpdate an existing iprestriction. Has effects visible outside this system. API summary: Update the IP restrictions.
• update_keepnewfilenamesVisible to othersUpdate an existing keepnewfilename. Has effects visible outside this system. API summary: Ask a new file name.
• update_keyChanges dataUpdate an existing key identified by key id. API summary: Update an API key.
• update_loginsettingsVisible to othersUpdate an existing loginsetting. Has effects visible outside this system. API summary: Update the login settings.
• update_logoutChanges dataUpdate an existing logout identified by login event id. API summary: Log out from the connection.
• update_logoutallChanges dataUpdate an existing logoutall identified by user id. API summary: Log out for the user by ID.
• update_logoutallchangepasswordsMoves moneyUpdate an existing logoutallchangepassword. Financial or irreversible action; may require approval. API summary: Log out and change password.
• update_logoutallexceptthisVisible to othersUpdate an existing logoutallexceptthi. Has effects visible outside this system. API summary: Log out from all connections except the current one.
• update_markasreadsVisible to othersUpdate an existing markasread. Has effects visible outside this system. API summary: Mark as read.
• update_openeditorinsametabsVisible to othersUpdate an existing openeditorinsametab. Has effects visible outside this system. API summary: Open document in the same browser tab.
• update_ordersVisible to othersUpdate an existing order. Has effects visible outside this system. API summary: Set order of files.
• update_passwordsMoves moneyUpdate an existing password. Financial or irreversible action; may require approval. API summary: Set the password settings.
• update_paymentsVisible to othersUpdate an existing payment. Has effects visible outside this system. API summary: Get the payment page URL.
• update_payments_calculate_wallet_paymentVisible to othersUpdate an existing payment. Has effects visible outside this system. API summary: Calculate the wallet payment amount.
• update_productsVisible to othersUpdate an existing product. Has effects visible outside this system. API summary: Set a product administrator.
• update_publicsVisible to othersUpdate an existing public. Has effects visible outside this system. API summary: Set public settings.
• update_resetquotaVisible to othersUpdate an existing resetquotum. Has effects visible outside this system. API summary: Reset a user quota limit.
• update_retriesMoves moneyUpdate an existing retry. Financial or irreversible action; may require approval. API summary: Retry webhooks.
• update_roomChanges dataUpdate a room's title, tags, color, quota or download setting; pass the room ID in `user_id`.
• update_roomquotaVisible to othersUpdate an existing roomquotum. Has effects visible outside this system. API summary: Change the room quota limit.
• update_securitiesVisible to othersUpdate an existing security. Has effects visible outside this system. API summary: Set the module security settings.
• update_sharesVisible to othersUpdate an existing share. Has effects visible outside this system. API summary: Set the sharing rights.
• update_storagesVisible to othersUpdate an existing storage. Has effects visible outside this system. API summary: Update a storage.
• update_storeforcesavesVisible to othersUpdate an existing storeforcesave. Has effects visible outside this system. API summary: Change the ability to store the forcesaved files.
• update_storeoriginalsVisible to othersUpdate an existing storeoriginal. Has effects visible outside this system. API summary: Change the ability to upload original formats.
• update_suspendsVisible to othersUpdate an existing suspend. Has effects visible outside this system. API summary: Deactivate a portal.
• update_taskChanges dataUpdate an existing task identified by task id. API summary: Finish active operations.
• update_tasksVisible to othersUpdate an existing task. Has effects visible outside this system. API summary: Terminate the data reassignment.
• update_tenantsVisible to othersUpdate an existing tenant. Has effects visible outside this system. API summary: Save the tenant quota settings.
• update_tfaappnewcodesVisible to othersUpdate an existing tfaappnewcode. Has effects visible outside this system. API summary: Update the TFA codes.
• update_tfaappsVisible to othersUpdate an existing tfaapp. Has effects visible outside this system. API summary: Update the TFA settings.
• update_tfaappwithlinksVisible to othersUpdate an existing tfaappwithlink. Has effects visible outside this system. API summary: Get a confirmation email for updating TFA settings.
• update_the_portal_ownerVisible to othersUpdate an existing document. Has effects visible outside this system. API summary: Update the portal owner.
• update_themesVisible to othersUpdate an existing theme. Has effects visible outside this system. API summary: Change the portal theme.
• update_thirdpartiesVisible to othersUpdate an existing thirdparty. Has effects visible outside this system. API summary: Change the third-party settings access.
• update_thirdpartyChanges dataUpdate an existing thirdparty identified by thirdparty id. API summary: Create a third-party room.
• update_updateifexistsVisible to othersUpdate an existing updateifexist. Has effects visible outside this system. API summary: Update a file version if it exists.
• update_updatesVisible to othersUpdate an existing update. Has effects visible outside this system. API summary: Update the payment quantity.
• update_updatewalletsVisible to othersUpdate an existing updatewallet. Has effects visible outside this system. API summary: Update the wallet payment quantity.
• update_userChanges dataUpdate an existing user identified by status. API summary: Change a user status.
• update_user_linksVisible to othersUpdate an existing link identified by room id. Has effects visible outside this system. API summary: Set the room external or invitation link.
• update_user_pinsVisible to othersUpdate an existing pin identified by room id. Has effects visible outside this system. API summary: Pin a room.
• update_user_reordersVisible to othersUpdate an existing reorder identified by room id. Has effects visible outside this system. API summary: Reorder the room.
• update_user_sharesVisible to othersUpdate an existing share identified by room id. Has effects visible outside this system. API summary: Set the room access rights.
• update_user_tagsVisible to othersUpdate an existing tag identified by room id. Has effects visible outside this system. API summary: Add the room tags.
• update_user_unpinsVisible to othersUpdate an existing unpin identified by room id. Has effects visible outside this system. API summary: Unpin a room.
• update_user_update_user_typeChanges dataUpdate an existing user identified by type. API summary: Change a user type.
• update_userquotaVisible to othersUpdate an existing userquotum. Has effects visible outside this system. API summary: Change a user quota limit.
• update_usersVisible to othersUpdate an existing user. Has effects visible outside this system. API summary: Update user invitation settings.
• update_users_resend_user_invitesDeletesUpdate an existing user. Destructive action; may require approval. API summary: Resend activation emails.
• update_webhook_retriesMoves moneyUpdate an existing retry identified by webhook id. Financial or irreversible action; may require approval. API summary: Retry a webhook.
• update_webhooksMoves moneyUpdate an existing webhook. Financial or irreversible action; may require approval. API summary: Update a webhook.
• update_webpluginChanges dataUpdate an existing webplugin identified by name. API summary: Update a web plugin.
• upload_documentChanges dataUpload a document (folder id). API summary: Upload a file.
• upload_initChanges dataUpload a init (migrator name). API summary: Upload and initialize migration.
• upload_logoChanges dataUpload a logo. API summary: Upload a room logo image.
• upload_myChanges dataUpload a my. API summary: Upload a file to the "My documents" section.
• upload_photoChanges dataUpload a photo (userid). API summary: Upload a user photo.

Questions