v1

latestOpenAPI 3.1.02026-08-0662251219.8 KB
Companies

Get white label config

This endpoint fetches the white label config for the company.

get/v2/companies/{companyId}/white-label-config

Query parameters

companyRole'ORG' | 'TMC' | 'PARTNER_TMC' | 'HR_FEED_CONNECTOR' | 'TRIPS_DATA_CONNECTOR' | 'GLOBAL' required

Role of the company.

Example:ORG
applicationIdstring uuid

Application context to get white label config.

Response

OK

companyNamestring
fromEmailAddressstring
fontFamilystring
emailFontFamilystring
fontFamilyCssstring
clientRoutingBasePathstring

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

visaRequirementsstring

Rich text content for visa requirements information

Example 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",
    "logoutRedirectUrl": "https://www.spotnana.com/signout",
    "faviconUrl": "http://www.spotnana.com",
    "appDownloadLinks": {
      "androidPlayStoreUrl": "https://play.google.com/store/apps/details?id=com.spotnana",
      "iosAppStoreUrl": "https://apps.apple.com/in/app/spotnana-travel-booking/id1580021446",
      "qrCodeUrl": "https://www.spotnana.com"
    },
    "socialMediaLinks": {
      "facebookUrl": "https://www.facebook.com/spotnanaofficial",
      "twitterUrl": "https://twitter.com/spotnana",
      "instagramUrl": "https://www.instagram.com/spotnana_official"
    },
    "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",
    "takeActionPath": "https://partner.com/embedded/take-action",
    "bookMyTripPath": "https://partner.com/embedded/my-trip",
    "viewEventDetailsPath": "https://partner.com/embedded/my-trip"
  },
  "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": {
      "emailClientSecretKey": {
        "secretKey": "SECRET_KEY",
        "versionId": "1"
      }
    },
    "defaultSenderAddress": "test@somedomain.com",
    "defaultSenderName": "Test Sender"
  },
  "routingConfig": {
    "appHomeRoute": "/my-account"
  },
  "privacyDisclaimer": {
    "html": "</html>"
  },
  "visaRequirements": "<p>Please ensure you have the necessary visa documentation before traveling.</p>",
  "themeConfig": {
    "fontFamily": [
      "Inter",
      "Arial",
      "sans-serif"
    ],
    "palette": {
      "light": {
        "bg": {
          "surface": "#FFFFFF",
          "surface02": "#F7F7F7",
          "brand": "#D33B47",
          "brandSubtle": "#FBE9EA",
          "brandHover": "#B73039"
        },
        "text": {
          "primary": "#1A1A1A",
          "secondary": "#6B6B6B",
          "brand": "#D33B47",
          "link": "#1F6FEB"
        },
        "border": {
          "light": "#E5E5E5",
          "medium": "#CCCCCC",
          "dark": "#999999",
          "brand": "#D33B47",
          "brandSubtle": "#F3C6C9",
          "hover": "#B73039"
        },
        "icon": {
          "brand": "#D33B47"
        }
      },
      "dark": {
        "bg": {
          "surface": "#FFFFFF",
          "surface02": "#F7F7F7",
          "brand": "#D33B47",
          "brandSubtle": "#FBE9EA",
          "brandHover": "#B73039"
        },
        "text": {
          "primary": "#1A1A1A",
          "secondary": "#6B6B6B",
          "brand": "#D33B47",
          "link": "#1F6FEB"
        },
        "border": {
          "light": "#E5E5E5",
          "medium": "#CCCCCC",
          "dark": "#999999",
          "brand": "#D33B47",
          "brandSubtle": "#F3C6C9",
          "hover": "#B73039"
        },
        "icon": {
          "brand": "#D33B47"
        }
      }
    },
    "overrides": {
      "button": {
        "borderRadius": {
          "small": "4px",
          "medium": "6px",
          "large": "8px"
        }
      }
    }
  },
  "brandingVisibility": {
    "headerLogo": {
      "hideOnWeb": true
    },
    "poweredBy": {
      "hideOnWeb": true
    }
  }
}