Get white label config

Request

This endpoint fetches the white label config for the company.

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947

Query

companyRolestring(CompanyRole)required

Role of the company.

Enum:"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"

Example:companyRole=ORG

applicationIdstring, (uuid)

Application context to get white label config.

Example:applicationId=1234a66b-7493-4f41-908c-58ba81055667

curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/white-label-config?companyRole=ORG&applicationId=1234a66b-7493-4f41-908c-58ba81055667' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

companyNamestring

Example:"Spotnana"

colorsobject(ColorWhitelabelConfig)

Whitelabel configuration related to colours.

webLinksobject(WebLinksConfig)

Weblinks which are parts of WhiteLabelConfig.

fromEmailAddressstring

Example:"no-reply@spotnana.com"

fontFamilystring

Default:"Arial"

Example:"Arial"

emailFontFamilystring

Default:"Roboto"

Example:"Roboto"

fontFamilyCssstring

Example:"https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css"

emailClientConfigobject(EmailClientConfig)

Email client configuration representing the email provider to be used.

clientRoutingBasePathstring

Base path used by Spotnana OBT application to invoke API calls. Default path value is /

routingConfigobject(RoutingConfig)

App routing configuration.

privacyDisclaimerobject(PrivacyDisclaimer)

Html to shown on the the login page. This will be text with hyper links.

visaRequirementsstring

Rich text content for visa requirements information

Example:"<p>Please ensure you have the necessary visa documentation before traveling.</p>"

themeConfigobject(ThemeConfigV2)

Theming V2 — additive, opt-in. Unset falls back to V1 (colors / fontFamily).

brandingVisibilityobject(BrandingVisibility)

Per-surface visibility of branding elements (e.g. hide the company logo on web but keep it in email). Additive — default shows everything.

emailTemplatesConfigobject(EmailTemplatesConfig)

Per-tenant email template overrides. Unset falls back to the generic template for each email.

Response

{
  "companyName": "Spotnana",
  "colors": {
    "primary": "#D33B47",
    "primaryDark": "#D33B47",
    "primaryLight": "#D33B47",
    "primaryPale": "#D33B47",
    "onPrimary": "#D33B47",
    "secondary": "#D33B47",
    "secondaryDark": "#D33B47",
    "secondaryLight": "#D33B47",
    "secondaryPale": "#D33B47",
    "onSecondary": "#D33B47",
    "error": "#D33B47",
    "errorDark": "#D33B47",
    "errorLight": "#D33B47",
    "errorPale": "#D33B47",
    "onError": "#D33B47"
  },
  "webLinks": {
    "logoHeader": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/confirmation/spotnana3.png",
    "logoFooter": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
    "companyWebsiteAddress": "https://www.spotnana.com",
    "homePage": "https://stage-app.spotnana.com/flights",
    "itineraryPage": "https://stage-app.spotnana.com/trips/3375488451",
    "disclaimerPage": "https://www.spotnana.com/terms",
    "privacyPage": "https://www.spotnana.com/privacy-policy",
    "hardApprovalUrl": "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",
    "itineraryFlightStatsUrl": "https://stage-app.spotnana.com/trips/4694735622",
    "appEmbedScriptUrl": "https://customjs.partner.com",
    "logoNavigationLink": "http://www.spotnana.com",
    "illustration": "https://duploservices-stage-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
    "poweredBySpotnana": false,
    "logoutRedirectUrl": "https://www.spotnana.com/signout",
    "faviconUrl": "http://www.spotnana.com",
    "appDownloadLinks": { … },
    "socialMediaLinks": { … },
    "termsOfUse": "https://www.spotnana.com/terms/",
    "illustrationActionUrl": "https://www.spotnana.com/login",
    "checkoutCoverImageUrl": "https://duploservices-email-assets-873909615026.s3-us-west-2.amazonaws.com/approval/spotnana-s-logo.png",
    "postCcVerificationCallbackUrl": "https://example.com/callback",
    "loyaltyLinkedImageUrl": "https://example.com/loyalty-linked.png",
    "onboardingFinalizeImageUrl": "https://example.com/onboarding-finalize.png",
    "inviteUserImageUrl": "https://example.com/invite-user.png",
    "enrollmentSuccessImageUrl": "https://example.com/enrollment-success.png",
    "takeActionPath": "https://partner.com/embedded/take-action",
    "bookMyTripPath": "https://partner.com/embedded/my-trip",
    "viewEventDetailsPath": "https://partner.com/embedded/my-trip",
    "downloadPath": "https://partner.com/embedded/download/%s"
  },
  "fromEmailAddress": "no-reply@spotnana.com",
  "fontFamily": "Arial",
  "emailFontFamily": "Roboto",
  "fontFamilyCss": "https://duploservices-stage-email-assets-873909615026.s3.us-west-2.amazonaws.com/partners/amazon/emberDisplay.css",
  "emailClientConfig": {
    "client": "SENDGRID",
    "credentials": { … },
    "defaultSenderAddress": "test@somedomain.com",
    "defaultSenderName": "Test Sender"
  },
  "clientRoutingBasePath": "string",
  "routingConfig": {
    "appHomeRoute": "/my-account"
  },
  "privacyDisclaimer": {
    "show": true,
    "html": "</html>"
  },
  "visaRequirements": "<p>Please ensure you have the necessary visa documentation before traveling.</p>",
  "themeConfig": {
    "fontFamily": [ … ],
    "palette": { … },
    "overrides": { … },
    "shape": { … }
  },
  "brandingVisibility": {
    "headerLogo": { … },
    "poweredBy": { … }
  },
  "emailTemplatesConfig": {
    "onboardingTemplateName": "ONBOARDING_INVITATION"
  }
}