Company

Get the tenant and owner portal settings

Returns how the company's public tenant and owner portal is branded: its page metadata and theme, its contact details, its social links, the languages it is offered in, and its icon, logo and cover images.

GET
https://api.portal.magicdoor.com/company-app/companies/portal-settings

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Response

200 · The portal settings.

metadataobject

How the portal presents itself to browsers and search engines.

contactobject

Contact details shown on the portal.

socialLinksobject

Social profile URLs, keyed by network. Keys are twitter, facebook, instagram, linkedIn, youTube and tikTok.

translationLanguagesstring[]

ISO 639-1 codes the portal offers itself in.

iconFileobject

The favicon. Absent when none was uploaded.

logoFileobject

The portal logo. Absent when none was uploaded.

coverFileobject

The portal cover image. Absent when none was uploaded.

iconFileIdstringdeprecated

Same value as iconFile.id.

iconUrlstringdeprecated

Pre-signed URL for the favicon. Use iconFile.secureUrl.raw instead.

iconThumbUrlstringdeprecated

Pre-signed thumbnail URL for the favicon. Use iconFile.secureUrl.variantTemplate instead.

logoFileIdstringdeprecated

Same value as logoFile.id.

logoUrlstringdeprecated

Pre-signed URL for the logo. Use logoFile.secureUrl.raw instead.

logoThumbUrlstringdeprecated

Pre-signed thumbnail URL for the logo. Use logoFile.secureUrl.variantTemplate instead.

coverFileIdstringdeprecated

Same value as coverFile.id.

coverUrlstringdeprecated

Pre-signed URL for the cover image. Use coverFile.secureUrl instead.

401 · The access token is missing, expired, or not valid for this company.