--- title: "Get white label config" method: GET path: "/v2/companies/{companyId}/white-label-config" tags: ["Companies"] --- # Get white label config `GET /v2/companies/{companyId}/white-label-config` This endpoint fetches the white label config for the company. ## Query parameters - `companyRole` 'ORG' | 'TMC' | 'PARTNER_TMC' | 'HR_FEED_CONNECTOR' | 'TRIPS_DATA_CONNECTOR' | 'GLOBAL', required — Role of the company. - `applicationId` string, uuid ## Response `200` OK - WhiteLabelConfig — Whitelabel configuration. - `companyName` string - `colors` ColorWhiteLabelConfig — Whitelabel configuration related to colours. - `primary` string - `primaryDark` string - `primaryLight` string - `primaryPale` string - `onPrimary` string - `secondary` string - `secondaryDark` string - `secondaryLight` string - `secondaryPale` string - `onSecondary` string - `error` string - `errorDark` string - `errorLight` string - `errorPale` string - `onError` string - `webLinks` WebLinksConfig — Weblinks which are parts of WhiteLabelConfig. - `logoHeader` string - `logoFooter` string - `companyWebsiteAddress` string - `homePage` string - `itineraryPage` string - `disclaimerPage` string - `privacyPage` string - `hardApprovalUrl` string - `itineraryFlightStatsUrl` string - `appEmbedScriptUrl` string - `logoNavigationLink` string - `illustration` string - `poweredBySpotnana` boolean - `logoutRedirectUrl` string - `faviconUrl` string — Display logo on the browser title. - `appDownloadLinks` AppDownloadLinksConfig — App store or QR links for downloading app. - `androidPlayStoreUrl` string - `iosAppStoreUrl` string - `qrCodeUrl` string - `socialMediaLinks` SocialMediaLinksConfig — Social media links. - `facebookUrl` string - `twitterUrl` string - `instagramUrl` string - `termsOfUse` string — Terms of service/legal agreement between a service provider and a person who wants to use service. - `illustrationActionUrl` string - `checkoutCoverImageUrl` string — Cover image to be shown on checkout page. - `postCcVerificationCallbackUrl` string — Post credit card verification callback URL. - `loyaltyLinkedImageUrl` string — Image URL for loyalty linked page. - `onboardingFinalizeImageUrl` string — Image URL for onboarding finalize page. - `inviteUserImageUrl` string — Image URL for invite user page. - `takeActionPath` string — Email CTA routing override for embedded/white-labeled deployments. "Take action" CTA (Arranger email) destination — a full URL (e.g. a partner-hosted wrapping page that redirects into their embedded iframe), same convention as itineraryPage/hardApprovalUrl, used as-is with no base-URL prefixing. Unset falls back to the existing hardcoded native path. - `bookMyTripPath` string — Email CTA routing override for embedded/white-labeled deployments. "Book my trip" CTA (event invite/reminder emails) destination — a full URL, same convention as itineraryPage/hardApprovalUrl, used as-is with no base-URL prefixing. Unset falls back to the existing hardcoded native path. - `viewEventDetailsPath` string — Email CTA routing override for embedded/white-labeled deployments. "View event details" CTA (event invite email) destination — a full URL, same convention as itineraryPage/hardApprovalUrl, used as-is with no base-URL prefixing. Unset falls back to the existing hardcoded native path. - `fromEmailAddress` string - `fontFamily` string - `emailFontFamily` string - `fontFamilyCss` string - `emailClientConfig` EmailClientConfig — Email Client Config - `client` 'AWS_SES' | 'SENDGRID', required - `credentials` EmailClientCredentials, required — Email client credentials for the company. - `emailClientSecretKey` EmailClientSecretKey, required — EmailClientSecretKey - `secretKey` string - `versionId` string - `defaultSenderAddress` string, required — The default sender address to be used for the configured client - `defaultSenderName` string — The default sender name to be used for the configured client - `clientRoutingBasePath` string — Base path used by Spotnana OBT application to invoke API calls. Default path value is / - `routingConfig` RoutingConfig — App routing configuration. - `appHomeRoute` string - `privacyDisclaimer` PrivacyDisclaimer — Html to shown on the the login page. This will be text with hyper links. - `show` boolean - `html` string — String containing the html. - `visaRequirements` string — Rich text content for visa requirements information - `themeConfig` ThemeConfigV2 — Theming V2 config — maps 1:1 to the FE TWhiteLabelConfigV2 shape. Additive and opt-in. - `fontFamily` string[] — Font stack — first font that loads wins. Empty = use V1 fontFamily. - `palette` ThemePalette — Semantic palette split by color mode. Empty token = use the Blocks default. - `light` ThemeColorTokens — Semantic-role-based tokens (bg / text / border / icon). - `bg` ThemeBgTokens — Background tokens. surface is the app/page background. - `surface` string - `surface02` string - `brand` string - `brandSubtle` string - `brandHover` string - `text` ThemeTextTokens - `primary` string - `secondary` string - `brand` string - `link` string - `border` ThemeBorderTokens - `light` string - `medium` string - `dark` string - `brand` string - `brandSubtle` string - `hover` string - `icon` ThemeIconTokens - `brand` string - `dark` ThemeColorTokens — Semantic-role-based tokens (bg / text / border / icon). - `bg` ThemeBgTokens — Background tokens. surface is the app/page background. - `surface` string - `surface02` string - `brand` string - `brandSubtle` string - `brandHover` string - `text` ThemeTextTokens - `primary` string - `secondary` string - `brand` string - `link` string - `border` ThemeBorderTokens - `light` string - `medium` string - `dark` string - `brand` string - `brandSubtle` string - `hover` string - `icon` ThemeIconTokens - `brand` string - `overrides` ThemeOverrides — Per-component style overrides. Extensible — start with button. - `button` ThemeButtonOverride - `borderRadius` ThemeButtonRadius — Border radius by button size. Empty = use the Blocks default. - `small` string - `medium` string - `large` string - `brandingVisibility` BrandingVisibility — Per-surface visibility of branding elements. Additive — default shows everything. - `headerLogo` SurfaceVisibility — Visibility of one branding element across surfaces. Each surface renderer honors only its own flag (e.g. email ignores hideOnWeb). - `hideOnWeb` boolean - `poweredBy` SurfaceVisibility — Visibility of one branding element across surfaces. Each surface renderer honors only its own flag (e.g. email ignores hideOnWeb). - `hideOnWeb` boolean ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — The specified resource was not found. --- [API](https://skmtc.net/spotnana/apis/company-api.md) · [All operations](https://skmtc.net/spotnana/apis/company-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/company-api/revisions/36b1305ad44a/schema)