---
title: "GET /api/v1.0/whitelabelconfig/name/{appId}"
method: GET
path: "/api/v1.0/whitelabelconfig/name/{appId}"
tags: ["WhiteLabelConfig"]
---

# GET /api/v1.0/whitelabelconfig/name/{appId}

`GET /api/v1.0/whitelabelconfig/name/{appId}`

## Request

- Base URL: `https://api.flipdish.co`
- URL: `https://api.flipdish.co/api/v1.0/whitelabelconfig/name/{appId}`
- Auth: OAuth 2 (implicit, authorization URL `https://api.flipdish.co/identity/connect/authorize`, scopes: `api`)

## Path parameters

- `appId` string, required

## Response `200`

OK

- RestApiResultWhiteLabelConfigModel: Rest api result
  - `Data` WhiteLabelConfigModel, required: WhiteLabelConfig model
    - `WhiteLabelLanguages` WhiteLabelLanguageModel[]: White label languages
      - `LanguageId` string: Language ID
    - `WhiteLabelAssets` WhiteLabelAssetModel[]: White label assets
      - `WhiteLabelAssetId` integer: White label asset ID
      - `WhiteLabelConfigId` integer: White label configuration ID
      - `FilePath` string: File path
      - `Url` string: Asset URL
      - `TsUpdate` string, date-time: Timestamp update
    - `ColorScheme` WhiteLabelColorSchemeModel: White label color scheme model
      - `WhiteLabelColorSchemeId` integer: White label color scheme ID
      - `Font` string: Font
      - `Color` string: Color
      - `Color2` string: Color 2
      - `Color3` string: Color 3
      - `Color4` string: Color 4
      - `Color5` string: Color 5
      - `Color6` string: Color 6
      - `Color7` string: Color 7
      - `Color8` string: Color 8
      - `Color9` string: Color 9
      - `Color10` string: Color 10
      - `Color11` string: Color 11
      - `Color12` string: Color 12 (Kiosk Primary Colour)
    - `WhiteLabelConfigId` integer: White label configuration ID
    - `WhiteLabelId` integer: White label ID
    - `WhiteLabelName` string: White label name
    - `AppNameId` string: App name ID (Bundle ID Suffix)
    - `OrgId` string: Organization ID
    - `SmsRestaurantName` string: SMS restaurant name
    - `DeepLinkUrlScheme` string: Deep link URL scheme
    - `HostName` string: Host name
    - `NexmoSupportSmsNumber` string: Nexmo support SMS number
    - `TwilioSupportSmsNumber` string: Twilio support SMS number
    - `MixpanelToken` string: Mixpanel token
    - `IntercomAppId` string: Intercom app ID
    - `ShareMessageEmailSubject` string: Share message email subject
    - `ShareMessageEmailMessage` string: Share message email message
    - `ShareMessageSmsMessage` string: Share message SMS message
    - `ShareMessageWhatsAppMessage` string: Share message WhatsApp message
    - `ShareMessageFacebookMessage` string: Share message Facebook message
    - `ShareMessageTwitterMessage` string: Share message Twitter message
    - `ShareMessageGenericMessage` string: Share message generic message
    - `DisplayDeliveryRestaurantListScreen` boolean: Display delivery restaurant list screen
    - `ContactFormType` integer: Contact form type
    - `ContactPhoneNumber` string: Contact phone number
    - `DisplayBumpSideMenuItem` boolean: Display bump side menu item
    - `DisplayFreeCokeSideMenuItem` boolean: Display free coke side menu item
    - `AppStoreUrl` string: App store URL
    - `DeliveryEnabled` boolean: Delivery enabled
    - `PickupEnabled` boolean: Pickup enabled
    - `DisplayPickupRestaurantListScreen` boolean: Display pickup restaurant list screen
    - `DisplayCuisineTypeListAndRestaurantSearchBar` boolean: Display cuisine type list and restaurant search bar
    - `DisplayUserRestaurantRatings` boolean: Display user restaurant ratings
    - `ReadyToPublishWeb` boolean: Ready to publish web
    - `ReadyToPublishIos` boolean: Ready to publish iOS
    - `ReadyToPublishAndroid` boolean: Ready to publish Android
    - `DisplayFooterLinksToOtherSites` boolean: Display footer links to other sites
    - `DisplayOnlineOrderingMenu` boolean: Display online ordering menu
    - `HideAppConfigFromAdminList` boolean: Hide app config from admin list
    - `ComplianceType` 'Default' | 'GdprCompliance': Compliance type
    - `IsMenuMigratedToRms` boolean: Is menu migrated to RMS
    - `MapBoundryMaxLongitude` number, double, nullable: Map boundary max longitude
    - `MapBoundryMinLongitude` number, double, nullable: Map boundary min longitude
    - `MapBoundryMaxLatitude` number, double, nullable: Map boundary max latitude
    - `MapBoundryMinLatitude` number, double, nullable: Map boundary min latitude
    - `AppStoreAppleId` string: App store Apple ID
    - `AppStoreToken` string: App store token
    - `WebsiteDisplayStaticMenuPage` boolean: Website display static menu page
    - `IsEmbed` boolean, nullable: Is embed
    - `DisplayTipOptionToUsersByDefault` boolean: Display tip option to users by default
    - `EmailRequestMode` integer: Email request mode
    - `AddressEntryType` integer: Address entry type
    - `AddressLayout` integer: Address layout
    - `Category` integer: Category
    - `MapCenterLatitude` number, double: Map center latitude
    - `MapCenterLongitude` number, double: Map center longitude
    - `IntercomTokenIos` string: Intercom token iOS
    - `IntercomTokenAndroid` string: Intercom token Android
    - `GoogleAnalyticsTokensCsv` string: Google Analytics tokens CSV
    - `FacebookTokensCsv` string: Facebook tokens CSV
    - `ShareMessageGenericUrl` string: Share message generic URL
    - `PrivateSupportEmailAddress` string: Private support email address
    - `AppStoreId` string: App store ID
    - `PlayConsoleAccount` integer: Play console account
    - `ApnCertificateValidAfter` string, date-time, nullable: APN certificate valid after
    - `ApnCertificateValidBefore` string, date-time, nullable: APN certificate valid before
    - `DineInEnabled` boolean: Dine in enabled
    - `AppFont` string: App font
    - `WhiteLabelColorSchemeId` integer: White label color scheme ID
    - `WhiteLabelImagesId` integer: White label images ID
    - `AppStoreCopyright` string: App store copyright
    - `AppStoreDescription` string: App store description
    - `AppStoreShortDescription` string: App store short description
    - `AppStoreKeywords` string: App store keywords
    - `AppStoreMarketingUrl` string: App store marketing URL
    - `AppStoreName` string: App store name
    - `AppStorePrivacyUrl` string: App store privacy URL
    - `AppStoreSupportUrl` string: App store support URL
    - `AppStoreReleaseNotes` string: App store release notes
    - `AppStoreIconUrl` string: App store icon URL
    - `AppStoreIconThumbnail100Url` string: App store icon thumbnail 100 URL
    - `TransparentLogoUrl` string: Transparent logo URL
    - `LogoImageName` string: Logo image name
    - `KioskNameScreenImage` string: Kiosk name screen image
    - `WebToAppRedirect` integer: Web to app redirect
    - `FeaturesCsv` string: Features CSV
    - `AppStorePassword` string: App store password
    - `AppStoreTeamId` string: App store team ID
    - `AppStoreAppGroup` string: App store app group
    - `AppStoreSigningIdentity` string: App store signing identity
    - `AppStoreItcTeamId` string: App store ITC team ID
    - `HeadHtml` string: Head HTML
    - `SocialTwitterUrl` string: Social Twitter URL
    - `SocialFacebookUrl` string: Social Facebook URL
    - `SocialInstagramUrl` string: Social Instagram URL
    - `SocialPintrestUrl` string: Social Pinterest URL
    - `SocialTripAdvisorUrl` string: Social TripAdvisor URL
    - `SocialGooglePlusUrl` string: Social Google Plus URL
    - `SocialFourSquareUrl` string: Social FourSquare URL
    - `SocialYelpUrl` string: Social Yelp URL
    - `WebsiteType` integer: Website type
    - `ExternalOrderingPageUrl` string: External ordering page URL
    - `PanaceaEnabled` boolean: Panacea enabled
    - `CookieConsentPromptEnabled` boolean: Cookie consent prompt enabled
    - `PanaceaVanityUrl` string: Panacea vanity URL
    - `CountryId` string: Country ID
    - `ReferralUserId` integer, nullable: Referral user ID
    - `ReferralCampaignId` string: Referral campaign ID

## Other responses

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Successful authentication, but authorization has been denied for this request.
- `404`: NotFound

---

[API](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/revisions/4d8c2b9e1c13?raw)
