ONLYOFFICE DocSpace Portal API

The browsable version of this reference, with a request builder and code samples, is published at https://api.onlyoffice.com/docspace/api-backend/usage-api/.

All URIs are relative to https://yourportal.onlyoffice.com, where the host is the address of your DocSpace instance.

Guests

Method	HTTP request	Description
getGuestSharingLink	GET /api/2.0/people/guests/{userId}/share	Get a guest sharing link

Payment

Method	HTTP request	Description
calculateWalletPayment	PUT /api/2.0/portal/payment/calculatewallet	Calculate the wallet payment amount
changeTenantWalletServiceState	POST /api/2.0/portal/payment/servicestate	Switch a wallet service
createCustomerMonthlyUsageReport	POST /api/2.0/portal/payment/customer/usage/monthly/report	Start the monthly usage report
createCustomerOperationsReport	POST /api/2.0/portal/payment/customer/operationsreport	Start the operations report
createCustomerServiceUsageReport	POST /api/2.0/portal/payment/customer/usage/report	Start the service usage report
getAccountingServicePrices	GET /api/2.0/portal/payment/accounting/prices/{serviceName}	Get the service prices from the accounting service
getActiveServices	GET /api/2.0/portal/payment/activeservices	Get the active wallet services
getAiPrices	GET /api/2.0/portal/payment/ai-prices	Get AI model prices
getCheckoutSetupUrl	GET /api/2.0/portal/payment/checkoutsetupurl	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
getCustomerMonthlyUsage	GET /api/2.0/portal/payment/customer/usage/monthly	Get the customer monthly usage
getCustomerMonthlyUsageReport	GET /api/2.0/portal/payment/customer/usage/monthly/report	Get the monthly usage report status
getCustomerOperations	GET /api/2.0/portal/payment/customer/operations	Get the wallet operations
getCustomerOperationsReport	GET /api/2.0/portal/payment/customer/operationsreport	Get the operations report status
getCustomerServiceUsage	GET /api/2.0/portal/payment/customer/usage	Get the customer service usage
getCustomerServiceUsageReport	GET /api/2.0/portal/payment/customer/usage/report	Get the service usage report status
getPaymentAccount	GET /api/2.0/portal/payment/account	Get the billing account page
getPaymentCurrencies	GET /api/2.0/portal/payment/currencies	Get the billing currencies
getPaymentQuotas	GET /api/2.0/portal/payment/quotas	Get the purchasable quotas
getPaymentUrl	PUT /api/2.0/portal/payment/url	Get the payment page URL
getPortalPrices	GET /api/2.0/portal/payment/prices	Get the product prices
getQuotaPaymentInformation	GET /api/2.0/portal/payment/quota	Get the current plan and limits
getRestrictedAiModels	GET /api/2.0/portal/payment/ai-model/restrictions	Get restricted AI models
getSubscriptionBalanceInfo	GET /api/2.0/portal/payment/subscription/balance	Get the subscription balance information
getTenantWalletServiceSettings	GET /api/2.0/portal/payment/servicessettings	Get the wallet service settings
getTenantWalletSettings	GET /api/2.0/portal/payment/topupsettings	Get the auto top-up settings
getWalletService	GET /api/2.0/portal/payment/walletservice	Get a wallet service
getWalletServices	GET /api/2.0/portal/payment/walletservices	Get wallet services
moveSubscriptionToWallet	POST /api/2.0/portal/payment/subscription/movetowallet	Move the subscription to the wallet
sendPaymentRequest	POST /api/2.0/portal/payment/request	Contact the sales team
setRestrictedAiModels	PUT /api/2.0/portal/payment/ai-model/restrictions	Set restricted AI models
setTenantWalletSettings	POST /api/2.0/portal/payment/topupsettings	Set the auto top-up settings
terminateCustomerMonthlyUsageReport	DELETE /api/2.0/portal/payment/customer/usage/monthly/report	Terminate the monthly usage report
terminateCustomerOperationsReport	DELETE /api/2.0/portal/payment/customer/operationsreport	Terminate the operations report
terminateCustomerServiceUsageReport	DELETE /api/2.0/portal/payment/customer/usage/report	Terminate the service usage report
topUpDeposit	POST /api/2.0/portal/payment/deposit	Top up the wallet
updatePayment	PUT /api/2.0/portal/payment/update	Change the subscription quantity
updateWalletPayment	PUT /api/2.0/portal/payment/updatewallet	Change a wallet service quantity

Quota

Method	HTTP request	Description
getPortalQuota	GET /api/2.0/portal/quota	Get the portal quota
getPortalTariff	GET /api/2.0/portal/tariff	Get the 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
getUpcomingPayments	GET /api/2.0/portal/tariff/upcoming	Get upcoming payments

Settings

Method	HTTP request	Description
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 portal information
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

Users

Method	HTTP request	Description
createInvitationLink	POST /api/2.0/portal/users/invitationlink	Create an invitation link
deleteInvitationLink	DELETE /api/2.0/portal/users/invitationlink	Delete an invitation link
getInvitationLink	GET /api/2.0/portal/users/invite/{employeeType}	Get a legacy invitation link
getInvitationLinkByEmployeeType	GET /api/2.0/portal/users/invitationlink/{employeeType}	Get an invitation link by role
getPortalUsersCount	GET /api/2.0/portal/userscount	Get a number of portal users
getUserById	GET /api/2.0/portal/users/{userId}	Get a portal user
markGiftMessageAsRead	POST /api/2.0/portal/present/mark	Mark a gift message as read
sendCongratulations	POST /api/2.0/portal/sendcongratulations	Send congratulations
updateInvitationLink	PUT /api/2.0/portal/users/invitationlink	Update an invitation link

Authorization

cookieAuth

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

bearerAuth

• Type: HTTP Bearer Token authentication

asc_auth_key

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

Basic

• Type: HTTP basic authentication

Bearer

• Type: HTTP Bearer Token authentication (JWT)

ApiKeyBearer

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

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL:
• Scopes:
  • read: Read access to protected resources
  • write: Write access to protected resources

OpenId

x-signature

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