Skip to main content

Get site settings

GET 
/api/settings/site

Retrieves site settings.

Response sample

{
  "id": "string",
  "type": "string",
  "customerName": "string",
  "siteName": "string",
  "googleApiKey": "string",
  "googleMapId": "string",
  "googleAnalyticsFields": "string",
  "googleAnalyticsEvents": "string",
  "vtoApiKey": "string",
  "initializeWebDiaryBySiteNumber": true,
  "paymentProvider": "string",
  "paymentEnvironment": "string",
  "paymentProviderClientKey": "string",
  "customGuestBookingFields": [{
      "fieldName": "string",
      "mandatory": true,
      "visible": true,
      "mask": "string",
      "patientIdentifierType": 0,
      "labelKey": "string",
      "maxLength": 0 }],
  "googleMapDefaults": {
    "latitude": "string",
    "longitude": "string",
    "zoom": 0,
    "focusedZoom": 0 },
  "siteDefaults": {
    "timeZone": "string",
    "language": "string",
    "currency": "string" },
  "countryDefaults": {
    "alpha2ISOCode": "string",
    "alpha3ISOCode": "string" },
  "userInteractionMode": "string",
  "checkoutInteractionMode": "string",
  "measurementSystem": "string",
  "minimumContactLensPurchaseAge": 0,
  "storeFinderDisplayAgeRangeOptions": true,
  "minimumBookAppointmentAge": 0,
  "pdMasterToolProvider": "string",
  "pdMasterToolProviderApiKey": "string",
  "enforceValidPhoneNumberAndNonLocalRegionPrefix": true,
  "webDiaryCheckboxLabelAlignment": "string",
  "webDiaryDisplayPrivacyPolicyCheckbox": true,
  "enableAutoApplyingPromotions": true
}

Request​

Responses​

Success: Request accepted.