Skip to content

ONLYOFFICE/docspace-api-sdk-typescript

BranchesTags

Repository files navigation

@onlyoffice/docspace-api-sdk

The ONLYOFFICE DocSpace SDK for TypeScript is a library that provides tools for integrating and managing DocSpace features within your applications. It simplifies interaction with the DocSpace API by offering ready-to-use methods and models.

For more information, please visit https://helpdesk.onlyoffice.com/hc/en-us

Building

To build and compile the TypeScript sources to JavaScript, use the following commands:

npm install
npm run build

Consuming

To use the SDK in your project, navigate to the root folder of your consuming project and run one of the following commands:

From published package (recommended)

npm install @onlyoffice/docspace-api-sdk --save

From local build (not recommended)

npm install PATH_TO_GENERATED_PACKAGE --save

Getting Started

Please follow the building instruction and execute the following TS code:

import { Configuration, ApiKeysApi } from '@onlyoffice/docspace-api-sdk';

const config = new Configuration ({
    basePath: "https://your-docspace.onlyoffice.com",
    accessToken: "YOUR ACCESS TOKEN",
});

const apiInstance = new ApiKeysApi(config);

const opts: any = {
  'createApiKeyRequestDto':  // 
};
try {
    const result = await apiInstance.createApiKey(
      opts
    );
    console.log('API called successfully. Returned data: ', result.data);
  } catch (error) {
    console.error(error);
}

Documentation For Authorization

Authentication schemes defined for the API:

asc_auth_key

  • Type: API key
  • API key parameter name: asc_auth_key
  • Location: Cookie

Basic

  • Type: HTTP basic authentication

Bearer

  • Type: Bearer authentication (JWT)

ApiKeyBearer

  • Type: API key
  • API key parameter name: ApiKeyBearer
  • Location: HTTP header

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: {{authBaseUrl}}/oauth2/authorize
  • Token Url: {{authBaseUrl}}/oauth2/token
  • Scopes:
  • read: Read access to protected resources
  • write: Write access to protected resources

OpenId

  • Type: OpenId Connect
  • OpenId Connect URL: {{authBaseUrl}}/.well-known/openid-configuration

x-signature

  • Type: API key
  • API key parameter name: x-signature
  • Location: Cookie

Documentation for API Endpoints

All URIs are relative to https://your-docspace.onlyoffice.com

API Endoints tables:

