Skip to main content

​
Overview

The /v2/org-languages endpoint returns the full language configuration for an organisation. Use it to discover which languages are available before making localised content requests (e.g. passing lang to guide-search or listing-search). When translationEnabled is false, only the default language is available and the languages array will be empty.

​
Request

GET /v2/orgs/{orgId}/org-languages

​
Required parameters

ParameterTypeDescription
orgIdstringYour organisation ID.

​
Examples

​
Retrieve supported languages

Retrieve supported languages
curl "https://api.obvlo.com/v2/org-languages?orgId=YOUR_ORG_ID&key=YOUR_API_KEY"

​
Example response — translations enabled

Example response (translations enabled)
{
  "translationEnabled": true,
  "defaultLanguage": {
    "languageCode": "en-GB",
    "languageName": "English",
    "dialect": "British",
    "nativeName": "English",
    "isDefault": true,
    "isEnabled": true,
    "flagIconUrl": "https://cdn.obvlo.com/flags/gb.svg",
    "rtl": false,
    "currencyCode": "GBP",
    "currencySymbol": "£",
    "hour12": true,
    "measurement": "metric",
    "temperatureMetric": "celsius",
    "isLatinAlphabet": true
  },
  "languages": [
    {
      "languageCode": "en-GB",
      "languageName": "English",
      "dialect": "British",
      "nativeName": "English",
      "isDefault": true,
      "isEnabled": true,
      "flagIconUrl": "https://cdn.obvlo.com/flags/gb.svg",
      "rtl": false,
      "currencyCode": "GBP",
      "currencySymbol": "£",
      "hour12": true,
      "measurement": "metric",
      "temperatureMetric": "celsius",
      "isLatinAlphabet": true
    },
    {
      "languageCode": "fr-FR",
      "languageName": "French",
      "dialect": "Standard",
      "nativeName": "Français",
      "isDefault": false,
      "isEnabled": true,
      "flagIconUrl": "https://cdn.obvlo.com/flags/fr.svg",
      "rtl": false,
      "currencyCode": "EUR",
      "currencySymbol": "€",
      "hour12": false,
      "measurement": "metric",
      "temperatureMetric": "celsius",
      "isLatinAlphabet": true
    }
  ]
}

​
Example response — translations disabled

Example response (translations disabled)
{
  "translationEnabled": false,
  "defaultLanguage": {
    "languageCode": "en-GB",
    "languageName": "English",
    "dialect": "British",
    "nativeName": "English",
    "isDefault": true,
    "isEnabled": true,
    "flagIconUrl": "https://cdn.obvlo.com/flags/gb.svg",
    "rtl": false,
    "currencyCode": "GBP",
    "currencySymbol": "£",
    "hour12": true,
    "measurement": "metric",
    "temperatureMetric": "celsius",
    "isLatinAlphabet": true
  },
  "languages": []
}

​
Response fields

​
Top-level

FieldTypeDescription
translationEnabledbooleanWhether this organisation has multilingual content enabled.
defaultLanguageobjectFull locale metadata for the organisation’s default language. Always present.
languagesarrayFull locale metadata for each enabled language. Empty when translationEnabled is false.

​
Language object

FieldTypeDescription
languageCodestringBCP 47 language code (e.g. en-GB, fr-FR).
languageNamestringEnglish name of the language.
dialectstringRegional dialect label (e.g. British, Standard).
nativeNamestringLanguage name in its own script (e.g. Français).
isDefaultbooleantrue for the organisation’s default language.
isEnabledbooleanWhether this language is enabled in the platform.
flagIconUrlstringURL to a flag icon representing the language’s region.
rtlbooleantrue if the language is right-to-left (e.g. Arabic, Hebrew).
currencyCodestringISO 4217 currency code associated with the locale (e.g. GBP).
currencySymbolstringDisplay symbol for the currency (e.g. £).
hour12booleantrue if the locale uses a 12-hour clock.
measurementstringUnit system: metric or imperial.
temperatureMetricstringcelsius or fahrenheit.
isLatinAlphabetbooleantrue if the language uses the Latin alphabet.