Skip to main content

​
Overview

The /v2/host-profile endpoint returns the configuration profile for a given host. It is the authoritative source for branding, UI configuration, search defaults, and geo anchor data. Internal fields such as API keys, analytics tokens, and integration credentials are never included in the response.

​
Request

GET /v2/orgs/{orgId}/host-profile

​
Required parameters

ParameterTypeDescription
orgIdstringYour organisation ID.
profileIdstringID of the host profile to retrieve.

​
Optional parameters

ParameterTypeDefaultDescription
langstring—BCP 47 language code for localised fields (e.g. en, fr, de).

​
Examples

​
Retrieve a host profile

Retrieve a host profile
curl "https://api.obvlo.com/v2/host-profile?orgId=YOUR_ORG_ID&profileId=YOUR_HOST_ID&key=YOUR_API_KEY"

​
Example response

Example response
{
  "id": "hotel-grand",
  "name": "The Grand Hotel",
  "orgId": "YOUR_ORG_ID",
  "geoLocation": [51.5074, -0.1278],
  "primaryLocation": {
    "displayName": "The Grand Hotel",
    "address": "1 Grand Place, London",
    "locationId": "loc-001",
    "measurement": "metric",
    "geoLocation": { "lat": 51.5074, "lng": -0.1278 }
  },
  "searchConfig": {
    "searchRadius": 4000,
    "guideRanking": "relevance",
    "listingRanking": "score"
  },
  "embeddedConfigs": [
    {
      "id": "embed-config-001",
      "name": "Default Widget",
      "createdAt": 1700000000000,
      "selectedLayout": "Default"
    }
  ],
  "languageCodes": ["en-GB", "fr-FR"],
  "defaultLanguageCode": "en-GB",
  "currencyCode": "GBP",
  "currencySymbol": "£",
  "timeZoneName": "Europe/London",
  "weather": {
    "icon": "02d",
    "temperature": 14
  }
}

​
Response fields

FieldTypeDescription
idstringHost profile ID.
namestringDisplay name of the host.
orgIdstringOrganisation ID the host belongs to.
geoLocation[number, number]Coordinates as [latitude, longitude].
primaryLocationobjectLocation details for the host’s primary address.
searchConfigobjectDefault search radius and ranking preferences.
languageCodesstring[]Language codes supported by this host’s content.
defaultLanguageCodestringDefault language for content.
currencyCodestringISO 4217 currency code (e.g. GBP).
currencySymbolstringDisplay currency symbol (e.g. £).
timeZoneNamestringIANA time zone name (e.g. Europe/London).
uiConfigobjectUI configuration for the host interface.
brandingobjectBranding colours and typography.
logosobject[]Logo assets for the host.
pagesobject[]Custom page configurations.
weatherobjectCurrent weather snapshot (icon, temperature in Celsius).
perksobjectPerks/amenities header and sections.
socialMediaobject[]Social media links.
travellerArchetypesobject[]Configured traveller archetypes for personalisation.
embeddedConfigsobject[]Array of embedded UI module configuration objects. Shape determined by the host’s configured modules.
activeIntegrationsstring[]List of active third-party integration identifiers.