# 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

## Path parameters:

  - `companyId` (string, required)
    Identifier for company.
    Example: "4974a66b-7493-4f41-908c-58ba81093947"

## Query parameters:

  - `companyRole` (string, required)
    Role of the company.
    Enum: "ORG", "TMC", "PARTNER_TMC", "HR_FEED_CONNECTOR", "TRIPS_DATA_CONNECTOR", "GLOBAL"

  - `applicationId` (string)
    Application context to get white label config.
    Example: "1234a66b-7493-4f41-908c-58ba81055667"

## 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&tripId=2418132231&voidDate=Tuesday,%2021%20Jun%20at%2002:00%20UTC"

  - `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)

  - `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.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"

  - `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 configuration representing the email provider to be used.

  - `emailClientConfig.client` (string, required)
    The email client to be used for pushing out the emails
    Enum: "AWS_SES", "SENDGRID"

  - `emailClientConfig.credentials` (object, required)
    Credentials for connecting to the email client

  - `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 — additive, opt-in. Unset falls back to V1 (colors / fontFamily).

  - `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).

  - `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.text` (object)

  - `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.hover` (string)
    Example: "#B73039"

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

  - `themeConfig.palette.dark` (object)
    Semantic-role-based tokens (bg / text / border / icon).

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

  - `themeConfig.overrides.button` (object)

  - `themeConfig.overrides.button.borderRadius` (object)
    Border radius by button size. Empty = use the Blocks default.

  - `themeConfig.overrides.button.borderRadius.small` (string)
    Example: "4px"

  - `themeConfig.overrides.button.borderRadius.large` (string)
    Example: "8px"

  - `brandingVisibility` (object)
    Per-surface visibility of branding elements (e.g. hide the company logo on web but keep it in email). 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

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

## 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 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 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.