# Get white label config

This endpoint fetches the white label config for the company.

Endpoint: GET /v2/companies/{companyId}/white-label-config
Version: v2
Security: Bearer

## Security:

  - `Bearer` (unknown)
    http bearer

## Path parameters:

  - `companyId` (string, required)
    Identifier for company.

## Query parameters:

  - `companyRole` (string, required)

  - `applicationId` (string)
    Application context to get white label config.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `companyName` (string)
    Example: Spotnana

  - `colors` (object)
    Whitelabel configuration related to colours.

  - `colors.primary` (string)
    Example: #D33B47

  - `colors.primaryDark` (string)
    Example: #D33B47

  - `colors.primaryLight` (string)
    Example: #D33B47

  - `colors.primaryPale` (string)
    Example: #D33B47

  - `colors.onPrimary` (string)
    Example: #D33B47

  - `colors.secondary` (string)
    Example: #D33B47

  - `colors.secondaryDark` (string)
    Example: #D33B47

  - `colors.secondaryLight` (string)
    Example: #D33B47

  - `colors.secondaryPale` (string)
    Example: #D33B47

  - `colors.onSecondary` (string)
    Example: #D33B47

  - `colors.error` (string)
    Example: #D33B47

  - `colors.errorDark` (string)
    Example: #D33B47

  - `colors.errorLight` (string)
    Example: #D33B47

  - `colors.errorPale` (string)
    Example: #D33B47

  - `colors.onError` (string)
    Example: #D33B47

  - `webLinks` (object)
    Weblinks which are parts of WhiteLabelConfig.

  - `webLinks.logoHeader` (string)
    Example: https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/confirmation/spotnana3.png

  - `webLinks.logoFooter` (string)
    Example: https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png

  - `webLinks.companyWebsiteAddress` (string)
    Example: https://www.spotnana.com

  - `webLinks.homePage` (string)
    Example: https://stage-app.spotnana.com/flights

  - `webLinks.itineraryPage` (string)
    Example: https://stage-app.spotnana.com/trips/3375488451

  - `webLinks.disclaimerPage` (string)
    Example: https://www.spotnana.com/terms

  - `webLinks.privacyPage` (string)
    Example: https://www.spotnana.com/privacy-policy

  - `webLinks.hardApprovalUrl` (string)
    Example: https://stage-app.spotnana.com/hardapproval?approvalId=CgozMzQ5OTI4MzI2EiMKIQoMCgpQaWh1IEd1cHRhEhFwaWh1QHNwb3RuYW5hLmNvbQ%3D%3D&approverName=Pihu%20Gupta&travelerName=Pihu%20Gupta&tripName=TESting%201…

  - `webLinks.itineraryFlightStatsUrl` (string)
    Example: https://stage-app.spotnana.com/trips/4694735622

  - `webLinks.appEmbedScriptUrl` (string)
    Example: https://customjs.partner.com

  - `webLinks.logoNavigationLink` (string)
    Example: http://www.spotnana.com

  - `webLinks.illustration` (string)
    Example: https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png

  - `webLinks.poweredBySpotnana` (boolean)
    Example: false

  - `webLinks.logoutRedirectUrl` (string)
    Example: https://www.spotnana.com/signout

  - `webLinks.faviconUrl` (string)
    Display logo on the browser title.
    Example: http://www.spotnana.com

  - `webLinks.appDownloadLinks` (object)
    App store or QR links for downloading app.

  - `webLinks.appDownloadLinks.androidPlayStoreUrl` (string)
    Example: https://play.google.com/store/apps/details?id=com.spotnana

  - `webLinks.appDownloadLinks.iosAppStoreUrl` (string)
    Example: https://apps.apple.com/in/app/spotnana-travel-booking/id1580021446

  - `webLinks.appDownloadLinks.qrCodeUrl` (string)
    Example: https://www.spotnana.com

  - `webLinks.socialMediaLinks` (object)
    Social media links.

  - `webLinks.socialMediaLinks.facebookUrl` (string)
    Example: https://www.facebook.com/spotnanaofficial

  - `webLinks.socialMediaLinks.twitterUrl` (string)
    Example: https://twitter.com/spotnana

  - `webLinks.socialMediaLinks.instagramUrl` (string)
    Example: https://www.instagram.com/spotnana_official

  - `webLinks.termsOfUse` (string)
    Terms of service/legal agreement between a service provider and a person who wants to use service.
    Example: https://www.spotnana.com/terms/

  - `webLinks.illustrationActionUrl` (string)
    Example: https://www.spotnana.com/login

  - `webLinks.checkoutCoverImageUrl` (string)
    Cover image to be shown on checkout page.
    Example: https://duploservices-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png

  - `webLinks.postCcVerificationCallbackUrl` (string)
    Post credit card verification callback URL.
    Example: https://example.com/callback

  - `webLinks.loyaltyLinkedImageUrl` (string)
    Image URL for loyalty linked page.
    Example: https://example.com/loyalty-linked.png

  - `webLinks.onboardingFinalizeImageUrl` (string)
    Image URL for onboarding finalize page.
    Example: https://example.com/onboarding-finalize.png

  - `webLinks.inviteUserImageUrl` (string)
    Image URL for invite user page.
    Example: https://example.com/invite-user.png

  - `webLinks.enrollmentSuccessImageUrl` (string)
    Image URL for enrollment success page.
    Example: https://example.com/enrollment-success.png

  - `webLinks.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.
    Example: https://partner.com/embedded/take-action

  - `webLinks.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.
    Example: https://partner.com/embedded/my-trip

  - `webLinks.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.
    Example: https://partner.com/embedded/my-trip

  - `webLinks.downloadPath` (string)
    Partner URL for the "Download file" email CTA. Supports %s for the document id. Unset falls back to the existing document-download link.
    Example: https://partner.com/embedded/download/%s

  - `fromEmailAddress` (string)
    Example: no-reply@spotnana.com

  - `fontFamily` (string)
    Example: Arial

  - `emailFontFamily` (string)
    Example: Roboto

  - `fontFamilyCss` (string)
    Example: https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css

  - `emailClientConfig` (object)
    Email Client Config

  - `emailClientConfig.client` (string, required)
    Enum: "AWS_SES", "SENDGRID"

  - `emailClientConfig.credentials` (object, required)
    Email client credentials for the company.

  - `emailClientConfig.credentials.emailClientSecretKey` (object, required)
    EmailClientSecretKey

  - `emailClientConfig.credentials.emailClientSecretKey.secretKey` (string)
    Example: SECRET_KEY

  - `emailClientConfig.credentials.emailClientSecretKey.versionId` (string)
    Example: 1

  - `emailClientConfig.defaultSenderAddress` (string, required)
    The default sender address to be used for the configured client
    Example: test@somedomain.com

  - `emailClientConfig.defaultSenderName` (string)
    The default sender name to be used for the configured client
    Example: Test Sender

  - `clientRoutingBasePath` (string)
    Base path used by Spotnana OBT application to invoke API calls. Default path value is /

  - `routingConfig` (object)
    App routing configuration.

  - `routingConfig.appHomeRoute` (string)
    Example: /my-account

  - `privacyDisclaimer` (object)
    Html to shown on the the login page. This will be text with hyper links.

  - `privacyDisclaimer.show` (boolean)

  - `privacyDisclaimer.html` (string)
    String containing the html.
    Example: </html>

  - `visaRequirements` (string)
    Rich text content for visa requirements information
    Example: <p>Please ensure you have the necessary visa documentation before traveling.</p>

  - `themeConfig` (object)
    Theming V2 config — maps 1:1 to the FE TWhiteLabelConfigV2 shape. Additive and opt-in.

  - `themeConfig.fontFamily` (array)
    Font stack — first font that loads wins. Empty = use V1 fontFamily.
    Example: ["Inter","Arial","sans-serif"]

  - `themeConfig.palette` (object)
    Semantic palette split by color mode. Empty token = use the Blocks default.

  - `themeConfig.palette.light` (object)
    Semantic-role-based tokens (bg / text / border / icon / appShell) plus per-mode component colours (tabs / link).

  - `themeConfig.palette.light.bg` (object)
    Background tokens. surface is the app/page background.

  - `themeConfig.palette.light.bg.surface` (string)
    Example: #FFFFFF

  - `themeConfig.palette.light.bg.surface02` (string)
    Example: #F7F7F7

  - `themeConfig.palette.light.bg.brand` (string)
    Example: #D33B47

  - `themeConfig.palette.light.bg.brandSubtle` (string)
    Example: #FBE9EA

  - `themeConfig.palette.light.bg.brandHover` (string)
    Example: #B73039

  - `themeConfig.palette.light.bg.hover` (string)
    Example: #F0F0F0

  - `themeConfig.palette.light.text` (object)

  - `themeConfig.palette.light.text.primary` (string)
    Example: #1A1A1A

  - `themeConfig.palette.light.text.secondary` (string)
    Example: #6B6B6B

  - `themeConfig.palette.light.text.brand` (string)
    Example: #D33B47

  - `themeConfig.palette.light.text.link` (string)
    Example: #1F6FEB

  - `themeConfig.palette.light.border` (object)

  - `themeConfig.palette.light.border.light` (string)
    Example: #E5E5E5

  - `themeConfig.palette.light.border.medium` (string)
    Example: #CCCCCC

  - `themeConfig.palette.light.border.dark` (string)
    Example: #999999

  - `themeConfig.palette.light.border.brand` (string)
    Example: #D33B47

  - `themeConfig.palette.light.border.brandSubtle` (string)
    Example: #F3C6C9

  - `themeConfig.palette.light.border.hover` (string)
    Example: #B73039

  - `themeConfig.palette.light.icon` (object)

  - `themeConfig.palette.light.icon.brand` (string)
    Example: #D33B47

  - `themeConfig.palette.light.appShell` (object)
    App-shell (top nav / frame) colour tokens. Part of the semantic palette so each is set per color mode, alongside bg / text / border / icon.

  - `themeConfig.palette.light.appShell.bg` (string)
    App-shell background colour (hex).
    Example: #232F3E

  - `themeConfig.palette.light.appShell.bgHover` (string)
    App-shell hover/active nav pill background (hex).
    Example: #33475B

  - `themeConfig.palette.light.appShell.text` (string)
    App-shell default nav text + icon colour (hex).
    Example: #C9CBCF

  - `themeConfig.palette.light.appShell.textHover` (string)
    App-shell hover/active nav text + icon colour (hex).
    Example: #FFFFFF

  - `themeConfig.palette.light.tabs` (object)
    Per-mode Tabs colours — active-tab underline and hover. Authored separately for light and dark so a colour set in one mode does not bleed into the other.

  - `themeConfig.palette.light.tabs.underlineColor` (string)
    Active/selected tab underline (indicator) colour as a hex value. Empty = use the Blocks default.
    Example: #D33B47

  - `themeConfig.palette.light.tabs.hoverColor` (string)
    Tab hover colour (hover underline + filled tab hover background) as a hex value. Empty = use the Blocks default.
    Example: #F3C6C9

  - `themeConfig.palette.light.link` (object)
    Per-mode Link colour. Authored separately for light and dark so a colour set in one mode does not bleed into the other.

  - `themeConfig.palette.light.link.color` (string)
    Link text + underline colour as a hex value. Empty = use the Blocks default (text.link).
    Example: #D33B47

  - `themeConfig.overrides` (object)
    Per-component style overrides. Extensible — start with button.

  - `themeConfig.overrides.button` (object)

  - `themeConfig.overrides.button.borderRadius` (object)
    Button corner shape override. Stores only the picked preset id (like ThemeShape) — pixel radii are resolved from the client preset table at runtime, so presets stay tunable in one place.

  - `themeConfig.overrides.button.borderRadius.cornerShapeId` (string)
    Corner shape preset id. Pixel radii are resolved from the client preset table at runtime, so presets stay tunable in one place.
    Enum: "DEFAULT", "BRUTALIST", "SQUARE", "SOFT", "SEMI", "ROUNDED", "PILL"

  - `themeConfig.overrides.button.textTransform` (string)
    Label casing. Unset = NONE (shipped default).
    Enum: "NONE", "UPPERCASE"

  - `themeConfig.overrides.ghostButton` (object)
    Label casing override for a component slot. Each slot is independent — there is no global casing to inherit.

  - `themeConfig.overrides.tabs` (object)
    Tabs component overrides — label casing only. Tab corners follow the global corner shape and the active-underline/hover colours are per-mode palette tokens (ThemeTabsColorTokens), so neither is overridden here.

  - `themeConfig.overrides.link` (object)
    Link component overrides — label casing only. Link colour is a per-mode palette token (ThemeLinkColorTokens), so it is not overridden here.

  - `themeConfig.shape` (object)
    Global corner shape. Stores only the user-picked preset id — pixel radii are resolved from the client preset table at runtime, so presets stay tunable in one place.

  - `brandingVisibility` (object)
    Per-surface visibility of branding elements. Additive — default shows everything.

  - `brandingVisibility.headerLogo` (object)
    Visibility of one branding element across surfaces. Each surface renderer honors only its own flag (e.g. email ignores hideOnWeb).

  - `brandingVisibility.headerLogo.hideOnWeb` (boolean)
    Example: true

  - `emailTemplatesConfig` (object)
    Email template overrides. Each unset field falls back to the generic template for that email.

  - `emailTemplatesConfig.onboardingTemplateName` (string)
    Stencil template name used for the onboarding invitation email. Unset or empty falls back to ONBOARDING_INVITATION.
    Example: ONBOARDING_INVITATION

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 404:

  - `404` (unknown)
    The specified resource was not found.

## Response 404 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.