Get a portal

GET /api/2.0/portal

Request

Returns the current portal.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Examples

GET /api/2.0/portal HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/portal \
  --header 'Accept: application/json'

Responses

200

Current portal information

affiliateIdstring

Affiliate ID

tenantAliasstring

Tenant alias

callsboolean

Specifies if the calls are available for this tenant or not

campaignstring

Campaign

creationDateTimestringformat: date-time

Creation date and time

hostedRegionstring

Hosted region

tenantIdintegerformat: int32

Tenant ID

industryone of

.enum of string

[Other - Other, Accounting - Accounting, AdvertisingMarketingPR - Advertising marketing PR, Banking - Banking, Consulting - Consulting, Design - Design, Education - Education, Environment - Environment, FinancialServices - Financial services, HealthCare - Health care, IT - IT, Legal - Legal, Manufacturing - Manufacturing, PublicSector - Public sector, Publishing - Publishing, RetailSales - Retail sales, Telecommunications - Telecommunications]

Can be one of: Other, Accounting, AdvertisingMarketingPR, Banking, Consulting, Design, Education, Environment, FinancialServices, HealthCare, IT, Legal, Manufacturing, PublicSector, Publishing, RetailSales, Telecommunications.

.enum of integer

[0 - Other, 1 - Accounting, 2 - Advertising marketing PR, 3 - Banking, 4 - Consulting, 5 - Design, 6 - Education, 7 - Environment, 8 - Financial services, 9 - Health care, 10 - IT, 11 - Legal, 12 - Manufacturing, 13 - Public sector, 14 - Publishing, 15 - Retail sales, 16 - Telecommunications]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16.

languagestring

Language

lastModifiedstringformat: date-time

Last modified date

mappedDomainstring

Mapped domain

namestring

Name

ownerIdstringformat: uuid

Owner ID

paymentIdstring

Payment ID

spamboolean

Specifies if the ONLYOFFICE newsletter is allowed or not

statusone of

.enum of string

[Active - Active, Suspended - Suspended, RemovePending - Remove pending, Transfering - Transfering, Restoring - Restoring, Migrating - Migrating, Encryption - Encryption]

Can be one of: Active, Suspended, RemovePending, Transfering, Restoring, Migrating, Encryption.

.enum of integer

[0 - Active, 1 - Suspended, 2 - Remove pending, 3 - Transfering, 4 - Restoring, 5 - Migrating, 6 - Encryption]

Can be one of: 0, 1, 2, 3, 4, 5, 6.

statusChangeDatestringformat: date-time

The date and time when the tenant status was changed

timeZonestring

Time zone

trustedDomainsarray of unknown

List of trusted domains

trustedDomainsRawstring

Trusted domains in the string format

trustedDomainsTypeone of

.enum of string

[None - None, Custom - Custom, All - All]

Can be one of: None, Custom, All.

.enum of integer

[0 - None, 1 - Custom, 2 - All]

Can be one of: 0, 1, 2.

versionintegerformat: int32

Version

versionChangedstringformat: date-time

The date and time when the tenant version was changed

401

Unauthorized

403

Forbidden