getCompanyWhiteLabelSettings
CompanyWhiteLabelSettingsWrapper getCompanyWhiteLabelSettings()
GET /api/2.0/settings/rebranding/company
Get the company white label settings
Returns the company details that the About page and the notification letters print as the vendor, in the form the settings interface edits them. Any authenticated user may call it; no administrator permission is required, and a portal whose payment has lapsed is served as well. The call is read-only and idempotent. Alongside the stored fields the answer carries isLicensor, which tells whether these details belong to the vendor of the product itself, and isDefault, which tells whether they are still the built-in ONLYOFFICE ones. The values are installation-wide, so every portal of a server installation reports the same ones. The response is revalidatable: it carries Last-Modified, and sending that value back in If-Modified-Since yields an empty body while the details have not changed, which makes polling cheap. For the About page, where the built-in vendor has to be shown next to a reseller, use GET api/2.0/settings/companywhitelabel instead. Change the details with POST api/2.0/settings/rebranding/company.
Parameters
This endpoint does not need any parameter.
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The company details in effect, with the licensor and default flags | CompanyWhiteLabelSettingsWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 304 | The company details have not changed since the Last-Modified value sent back in If-Modified-Since; the body is empty | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
CompanyWhiteLabelSettingsWrapper
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: Not defined
- Accept: application/json