Skip to main content
GET
/
v2
/
orgs
/
{orgId}
/
host-profile
cURL
curl --request GET \
  --url 'https://api.obvlo.com/v2/orgs/{orgId}/host-profile?key='
{
  "id": "<string>",
  "name": "<string>",
  "orgId": "<string>",
  "geoLocation": [
    123
  ],
  "primaryLocation": {
    "displayName": "<string>",
    "address": "<string>",
    "locationId": "<string>",
    "measurement": "<string>",
    "geoLocation": {
      "lat": 123,
      "lng": 123
    }
  },
  "searchConfig": {
    "searchRadius": 123,
    "guideRanking": "<string>",
    "listingRanking": "<string>",
    "maxSearchResults": 123
  },
  "languageCodes": [
    "<string>"
  ],
  "defaultLanguageCode": "<string>",
  "distanceMetric": "imperial",
  "currencyCode": "<string>",
  "currencySymbol": "<string>",
  "timeZoneName": "<string>",
  "stage": "<string>",
  "analytics": {
    "googleTagId": "<string>",
    "facebookPixelId": "<string>"
  },
  "feedback": {
    "npsWatermark": 123,
    "csatLevels": {
      "totalEvents": 123,
      "prsClicks": 123,
      "totalPlaceViews": 123,
      "totalPicklistViews": 123,
      "type": "<string>",
      "validTags": [
        "<string>"
      ],
      "askFeedback": true,
      "minSessionDuration": 123,
      "minSessions": 123
    }
  },
  "integrations": {
    "oracleOhip": {
      "clientId": "<string>",
      "clientSecret": "<string>",
      "username": "<string>",
      "password": "<string>",
      "hotelId": "<string>",
      "hostName": "<string>"
    },
    "mews": {
      "accessToken": "<string>",
      "clientToken": "<string>",
      "platformAddress": "<string>"
    }
  },
  "tsAPIKey": {
    "id": 123,
    "value": "<string>",
    "createdAt": 123,
    "host": "<string>"
  },
  "uiConfig": {
    "banner": {
      "image": {
        "url": "<string>",
        "path": "<string>",
        "width": 123,
        "height": 123,
        "classifications": [
          "<string>"
        ],
        "caption": "<string>",
        "type": "<string>"
      },
      "text": "<string>",
      "backgroundColor": "<string>",
      "textColor": "<string>",
      "LogoColor": "dark",
      "ctaLabel": "<string>",
      "ctaIconClass": "<string>",
      "showLogo": true,
      "showLocation": true,
      "showWeather": true
    },
    "loadingBanner": {
      "image": {
        "url": "<string>",
        "path": "<string>",
        "width": 123,
        "height": 123,
        "classifications": [
          "<string>"
        ],
        "caption": "<string>",
        "type": "<string>"
      },
      "LogoColor": "dark",
      "backgroundColor": "<string>",
      "textColor": "<string>"
    },
    "neighborhoods": true,
    "prsModules": [
      "<string>"
    ],
    "preferredTravelMode": "DRIVING",
    "contact": {
      "email": "<string>",
      "phone": "<string>",
      "website": "<string>"
    },
    "customMapMarkerUrl": "<string>",
    "featured": {
      "label": "<string>",
      "shortLabel": "<string>",
      "iconUrl": "<string>",
      "colors": {
        "name": "<string>",
        "hex": "<string>",
        "darkContrast": true,
        "hexContrast": "<string>"
      },
      "cornerRadius": {}
    }
  },
  "branding": {
    "colors": {
      "primary": "<string>",
      "background": "<string>"
    },
    "fonts": {
      "primary": "<string>",
      "secondary": "<string>",
      "letterSpacingHeaders": 123,
      "letterSpacingBody": 123,
      "lineHeightHeaders": 123,
      "lineHeightBody": 123,
      "fontSizeHeaders": 123,
      "fontSizeBody": 123
    },
    "theme": {
      "colors": {
        "primary": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary100": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary200": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary300": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary400": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary500": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary600": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary700": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary800": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "primary900": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary100": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary200": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary300": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary400": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary500": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary600": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary700": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary800": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "secondary900": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "background": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "backgroundContrast": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "success": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "warning": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "error": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "highEmphasis": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "mediumEmphasis": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "disabled": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "onSurface": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "onSurfaceHighEmphasis": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "onSurfaceMediumEmphasis": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        },
        "onSurfaceDisabled": {
          "textColor": "<string>",
          "backgroundColor": "<string>"
        }
      },
      "fonts": {
        "desktop": {
          "header1": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header2": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header3": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header4": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header5": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header6": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "subtitle1": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "subtitle2": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "body1": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "body2": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "button": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "caption": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "captionBold": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "overline": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "overlineBold": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          }
        },
        "mobile": {
          "header1": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header2": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header3": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header4": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header5": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "header6": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "subtitle1": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "subtitle2": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "body1": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "body2": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "button": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "caption": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "captionBold": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "overline": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          },
          "overlineBold": {
            "name": "<string>",
            "font": "<string>",
            "weight": 123,
            "size": 123,
            "lineHeight": 123,
            "letterSpacing": 123
          }
        },
        "customFonts": [
          {
            "name": "<string>",
            "url": "<string>"
          }
        ]
      }
    },
    "logos": {
      "dark": "<string>",
      "light": "<string>",
      "attrs": {
        "bannerLogo": "dark",
        "loadingBannnerLogo": "dark",
        "width": 123,
        "height": 123
      }
    },
    "customFont": {
      "name": "<string>",
      "url": "<string>"
    },
    "favicon": "<string>"
  },
  "logos": [
    {
      "description": "<string>",
      "file": {
        "url": "<string>",
        "path": "<string>",
        "width": 123,
        "height": 123,
        "classifications": [
          "<string>"
        ],
        "caption": "<string>",
        "type": "<string>"
      },
      "height": 123,
      "logoColor": "dark",
      "name": "<string>",
      "url": "<string>",
      "width": 123
    }
  ],
  "pages": [
    {
      "label": "<string>",
      "type": "<string>",
      "enabled": true,
      "path": "<string>",
      "icons": {
        "active": "<string>",
        "inactive": "<string>"
      }
    }
  ],
  "weather": {
    "id": 123,
    "weatherLocation": "<string>",
    "temperature": 123,
    "tempMetric": "<string>",
    "icon": "<string>"
  },
  "perks": {
    "header": "<string>",
    "sections": [
      "<string>"
    ]
  },
  "socialMedia": [
    {
      "name": "<string>",
      "url": "<string>",
      "icon": "<string>",
      "target": "<string>"
    }
  ],
  "travellerArchetypes": [
    {
      "id": "<string>",
      "name": "<string>",
      "travelPurpose": [
        "<string>"
      ],
      "activityTags": [
        "<string>"
      ],
      "archetypeTags": [
        "<string>"
      ],
      "codeNames": [
        "<string>"
      ],
      "travellerTypes": [
        "<string>"
      ]
    }
  ],
  "redirectUrls": [
    {
      "url": "<string>",
      "label": "<string>",
      "type": "<string>",
      "enabled": true
    }
  ],
  "linkTree": {
    "sections": [
      {
        "title": "<string>",
        "links": [
          {
            "label": "<string>",
            "url": "<string>",
            "icon": "<string>",
            "copyCaption": true,
            "type": "<string>",
            "enabled": true,
            "trackingEventName": "<string>"
          }
        ]
      }
    ]
  },
  "activeIntegrations": [
    "<string>"
  ],
  "embeddedConfigs": [
    {
      "id": "<string>",
      "createdAt": 123,
      "name": "<string>",
      "selectedLayout": "Blog",
      "updatedAt": 123,
      "updatedBy": "<string>",
      "createdBy": "<string>",
      "customIconUrl": "<string>",
      "description": "<string>",
      "kioskMode": true,
      "disableJustForYou": true,
      "disableAnimations": true,
      "disableSavedListings": true,
      "modules": [
        "Banner"
      ],
      "requirePreferences": true,
      "preferredTravelMode": "DRIVING",
      "menuOptions": [
        {
          "name": "Search",
          "label": "<string>",
          "iconClass": "<string>"
        }
      ],
      "containerOptions": {
        "padding": {
          "top": 123,
          "right": 123,
          "bottom": 123,
          "left": 123
        },
        "maxWidth": 123,
        "map": {
          "width": "<string>",
          "height": "<string>"
        }
      },
      "drawer": true,
      "drawerDelayMs": 123,
      "gridRows": 123,
      "gridRowsMobile": 123,
      "hideTravel": true,
      "hideGuideHeader": true,
      "hideLanguageSelector": true,
      "lang": "<string>",
      "cornerRadius": {
        "card": {
          "topLeft": 123,
          "topRight": 123,
          "bottomLeft": 123,
          "bottomRight": 123
        },
        "button": {
          "topLeft": 123,
          "topRight": 123,
          "bottomLeft": 123,
          "bottomRight": 123
        }
      }
    }
  ]
}

Authorizations

key
string
query
required

Path Parameters

orgId
string
required

Organization Account Number

Query Parameters

profileId
string
required

Unique profile identifier

lang
string

BCP-47 language code (e.g. en-GB). When provided, localizable fields are returned as a single string instead of a language map.

Response

Success

id
string
required
name
string
required
orgId
string
required
geoLocation
number[]
Required array length: 2 elements
primaryLocation
object
searchConfig
object
languageCodes
string[]
defaultLanguageCode
string
distanceMetric
enum<string>
Available options:
imperial,
metric
currencyCode
string
currencySymbol
string
timeZoneName
string
stage
string
analytics
object
feedback
object
integrations
object
tsAPIKey
object
uiConfig
object
branding
object
logos
object[]
pages
object[]
weather
object
perks
object
socialMedia
object[]
travellerArchetypes
object[]
redirectUrls
object[]
activeIntegrations
string[]
embeddedConfigs
object[]