ApiKeys
Method HTTP request Description
ApiKeysApi
createApiKey POST /api/2.0/keys Create a user API key
deleteApiKey DELETE /api/2.0/keys/{keyId} Delete a user API key
getAllPermissions GET /api/2.0/keys/permissions Get API key permissions
getApiKey GET /api/2.0/keys/@self Get current user\'s API key
getApiKeys GET /api/2.0/keys Get current user\'s API keys
updateApiKey PUT /api/2.0/keys/{keyId} Update an API key
Authentication
Method HTTP request Description
AuthenticationApi
authenticateMe POST /api/2.0/authentication Authenticate a user
authenticateMeFromBodyWithCode POST /api/2.0/authentication/{code} Authenticate a user by code
checkConfirm POST /api/2.0/authentication/confirm Open confirmation email URL
getIsAuthentificated GET /api/2.0/authentication Check authentication
logout POST /api/2.0/authentication/logout Log out
saveMobilePhone POST /api/2.0/authentication/setphone Set a mobile phone
sendSmsCode POST /api/2.0/authentication/sendsms Send SMS code
Backup
Method HTTP request Description
BackupApi
createBackupSchedule POST /api/2.0/backup/createbackupschedule Create the backup schedule
deleteBackup DELETE /api/2.0/backup/deletebackup/{id} Delete the backup
deleteBackupHistory DELETE /api/2.0/backup/deletebackuphistory Delete the backup history
deleteBackupSchedule DELETE /api/2.0/backup/deletebackupschedule Delete the backup schedule
getBackupHistory GET /api/2.0/backup/getbackuphistory Get the backup history
getBackupProgress GET /api/2.0/backup/getbackupprogress Get the backup progress
getBackupSchedule GET /api/2.0/backup/getbackupschedule Get the backup schedule
getBackupsCount GET /api/2.0/backup/getbackupscount Get the number of backups
getBackupsServiceState GET /api/2.0/backup/getservicestate Get the backup service state
getRestoreProgress GET /api/2.0/backup/getrestoreprogress Get the restoring progress
startBackup POST /api/2.0/backup/startbackup Start the backup
startBackupRestore POST /api/2.0/backup/startrestore Start the restoring process
Capabilities
Method HTTP request Description
CapabilitiesApi
getPortalCapabilities GET /api/2.0/capabilities Get portal capabilities
Files
Method HTTP request Description
FilesApi
addFileToRecent POST /api/2.0/files/file/{fileId}/recent Add a file to the Recent section
addTemplates POST /api/2.0/files/templates Add template files
changeVersionHistory PUT /api/2.0/files/file/{fileId}/history Change version history
checkFillFormDraft POST /api/2.0/files/masterform/{fileId}/checkfillformdraft Check the form draft filling
copyFileAs POST /api/2.0/files/file/{fileId}/copyas Copy a file
createEditSession POST /api/2.0/files/file/{fileId}/edit_session Create the editing session
createFile POST /api/2.0/files/{folderId}/file Create a file
createFileInMyDocuments POST /api/2.0/files/@my/file Create a file in the My documents section
createFilePrimaryExternalLink POST /api/2.0/files/file/{id}/link Create primary external link
createHtmlFile POST /api/2.0/files/{folderId}/html Create an HTML file
createHtmlFileInMyDocuments POST /api/2.0/files/@my/html Create an HTML file in the My documents section
createTextFile POST /api/2.0/files/{folderId}/text Create a text file
createTextFileInMyDocuments POST /api/2.0/files/@my/text Create a text file in the My documents section
createThumbnails POST /api/2.0/files/thumbnails Create file thumbnails
deleteFile DELETE /api/2.0/files/file/{fileId} Delete a file
deleteRecent DELETE /api/2.0/files/recent Delete recent files
deleteTemplates DELETE /api/2.0/files/templates Delete template files
getAllFormRoles GET /api/2.0/files/file/{fileId}/formroles Get form roles
getEditDiffUrl GET /api/2.0/files/file/{fileId}/edit/diff Get changes URL
getEditHistory GET /api/2.0/files/file/{fileId}/edit/history Get version history
getFileHistory GET /api/2.0/files/file/{fileId}/log Get file history
getFileInfo GET /api/2.0/files/file/{fileId} Get file information
getFileLinks GET /api/2.0/files/file/{id}/links Get file external links
getFilePrimaryExternalLink GET /api/2.0/files/file/{id}/link Get primary external link
getFileVersionInfo GET /api/2.0/files/file/{fileId}/history Get file versions
getFillResult GET /api/2.0/files/file/fillresult Get form-filling result
getPresignedFileUri GET /api/2.0/files/file/{fileId}/presigned Get file download link asynchronously
getPresignedUri GET /api/2.0/files/file/{fileId}/presigneduri Get file download link
getProtectedFileUsers GET /api/2.0/files/file/{fileId}/protectusers Get users access rights to the protected file
getReferenceData POST /api/2.0/files/file/referencedata Get reference data
isFormPDF GET /api/2.0/files/file/{fileId}/isformpdf Check the PDF file
lockFile PUT /api/2.0/files/file/{fileId}/lock Lock a file
manageFormFilling PUT /api/2.0/files/file/{fileId}/manageformfilling Perform form filling action
openEditFile GET /api/2.0/files/file/{fileId}/openedit Open a file configuration
restoreFileVersion POST /api/2.0/files/file/{fileId}/restoreversion Restore a file version
saveEditingFileFromForm PUT /api/2.0/files/file/{fileId}/saveediting Save file edits
saveFileAsPdf POST /api/2.0/files/file/{id}/saveaspdf Save a file as PDF
saveFormRoleMapping POST /api/2.0/files/file/{fileId}/formrolemapping Save form role mapping
setCustomFilterTag PUT /api/2.0/files/file/{fileId}/customfilter Set the Custom Filter editing mode
setFileExternalLink PUT /api/2.0/files/file/{id}/links Set an external link
setFileOrder PUT /api/2.0/files/{fileId}/order Set file order
setFilesOrder PUT /api/2.0/files/order Set order of files
startEditFile POST /api/2.0/files/file/{fileId}/startedit Start file editing
startFillingFile PUT /api/2.0/files/file/{fileId}/startfilling Start file filling
toggleFileFavorite GET /api/2.0/files/favorites/{fileId} Change the file favorite status
trackEditFile GET /api/2.0/files/file/{fileId}/trackeditfile Track file editing
updateFile PUT /api/2.0/files/file/{fileId} Update a file
FoldersApi
checkUpload POST /api/2.0/files/{folderId}/upload/check Check file uploads
createFolder POST /api/2.0/files/folder/{folderId} Create a folder
createFolderPrimaryExternalLink POST /api/2.0/files/folder/{id}/link Create primary external link
createReportFolderHistory POST /api/2.0/files/folder/{folderId}/log/report Generates folder history
deleteFolder DELETE /api/2.0/files/folder/{folderId} Delete a folder
getFavoritesFolder GET /api/2.0/files/@favorites Get the Favorites section
getFilesUsedSpace GET /api/2.0/files/filesusedspace Get used space of files
getFolder GET /api/2.0/files/{folderId}/formfilter Get folder form filter
getFolderByFolderId GET /api/2.0/files/{folderId} Get a folder by ID
getFolderHistory GET /api/2.0/files/folder/{folderId}/log Get folder history
getFolderInfo GET /api/2.0/files/folder/{folderId} Get folder information
getFolderLinks GET /api/2.0/files/folder/{id}/links Get the folder links
getFolderPath GET /api/2.0/files/folder/{folderId}/path Get the folder path
getFolderPrimaryExternalLink GET /api/2.0/files/folder/{id}/link Get primary external link
getFolders GET /api/2.0/files/{folderId}/subfolders Get subfolders
getMyFolder GET /api/2.0/files/@my Get the My documents section
getNewFolderItems GET /api/2.0/files/{folderId}/news Get new folder items
getPrivacyFolder GET /api/2.0/files/@privacy Get the Private Room section
getRecentFolder GET /api/2.0/files/recent Get the Recent section
getRootFolders GET /api/2.0/files/@root Get filtered sections
getTrashFolder GET /api/2.0/files/@trash Get the Trash section
insertFile POST /api/2.0/files/{folderId}/insert Insert a file
insertFileToMyFromBody POST /api/2.0/files/@my/insert Insert a file to the My documents section
renameFolder PUT /api/2.0/files/folder/{folderId} Rename a folder
setFolderOrder PUT /api/2.0/files/folder/{folderId}/order Set folder order
setFolderPrimaryExternalLink PUT /api/2.0/files/folder/{id}/links Set the folder external link
uploadFile POST /api/2.0/files/{folderId}/upload Upload a file
uploadFileToMy POST /api/2.0/files/@my/upload Upload a file to the My documents section
OperationsApi
addFavorites POST /api/2.0/files/favorites Add favorite files and folders
bulkDownload PUT /api/2.0/files/fileops/bulkdownload Bulk download
checkConversionStatus GET /api/2.0/files/file/{fileId}/checkconversion Get conversion status
checkMoveOrCopyBatchItems GET /api/2.0/files/fileops/move Move or copy files to a folder
checkMoveOrCopyDestFolder GET /api/2.0/files/fileops/checkdestfolder Check for moving or copying files to a folder
copyBatchItems PUT /api/2.0/files/fileops/copy Copy to the folder
createUploadSession POST /api/2.0/files/{folderId}/upload/create_session Chunked upload
deleteBatchItems PUT /api/2.0/files/fileops/delete Delete files and folders
deleteFavoritesFromBody DELETE /api/2.0/files/favorites Delete favorite files and folders (using body parameters)
deleteFileVersions PUT /api/2.0/files/fileops/deleteversion Delete file versions
duplicateBatchItems PUT /api/2.0/files/fileops/duplicate Duplicate files and folders
emptyTrash PUT /api/2.0/files/fileops/emptytrash Empty the Trash folder
getOperationStatuses GET /api/2.0/files/fileops Get active file operations
getOperationStatusesByType GET /api/2.0/files/fileops/{operationType} Get file operation statuses
markAsRead PUT /api/2.0/files/fileops/markasread Mark as read
moveBatchItems PUT /api/2.0/files/fileops/move Move or copy to a folder
startFileConversion PUT /api/2.0/files/file/{fileId}/checkconversion Start file conversion
terminateTasks PUT /api/2.0/files/fileops/terminate/{id} Finish active operations
updateFileComment PUT /api/2.0/files/file/{fileId}/comment Update a comment
FilesQuotaApi
resetRoomQuota PUT /api/2.0/files/rooms/resetquota Reset the room quota limit
updateRoomsQuota PUT /api/2.0/files/rooms/roomquota Change the room quota limit
FilesSettingsApi
changeAccessToThirdparty PUT /api/2.0/files/thirdparty Change the third-party settings access
changeAutomaticallyCleanUp PUT /api/2.0/files/settings/autocleanup Update the trash bin auto-clearing setting
changeDefaultAccessRights PUT /api/2.0/files/settings/dafaultaccessrights Change the default access rights
changeDeleteConfirm PUT /api/2.0/files/changedeleteconfrim Confirm the file deletion
changeDownloadZipFromBody PUT /api/2.0/files/settings/downloadtargz Change the archive format (using body parameters)
checkDocServiceUrl PUT /api/2.0/files/docservice Check the document service URL
displayFileExtension PUT /api/2.0/files/displayfileextension Display a file extension
displayRecent PUT /api/2.0/files/displayrecent Display the Recent folder
externalShare PUT /api/2.0/files/settings/external Change the external sharing ability
externalShareSocialMedia PUT /api/2.0/files/settings/externalsocialmedia Change the external sharing ability on social networks
forcesave PUT /api/2.0/files/forcesave Change the forcesaving ability
getAutomaticallyCleanUp GET /api/2.0/files/settings/autocleanup Get the trash bin auto-clearing setting
getDocServiceUrl GET /api/2.0/files/docservice Get the document service URL
getFilesModule GET /api/2.0/files/info Get the Documents information
getFilesSettings GET /api/2.0/files/settings Get file settings
hideConfirmCancelOperation PUT /api/2.0/files/hideconfirmcanceloperation Hide confirmation dialog when canceling operations
hideConfirmConvert PUT /api/2.0/files/hideconfirmconvert Hide the confirmation dialog when converting
hideConfirmRoomLifetime PUT /api/2.0/files/hideconfirmroomlifetime Hide confirmation dialog when changing room lifetime settings
isAvailablePrivacyRoomSettings GET /api/2.0/files/@privacy/available Check the Private Room availability
keepNewFileName PUT /api/2.0/files/keepnewfilename Ask a new file name
setOpenEditorInSameTab PUT /api/2.0/files/settings/openeditorinsametab Open document in the same browser tab
storeForcesave PUT /api/2.0/files/storeforcesave Change the ability to store the forcesaved files
storeOriginal PUT /api/2.0/files/storeoriginal Change the ability to upload original formats
updateFileIfExist PUT /api/2.0/files/updateifexist Update a file version if it exists
SharingApi
applyExternalSharePassword POST /api/2.0/files/share/{key}/password Apply external data password
changeFileOwner POST /api/2.0/files/owner Change the file owner
getExternalShareData GET /api/2.0/files/share/{key} Get the external data
getFileSecurityInfo GET /api/2.0/files/file/{id}/share Get the shared file information
getFolderSecurityInfo GET /api/2.0/files/folder/{id}/share Get the shared folder information
getGroupsMembersWithFileSecurity GET /api/2.0/files/file/{fileId}/group/{groupId}/share Get file group members with security information
getGroupsMembersWithFolderSecurity GET /api/2.0/files/folder/{folderId}/group/{groupId}/share Get folder group members with security information
getSecurityInfo POST /api/2.0/files/share Get the sharing rights
getSharedUsers GET /api/2.0/files/file/{fileId}/sharedusers Get user access rights by file ID
removeSecurityInfo DELETE /api/2.0/files/share Remove the sharing rights
sendEditorNotify POST /api/2.0/files/file/{fileId}/sendeditornotify Send the mention message
setFileSecurityInfo PUT /api/2.0/files/file/{fileId}/share Share a file
setFolderSecurityInfo PUT /api/2.0/files/folder/{folderId}/share Share a folder
setSecurityInfo PUT /api/2.0/files/share Set the sharing rights
ThirdPartyIntegrationApi
deleteThirdParty DELETE /api/2.0/files/thirdparty/{providerId} Remove a third-party account
getAllProviders GET /api/2.0/files/thirdparty/providers Get all providers
getBackupThirdPartyAccount GET /api/2.0/files/thirdparty/backup Get a third-party account backup
getCapabilities GET /api/2.0/files/thirdparty/capabilities Get providers
getCommonThirdPartyFolders GET /api/2.0/files/thirdparty/common Get the common third-party services
getThirdPartyAccounts GET /api/2.0/files/thirdparty Get the third-party accounts
saveThirdParty POST /api/2.0/files/thirdparty Save a third-party account
saveThirdPartyBackup POST /api/2.0/files/thirdparty/backup Save a third-party account backup
Group
Method HTTP request Description
GroupApi
addGroup POST /api/2.0/group Add a new group
addMembersTo PUT /api/2.0/group/{id}/members Add group members
deleteGroup DELETE /api/2.0/group/{id} Delete a group
getGroup GET /api/2.0/group/{id} Get a group
getGroupByUserId GET /api/2.0/group/user/{userid} Get user groups
getGroups GET /api/2.0/group Get groups
moveMembersTo PUT /api/2.0/group/{fromId}/members/{toId} Move group members
removeMembersFrom DELETE /api/2.0/group/{id}/members Remove group members
setGroupManager PUT /api/2.0/group/{id}/manager Set a group manager
setMembersTo POST /api/2.0/group/{id}/members Replace group members
updateGroup PUT /api/2.0/group/{id} Update a group
SearchApi
getGroupsWithFilesShared GET /api/2.0/group/file/{id} Get groups with file sharing settings
getGroupsWithFoldersShared GET /api/2.0/group/folder/{id} Get groups with folder sharing settings
getGroupsWithRoomsShared GET /api/2.0/group/room/{id} Get groups with room sharing settings
Migration
Method HTTP request Description
MigrationApi
cancelMigration POST /api/2.0/migration/cancel Cancel migration
clearMigration POST /api/2.0/migration/clear Clear migration
finishMigration POST /api/2.0/migration/finish Finish migration
getMigrationLogs GET /api/2.0/migration/logs Get migration logs
getMigrationStatus GET /api/2.0/migration/status Get migration status
listMigrations GET /api/2.0/migration/list Get migrations
startMigration POST /api/2.0/migration/migrate Start migration
uploadAndInitializeMigration POST /api/2.0/migration/init/{migratorName} Upload and initialize migration
OAuth20
Method HTTP request Description
OAuth20AuthorizationApi
authorizeOAuth GET /oauth2/authorize OAuth2 authorization endpoint
exchangeToken POST /oauth2/token OAuth2 token endpoint
submitConsent POST /oauth2/authorize OAuth2 consent endpoint
ClientManagementApi
changeActivation PATCH /api/2.0/clients/{clientId}/activation Change the client activation status
createClient POST /api/2.0/clients Create a new OAuth2 client
deleteClient DELETE /api/2.0/clients/{clientId} Delete an OAuth2 client
regenerateSecret PATCH /api/2.0/clients/{clientId}/regenerate Regenerate the client secret
revokeUserClient DELETE /api/2.0/clients/{clientId}/revoke Revoke client consent
updateClient PUT /api/2.0/clients/{clientId} Update an existing OAuth2 client
ClientQueryingApi
getClient GET /api/2.0/clients/{clientId} Get client details
getClientInfo GET /api/2.0/clients/{clientId}/info Get detailed client information
getClients GET /api/2.0/clients Get clients
getClientsInfo GET /api/2.0/clients/info Get detailed information of clients
getConsents GET /api/2.0/clients/consents Get user consents
getPublicClientInfo GET /api/2.0/clients/{clientId}/public/info Get public client information
ScopeManagementApi
getScopes GET /api/2.0/scopes Get available OAuth2 scopes
People
Method HTTP request Description
GuestsApi
approveGuestShareLink POST /api/2.0/people/guests/share/approve Approve a guest sharing link
deleteGuests DELETE /api/2.0/people/guests Delete guests
PasswordApi
changeUserPassword PUT /api/2.0/people/{userid}/password Change a user password
sendUserPassword POST /api/2.0/people/password Remind a user password
PhotosApi
createMemberPhotoThumbnails POST /api/2.0/people/{userid}/photo/thumbnails Create photo thumbnails
deleteMemberPhoto DELETE /api/2.0/people/{userid}/photo Delete a user photo
getMemberPhoto GET /api/2.0/people/{userid}/photo Get a user photo
updateMemberPhoto PUT /api/2.0/people/{userid}/photo Update a user photo
uploadMemberPhoto POST /api/2.0/people/{userid}/photo Upload a user photo
ProfilesApi
addMember POST /api/2.0/people Add a user
deleteMember DELETE /api/2.0/people/{userid} Delete a user
deleteProfile DELETE /api/2.0/people/@self Delete my profile
getAllProfiles GET /api/2.0/people Get profiles
getClaims GET /api/2.0/people/tokendiagnostics Get user claims
getProfileByEmail GET /api/2.0/people/email Get a profile by user email
getProfileByUserId GET /api/2.0/people/{userid} Get a profile by user ID
getSelfProfile GET /api/2.0/people/@self Get my profile
inviteUsers POST /api/2.0/people/invite Invite users
removeUsers PUT /api/2.0/people/delete Delete users
resendUserInvites PUT /api/2.0/people/invite Resend activation emails
sendEmailChangeInstructions POST /api/2.0/people/email Send instructions to change email
updateMember PUT /api/2.0/people/{userid} Update a user
updateMemberCulture PUT /api/2.0/people/{userid}/culture Update a user culture code
PeopleQuotaApi
resetUsersQuota PUT /api/2.0/people/resetquota Reset a user quota limit
updateUserQuota PUT /api/2.0/people/userquota Change a user quota limit
PeopleSearchApi
getAccountsEntriesWithFilesShared GET /api/2.0/accounts/file/{id}/search Get account entries with file sharing settings
getAccountsEntriesWithFoldersShared GET /api/2.0/accounts/folder/{id}/search Get account entries with folder sharing settings
getAccountsEntriesWithRoomsShared GET /api/2.0/accounts/room/{id}/search Get account entries
getSearch GET /api/2.0/people/@search/{query} Search users
getSimpleByFilter GET /api/2.0/people/simple/filter Search users by extended filter
getUsersWithFilesShared GET /api/2.0/people/file/{id} Get users with file sharing settings
getUsersWithFoldersShared GET /api/2.0/people/folder/{id} Get users with folder sharing settings
getUsersWithRoomShared GET /api/2.0/people/room/{id} Get users with room sharing settings
searchUsersByExtendedFilter GET /api/2.0/people/filter Search users with detailed information by extended filter
searchUsersByQuery GET /api/2.0/people/search Search users (using query parameters)
searchUsersByStatus GET /api/2.0/people/status/{status}/search Search users by status filter
ThemeApi
changePortalTheme PUT /api/2.0/people/theme Change the portal theme
getPortalTheme GET /api/2.0/people/theme Get the portal theme
ThirdPartyAccountsApi
getThirdPartyAuthProviders GET /api/2.0/people/thirdparty/providers Get third-party accounts
linkThirdPartyAccount PUT /api/2.0/people/thirdparty/linkaccount Link a third-pary account
signupThirdPartyAccount POST /api/2.0/people/thirdparty/signup Create a third-pary account
unlinkThirdPartyAccount DELETE /api/2.0/people/thirdparty/unlinkaccount Unlink a third-pary account
UserDataApi
getDeletePersonalFolderProgress GET /api/2.0/people/delete/personal/progress Get the progress of deleting the personal folder
getReassignProgress GET /api/2.0/people/reassign/progress/{userid} Get the reassignment progress
getRemoveProgress GET /api/2.0/people/remove/progress/{userid} Get the deletion progress
necessaryReassign GET /api/2.0/people/reassign/necessary Check data for reassignment need
sendInstructionsToDelete PUT /api/2.0/people/self/delete Send the deletion instructions
startDeletePersonalFolder POST /api/2.0/people/delete/personal/start Delete the personal folder
startReassign POST /api/2.0/people/reassign/start Start the data reassignment
startRemove POST /api/2.0/people/remove/start Start the data deletion
terminateReassign PUT /api/2.0/people/reassign/terminate Terminate the data reassignment
terminateRemove PUT /api/2.0/people/remove/terminate Terminate the data deletion
UserStatusApi
getByStatus GET /api/2.0/people/status/{status} Get profiles by status
updateUserActivationStatus PUT /api/2.0/people/activationstatus/{activationstatus} Set an activation status to the users
updateUserStatus PUT /api/2.0/people/status/{status} Change a user status
UserTypeApi
getUserTypeUpdateProgress GET /api/2.0/people/type/progress/{userid} Get the progress of updating user type
starUserTypetUpdate POST /api/2.0/people/type Start updating user type
terminateUserTypeUpdate PUT /api/2.0/people/type/terminate Terminate updating user type
updateUserType PUT /api/2.0/people/type/{type} Change a user type
Portal
Method HTTP request Description
PortalGuestsApi
getGuestSharingLink GET /api/2.0/people/guests/{userid}/share Get a guest sharing link
PaymentApi
calculateWalletPayment PUT /api/2.0/portal/payment/calculatewallet Calculate the wallet payment amount
changeTenantWalletServiceState POST /api/2.0/portal/payment/servicestate Change wallet service state
createCustomerOperationsReport POST /api/2.0/portal/payment/customer/operationsreport Start the customer operations report generation
getCheckoutSetupUrl GET /api/2.0/portal/payment/chechoutsetupurl Get the checkout setup page URL
getCustomerBalance GET /api/2.0/portal/payment/customer/balance Get the customer balance
getCustomerInfo GET /api/2.0/portal/payment/customerinfo Get the customer information
getCustomerOperations GET /api/2.0/portal/payment/customer/operations Get the customer operations
getCustomerOperationsReport GET /api/2.0/portal/payment/customer/operationsreport Get the status of the customer operations report generation
getPaymentAccount GET /api/2.0/portal/payment/account Get the payment account
getPaymentCurrencies GET /api/2.0/portal/payment/currencies Get currencies
getPaymentQuotas GET /api/2.0/portal/payment/quotas Get quotas
getPaymentUrl PUT /api/2.0/portal/payment/url Get the payment page URL
getPortalPrices GET /api/2.0/portal/payment/prices Get prices
getQuotaPaymentInformation GET /api/2.0/portal/payment/quota Get quota payment information
getTenantWalletServiceSettings GET /api/2.0/portal/payment/servicessettings Get wallet services settings
getTenantWalletSettings GET /api/2.0/portal/payment/topupsettings Get wallet auto top-up settings
getWalletService GET /api/2.0/portal/payment/walletservice Get wallet service
getWalletServices GET /api/2.0/portal/payment/walletservices Get wallet services
sendPaymentRequest POST /api/2.0/portal/payment/request Send a payment request
setTenantWalletSettings POST /api/2.0/portal/payment/topupsettings Set wallet auto top-up settings
terminateCustomerOperationsReport DELETE /api/2.0/portal/payment/customer/operationsreport Terminate the customer operations report generation
topUpDeposit POST /api/2.0/portal/payment/deposit Put money on deposit
updatePayment PUT /api/2.0/portal/payment/update Update the payment quantity
updateWalletPayment PUT /api/2.0/portal/payment/updatewallet Update the wallet payment quantity
QuotaApi
getPortalQuota GET /api/2.0/portal/quota Get a portal quota
getPortalTariff GET /api/2.0/portal/tariff Get a portal tariff
getPortalUsedSpace GET /api/2.0/portal/usedspace Get the portal used space
getRightQuota GET /api/2.0/portal/quota/right Get the recommended quota
SettingsApi
continuePortal PUT /api/2.0/portal/continue Restore a portal
deletePortal DELETE /api/2.0/portal/delete Delete a portal
getPortalInformation GET /api/2.0/portal Get a portal
getPortalPath GET /api/2.0/portal/path Get a path to the portal
sendDeleteInstructions POST /api/2.0/portal/delete Send removal instructions
sendSuspendInstructions POST /api/2.0/portal/suspend Send suspension instructions
suspendPortal PUT /api/2.0/portal/suspend Deactivate a portal
UsersApi
getInvitationLink GET /api/2.0/portal/users/invite/{employeeType} Get an invitation link
getPortalUsersCount GET /api/2.0/portal/userscount Get a number of portal users
getUserById GET /api/2.0/portal/users/{userID} Get a user by ID
markGiftMessageAsRead POST /api/2.0/portal/present/mark Mark a gift message as read
sendCongratulations POST /api/2.0/portal/sendcongratulations Send congratulations
Rooms
Method HTTP request Description
RoomsApi
addRoomTags PUT /api/2.0/files/rooms/{id}/tags Add the room tags
archiveRoom PUT /api/2.0/files/rooms/{id}/archive Archive a room
changeRoomCover POST /api/2.0/files/rooms/{id}/cover Change the room cover
createRoom POST /api/2.0/files/rooms Create a room
createRoomFromTemplate POST /api/2.0/files/rooms/fromtemplate Create a room from the template
createRoomLogo POST /api/2.0/files/rooms/{id}/logo Create a room logo
createRoomTag POST /api/2.0/files/tags Create a room tag
createRoomTemplate POST /api/2.0/files/roomtemplate Start creating room template
createRoomThirdParty POST /api/2.0/files/rooms/thirdparty/{id} Create a third-party room
deleteCustomTags DELETE /api/2.0/files/tags Delete the custom room tags
deleteRoom DELETE /api/2.0/files/rooms/{id} Remove a room
deleteRoomLogo DELETE /api/2.0/files/rooms/{id}/logo Remove a room logo
deleteRoomTags DELETE /api/2.0/files/rooms/{id}/tags Remove the room tags
getNewRoomItems GET /api/2.0/files/rooms/{id}/news Get the new room items
getPublicSettings GET /api/2.0/files/roomtemplate/{id}/public Get public settings
getRoomCovers GET /api/2.0/files/rooms/covers Get covers
getRoomCreatingStatus GET /api/2.0/files/rooms/fromtemplate/status Get the room creation progress
getRoomIndexExport GET /api/2.0/files/rooms/indexexport Get the room index export
getRoomInfo GET /api/2.0/files/rooms/{id} Get room information
getRoomLinks GET /api/2.0/files/rooms/{id}/links Get the room links
getRoomSecurityInfo GET /api/2.0/files/rooms/{id}/share Get the room access rights
getRoomTagsInfo GET /api/2.0/files/tags Get the room tags
getRoomTemplateCreatingStatus GET /api/2.0/files/roomtemplate/status Get status of room template creation
getRoomsFolder GET /api/2.0/files/rooms Get rooms
getRoomsNewItems GET /api/2.0/files/rooms/news Get the room new items
getRoomsPrimaryExternalLink GET /api/2.0/files/rooms/{id}/link Get the room primary external link
pinRoom PUT /api/2.0/files/rooms/{id}/pin Pin a room
reorderRoom PUT /api/2.0/files/rooms/{id}/reorder Reorder the room
resendEmailInvitations POST /api/2.0/files/rooms/{id}/resend Resend the room invitations
setPublicSettings PUT /api/2.0/files/roomtemplate/public Set public settings
setRoomLink PUT /api/2.0/files/rooms/{id}/links Set the room external or invitation link
setRoomSecurity PUT /api/2.0/files/rooms/{id}/share Set the room access rights
startRoomIndexExport POST /api/2.0/files/rooms/{id}/indexexport Start the room index export
terminateRoomIndexExport DELETE /api/2.0/files/rooms/indexexport Terminate the room index export
unarchiveRoom PUT /api/2.0/files/rooms/{id}/unarchive Unarchive a room
unpinRoom PUT /api/2.0/files/rooms/{id}/unpin Unpin a room
updateRoom PUT /api/2.0/files/rooms/{id} Update a room
uploadRoomLogo POST /api/2.0/files/logos Upload a room logo image
Security
Method HTTP request Description
SecurityAccessToDevToolsApi
setTenantDevToolsAccessSettings POST /api/2.0/settings/devtoolsaccess Set the Developer Tools access settings
ActiveConnectionsApi
getAllActiveConnections GET /api/2.0/security/activeconnections Get active connections
logOutActiveConnection PUT /api/2.0/security/activeconnections/logout/{loginEventId} Log out from the connection
logOutAllActiveConnectionsChangePassword PUT /api/2.0/security/activeconnections/logoutallchangepassword Log out and change password
logOutAllActiveConnectionsForUser PUT /api/2.0/security/activeconnections/logoutall/{userId} Log out for the user by ID
logOutAllExceptThisConnection PUT /api/2.0/security/activeconnections/logoutallexceptthis Log out from all connections except the current one
AuditTrailDataApi
createAuditTrailReport POST /api/2.0/security/audit/events/report Generate the audit trail report
getAuditEventsByFilter GET /api/2.0/security/audit/events/filter Get filtered audit trail data
getAuditSettings GET /api/2.0/security/audit/settings/lifetime Get the audit trail settings
getAuditTrailMappers GET /api/2.0/security/audit/mappers Get audit trail mappers
getAuditTrailTypes GET /api/2.0/security/audit/types Get audit trail types
getLastAuditEvents GET /api/2.0/security/audit/events/last Get audit trail data
setAuditSettings POST /api/2.0/security/audit/settings/lifetime Set the audit trail settings
SecurityBannersVisibilityApi
setTenantBannerSettings POST /api/2.0/settings/banner Set the banners visibility
CSPApi
configureCsp POST /api/2.0/security/csp Configure CSP settings
getCspSettings GET /api/2.0/security/csp Get CSP settings
FirebaseApi
docRegisterPusnNotificationDevice POST /api/2.0/settings/push/docregisterdevice Save the Documents Firebase device token
subscribeDocumentsPushNotification PUT /api/2.0/settings/push/docsubscribe Subscribe to Documents push notification
LoginHistoryApi
createLoginHistoryReport POST /api/2.0/security/audit/login/report Generate the login history report
getLastLoginEvents GET /api/2.0/security/audit/login/last Get login history
getLoginEventsByFilter GET /api/2.0/security/audit/login/filter Get filtered login events
OAuth2Api
generateJwtToken GET /api/2.0/security/oauth2/token Generate JWT token
SMTPSettingsApi
getSmtpOperationStatus GET /api/2.0/smtpsettings/smtp/test/status Get the SMTP testing process status
getSmtpSettings GET /api/2.0/smtpsettings/smtp Get the SMTP settings
resetSmtpSettings DELETE /api/2.0/smtpsettings/smtp Reset the SMTP settings
saveSmtpSettings POST /api/2.0/smtpsettings/smtp Save the SMTP settings
testSmtpSettings GET /api/2.0/smtpsettings/smtp/test Test the SMTP settings
Settings
Method HTTP request Description
AccessToDevToolsApi
getTenantAccessDevToolsSettings GET /api/2.0/settings/devtoolsaccess Get the Developer Tools access settings
AuthorizationApi
getAuthServices GET /api/2.0/settings/authservice Get the authorization services
saveAuthKeys POST /api/2.0/settings/authservice Save the authorization keys
BannersVisibilityApi
getTenantBannerSettings GET /api/2.0/settings/banner Get the banners visibility
CommonSettingsApi
closeAdminHelper PUT /api/2.0/settings/closeadminhelper Close the admin helper
completeWizard PUT /api/2.0/settings/wizard/complete Complete the Wizard settings
configureDeepLink POST /api/2.0/settings/deeplink Configure the deep link settings
deletePortalColorTheme DELETE /api/2.0/settings/colortheme Delete a color theme
getDeepLinkSettings GET /api/2.0/settings/deeplink Get the deep link settings
getPaymentSettings GET /api/2.0/settings/payment Get the payment settings
getPortalColorTheme GET /api/2.0/settings/colortheme Get a color theme
getPortalHostname GET /api/2.0/settings/machine Get hostname
getPortalLogo GET /api/2.0/settings/logo Get a portal logo
getPortalSettings GET /api/2.0/settings Get the portal settings
getSocketSettings GET /api/2.0/settings/socket Get the socket settings
getSupportedCultures GET /api/2.0/settings/cultures Get supported languages
getTenantUserInvitationSettings GET /api/2.0/settings/invitationsettings Get the user invitation settings
getTimeZones GET /api/2.0/settings/timezones Get time zones
saveDnsSettings PUT /api/2.0/settings/dns Save the DNS settings
saveMailDomainSettings POST /api/2.0/settings/maildomainsettings Save the mail domain settings
savePortalColorTheme PUT /api/2.0/settings/colortheme Save a color theme
updateEmailActivationSettings PUT /api/2.0/settings/emailactivation Update the email activation settings
updateInvitationSettings PUT /api/2.0/settings/invitationsettings Update user invitation settings
CookiesApi
getCookieSettings GET /api/2.0/settings/cookiesettings Get cookies lifetime
updateCookieSettings PUT /api/2.0/settings/cookiesettings Update cookies lifetime
EncryptionApi
getStorageEncryptionProgress GET /api/2.0/settings/encryption/progress Get the storage encryption progress
getStorageEncryptionSettings GET /api/2.0/settings/encryption/settings Get the storage encryption settings
startStorageEncryption POST /api/2.0/settings/encryption/start Start the storage encryption process
GreetingSettingsApi
getGreetingSettings GET /api/2.0/settings/greetingsettings Get greeting settings
getIsDefaultGreetingSettings GET /api/2.0/settings/greetingsettings/isdefault Check the default greeting settings
restoreGreetingSettings POST /api/2.0/settings/greetingsettings/restore Restore the greeting settings
saveGreetingSettings POST /api/2.0/settings/greetingsettings Save the greeting settings
IPRestrictionsApi
getIpRestrictions GET /api/2.0/settings/iprestrictions Get the IP portal restrictions
readIpRestrictionsSettings GET /api/2.0/settings/iprestrictions/settings Get the IP restriction settings
saveIpRestrictions PUT /api/2.0/settings/iprestrictions Update the IP restrictions
updateIpRestrictionsSettings PUT /api/2.0/settings/iprestrictions/settings Update the IP restriction settings
LicenseApi
acceptLicense POST /api/2.0/settings/license/accept Activate a license
getIsLicenseRequired GET /api/2.0/settings/license/required Request a license
refreshLicense GET /api/2.0/settings/license/refresh Refresh the license
uploadLicense POST /api/2.0/settings/license Upload a license
LoginSettingsApi
getLoginSettings GET /api/2.0/settings/security/loginsettings Get the login settings
setDefaultLoginSettings DELETE /api/2.0/settings/security/loginsettings Reset the login settings
updateLoginSettings PUT /api/2.0/settings/security/loginsettings Update the login settings
MessagesApi
enableAdminMessageSettings POST /api/2.0/settings/messagesettings Enable the administrator message settings
sendAdminMail POST /api/2.0/settings/sendadmmail Send a message to the administrator
sendJoinInviteMail POST /api/2.0/settings/sendjoininvite Sends an invitation email
NotificationsApi
getNotificationChannels GET /api/2.0/settings/notification/channels Get notification channels
getNotificationSettings GET /api/2.0/settings/notification/{type} Check notification availability
getRoomsNotificationSettings GET /api/2.0/settings/notification/rooms Get room notification settings
setNotificationSettings POST /api/2.0/settings/notification Enable notifications
setRoomsNotificationStatus POST /api/2.0/settings/notification/rooms Set room notification status
OwnerApi
sendOwnerChangeInstructions POST /api/2.0/settings/owner Send the owner change instructions
updatePortalOwner PUT /api/2.0/settings/owner Update the portal owner
SettingsQuotaApi
getUserQuotaSettings GET /api/2.0/settings/userquotasettings Get the user quota settings
saveAiAgentQuotaSettings POST /api/2.0/settings/aiagentquotasettings Save the AI Agent quota settings
saveRoomQuotaSettings POST /api/2.0/settings/roomquotasettings Save the room quota settings
setTenantQuotaSettings PUT /api/2.0/settings/tenantquotasettings Save the tenant quota settings
RebrandingApi
deleteAdditionalWhiteLabelSettings DELETE /api/2.0/settings/rebranding/additional Delete the additional white label settings
deleteCompanyWhiteLabelSettings DELETE /api/2.0/settings/rebranding/company Delete the company white label settings
getAdditionalWhiteLabelSettings GET /api/2.0/settings/rebranding/additional Get the additional white label settings
getCompanyWhiteLabelSettings GET /api/2.0/settings/rebranding/company Get the company white label settings
getEnableWhitelabel GET /api/2.0/settings/enablewhitelabel Check the white label availability
getIsDefaultWhiteLabelLogoText GET /api/2.0/settings/whitelabel/logotext/isdefault Check the default white label logo text
getIsDefaultWhiteLabelLogos GET /api/2.0/settings/whitelabel/logos/isdefault Check the default white label logos
getLicensorData GET /api/2.0/settings/companywhitelabel Get the licensor data
getWhiteLabelLogoText GET /api/2.0/settings/whitelabel/logotext Get the white label logo text
getWhiteLabelLogos GET /api/2.0/settings/whitelabel/logos Get the white label logos
restoreWhiteLabelLogoText PUT /api/2.0/settings/whitelabel/logotext/restore Restore the white label logo text
restoreWhiteLabelLogos PUT /api/2.0/settings/whitelabel/logos/restore Restore the white label logos
saveAdditionalWhiteLabelSettings POST /api/2.0/settings/rebranding/additional Save the additional white label settings
saveCompanyWhiteLabelSettings POST /api/2.0/settings/rebranding/company Save the company white label settings
saveWhiteLabelLogoText POST /api/2.0/settings/whitelabel/logotext/save Save the white label logo text settings
saveWhiteLabelSettings POST /api/2.0/settings/whitelabel/logos/save Save the white label logos
saveWhiteLabelSettingsFromFiles POST /api/2.0/settings/whitelabel/logos/savefromfiles Save the white label logos from files
SSOApi
getDefaultSsoSettingsV2 GET /api/2.0/settings/ssov2/default Get the default SSO settings
getSsoSettingsV2 GET /api/2.0/settings/ssov2 Get the SSO settings
getSsoSettingsV2Constants GET /api/2.0/settings/ssov2/constants Get the SSO settings constants
resetSsoSettingsV2 DELETE /api/2.0/settings/ssov2 Reset the SSO settings
saveSsoSettingsV2 POST /api/2.0/settings/ssov2 Save the SSO settings
SecurityApi
getEnabledModules GET /api/2.0/settings/security/modules Get the enabled modules
getIsProductAdministrator GET /api/2.0/settings/security/administrator Check a product administrator
getPasswordSettings GET /api/2.0/settings/security/password Get the password settings
getProductAdministrators GET /api/2.0/settings/security/administrator/{productid} Get the product administrators
getWebItemSecurityInfo GET /api/2.0/settings/security/{id} Get the module availability
getWebItemSettingsSecurityInfo GET /api/2.0/settings/security Get the security settings
setAccessToWebItems PUT /api/2.0/settings/security/access Set the security settings to modules
setProductAdministrator PUT /api/2.0/settings/security/administrator Set a product administrator
setWebItemSecurity PUT /api/2.0/settings/security Set the module security settings
updatePasswordSettings PUT /api/2.0/settings/security/password Set the password settings
StatisticsApi
getSpaceUsageStatistics GET /api/2.0/settings/statistics/spaceusage/{id} Get the space usage statistics
StorageApi
getAllBackupStorages GET /api/2.0/settings/storage/backup Get the backup storages
getAllCdnStorages GET /api/2.0/settings/storage/cdn Get the CDN storages
getAllStorages GET /api/2.0/settings/storage Get storages
getAmazonS3Regions GET /api/2.0/settings/storage/s3/regions Get Amazon regions
getStorageProgress GET /api/2.0/settings/storage/progress Get the storage progress
resetCdnToDefault DELETE /api/2.0/settings/storage/cdn Reset the CDN storage settings
resetStorageToDefault DELETE /api/2.0/settings/storage Reset the storage settings
updateCdnStorage PUT /api/2.0/settings/storage/cdn Update the CDN storage
updateStorage PUT /api/2.0/settings/storage Update a storage
TFASettingsApi
getTfaAppCodes GET /api/2.0/settings/tfaappcodes Get the TFA codes
getTfaConfirmUrl GET /api/2.0/settings/tfaapp/confirm Get confirmation email
getTfaSettings GET /api/2.0/settings/tfaapp Get the TFA settings
tfaAppGenerateSetupCode GET /api/2.0/settings/tfaapp/setup Generate setup code
tfaValidateAuthCode POST /api/2.0/settings/tfaapp/validate Validate the TFA code
unlinkTfaApp PUT /api/2.0/settings/tfaappnewapp Unlink the TFA application
updateTfaAppCodes PUT /api/2.0/settings/tfaappnewcodes Update the TFA codes
updateTfaSettings PUT /api/2.0/settings/tfaapp Update the TFA settings
updateTfaSettingsLink PUT /api/2.0/settings/tfaappwithlink Get a confirmation email for updating TFA settings
TelegramApi
checkTelegram GET /api/2.0/settings/telegram/check Check the Telegram connection
linkTelegram GET /api/2.0/settings/telegram/link Get the Telegram link
unlinkTelegram DELETE /api/2.0/settings/telegram/link Unlink Telegram
WebhooksApi
createWebhook POST /api/2.0/settings/webhook Create a webhook
enableWebhook PUT /api/2.0/settings/webhook/enable Enable a webhook
getTenantWebhooks GET /api/2.0/settings/webhook Get webhooks
getWebhookTriggers GET /api/2.0/settings/webhook/triggers Get webhook triggers
getWebhooksLogs GET /api/2.0/settings/webhooks/log Get webhook logs
removeWebhook DELETE /api/2.0/settings/webhook/{id} Remove a webhook
retryWebhook PUT /api/2.0/settings/webhook/{id}/retry Retry a webhook
retryWebhooks PUT /api/2.0/settings/webhook/retry Retry webhooks
updateWebhook PUT /api/2.0/settings/webhook Update a webhook
WebpluginsApi
addWebPluginFromFile POST /api/2.0/settings/webplugins Add a web plugin
deleteWebPlugin DELETE /api/2.0/settings/webplugins/{name} Delete a web plugin
getWebPlugin GET /api/2.0/settings/webplugins/{name} Get a web plugin by name
getWebPlugins GET /api/2.0/settings/webplugins Get web plugins
updateWebPlugin PUT /api/2.0/settings/webplugins/{name} Update a web plugin
ThirdParty
Method HTTP request Description
ThirdPartyApi
getThirdPartyCode GET /api/2.0/thirdparty/{provider} Get the code request

Documentation For Models

Models list

About

A simple TypeScript SDK for integrating with the ONLYOFFICE DocSpace API

Topics

sdk integration onlyoffice docspace

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases 2

v3.6.0 Latest
Feb 10, 2026
+ 1 release

Contributors

Languages