Skip to main content

Retrieve settings

GET 
https://api.elfsquad.io/configurator/:version/configurator/settings

Settings that can be applied to the configurator such as theme preferences

Request​

Path Parameters

    version stringrequired

Query Parameters

    lang string

    (Optional) Language ISO

Responses​

Success

Schema
    iduuid
    organizationIduuidnullable
    referencestringnullable
    syncedboolean
    createdDatedate-time
    updatedDatedate-time
    domainstringnullable
    requireLoginboolean
    primaryColorstringnullable
    primaryFontColorstringnullable
    accentColorstringnullable
    accentFontColorstringnullable
    fontFamilystringnullable
    faviconUrlstringnullable
    enableWelcomePageboolean
    enableProductPageboolean
    enableOverviewPageboolean
    enableMultipleConfigurationsboolean
    productSelectionBackgroundUrlstringnullable
    welcomeBackgroundUrlstringnullable
    welcomeYoutubeIdstringnullable
    welcomeTexts object[]nullable
  • Array [
    • iduuid
    organizationIduuidnullable
    referencestringnullable
    syncedboolean
    createdDatedate-time
    updatedDatedate-time
    valuestringnullable
    languageIsostringnullable

    Possible values: <= 16 characters

    settingsIduuidnullable
    showroomSettingsIduuidnullable
  • ]
    • languageIsosstring[]nullable
    countries object[]nullable
  • Array [
    • isostringnullable
    namestringnullable
    activeboolean
    englishNamestringnullable
    phonePrefixstringnullable
    capitalstringnullable
  • ]
    • displayVatboolean
    logoUrlstringnullable
    mandatoryCrmValuesstringnullable
    mandatoryCrmContactValuesstringnullable
    quotationRequestRedirectUrlstringnullable
    quotationRequestedActionint32

    DisplayThankYouPopup, RedirectTo

    Possible values: [0, 1]

    allowDifferentShipToAddressboolean
    requiredQuotationFieldsstring[]nullable
    customCssstringnullable
    privacyPolicyAppendixIFramestringnullable
    enable3dFootprintboolean
    enable3dLabelboolean
    displayCreateQuotationInLastStepboolean
    displayedShowroomCrmFieldsstring[]nullable
    googleAnalyticsCodestringnullabledeprecated
    googleTagManagerContainerIdstringnullable

    Possible values: <= 12 characters

    afterOrderTexts object[]nullable
  • Array [
    • iduuid
    organizationIduuidnullable
    referencestringnullable
    syncedboolean
    createdDatedate-time
    updatedDatedate-time
    valuestringnullable
    languageIsostringnullable

    Possible values: <= 16 characters

    settingsIduuidnullable
    showroomSettingsIduuidnullable
  • ]
    • attachPdfToMailboolean
    sendMailToCustomerboolean
    quotationCustomMailTexts object[]nullable
  • Array [
    • iduuid
    organizationIduuidnullable
    referencestringnullable
    syncedboolean
    createdDatedate-time
    updatedDatedate-time
    subjectstringnullable
    valuestringnullable
    languageIsostringnullable

    Possible values: <= 16 characters

    settingsIduuidnullable
    showroomSettingsIduuidnullable
  • ]
    • defaultVatIduuidnullable
    defaultVat object
    iduuid
    organizationIduuidnullable
    referencestringnullable
    syncedboolean
    createdDatedate-time
    updatedDatedate-time
    namestringnullable
    pctdouble
    pctStringstringnullable
    includesVATboolean
    defaultVatboolean
    coefficientdouble
    currencyIsostringnullable
    enableCustomFeatureModelSettingsboolean
    showroomFeatureModelSettings object[]nullable
  • Array [
    • iduuid
    organizationIduuidnullable
    referencestringnullable
    syncedboolean
    createdDatedate-time
    updatedDatedate-time
    showroomSettingsIduuid
    featureModelIduuid
    allowedToSellboolean
    displayPricesboolean
  • ]
    • hideCustomerFieldboolean
    hideDeliveryDateFieldboolean
    hideRemarksFieldboolean
    hideShippingAddressFieldboolean
    checkoutQuotationPropertyIdsstring[]nullable
    defaultCulturestringnullable

    Possible values: <= 10 characters

    sendQuotationRequestMailstringnullable
    onConfigurationLeavePopupboolean
    productPageDefaultPageSizeint32
    hasCustomerPortalEnabledboolean
    enableRecaptchaboolean
    recaptchaSecretKeystringnullable
    recaptchaSiteKeystringnullable
    selectedLanguageIsostringnullable
    afterOrderTextstringnullable
    allowGroupAmountboolean
    languages object[]nullable
  • Array [
    • isostringnullable
    namestringnullable
    activeboolean
    englishNamestringnullable
  • ]

Authorization: oauth2

name: oauth2type: oauth2scopes: openid,profile,email,offline_access,Elfskot.Apiflows: {
  "clientCredentials": {
    "tokenUrl": "https://login.elfsquad.io/oauth2/token",
    "scopes": {
      "Elfskot.Api": "Elfskot.Api"
    }
  },
  "authorizationCode": {
    "authorizationUrl": "https://login.elfsquad.io/oauth2/authorize",
    "tokenUrl": "http://localhost:4444/oauth2/token",
    "scopes": {
      "openid": "openid",
      "profile": "profile",
      "email": "email",
      "offline_access": "offline_access",
      "Elfskot.Api": "Elfskot.Api"
    }
  }
}
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.elfsquad.io/configurator/:version/configurator/settings");
request.Headers.Add("Accept", "text/plain");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://api.elfsquad.io
Auth
Parameters
— pathrequired
— query
ResponseClear

Click the Send API Request button above and see the response here!