Get Organisation Languages

cURL

curl --request GET \
  --url 'https://api.obvlo.com/v2/orgs/{orgId}/org-languages?key='

import requests

url = "https://api.obvlo.com/v2/orgs/{orgId}/org-languages?key="

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.obvlo.com/v2/orgs/{orgId}/org-languages?key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "translationEnabled": true,
  "defaultLanguage": {
    "languageCode": "<string>",
    "languageName": "<string>",
    "dialect": "<string>",
    "nativeName": "<string>",
    "isDefault": true,
    "isEnabled": true,
    "flagIconUrl": "<string>",
    "currencyCode": "<string>",
    "currencySymbol": "<string>",
    "hour12": true,
    "measurement": "<string>",
    "temperatureMetric": "<string>",
    "isLatinAlphabet": true,
    "rtl": true
  },
  "languages": [
    {
      "languageCode": "<string>",
      "languageName": "<string>",
      "dialect": "<string>",
      "nativeName": "<string>",
      "isDefault": true,
      "isEnabled": true,
      "flagIconUrl": "<string>",
      "currencyCode": "<string>",
      "currencySymbol": "<string>",
      "hour12": true,
      "measurement": "<string>",
      "temperatureMetric": "<string>",
      "isLatinAlphabet": true,
      "rtl": true
    }
  ]
}

GET

orgs

{orgId}

org-languages

cURL

curl --request GET \
  --url 'https://api.obvlo.com/v2/orgs/{orgId}/org-languages?key='

import requests

url = "https://api.obvlo.com/v2/orgs/{orgId}/org-languages?key="

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.obvlo.com/v2/orgs/{orgId}/org-languages?key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "translationEnabled": true,
  "defaultLanguage": {
    "languageCode": "<string>",
    "languageName": "<string>",
    "dialect": "<string>",
    "nativeName": "<string>",
    "isDefault": true,
    "isEnabled": true,
    "flagIconUrl": "<string>",
    "currencyCode": "<string>",
    "currencySymbol": "<string>",
    "hour12": true,
    "measurement": "<string>",
    "temperatureMetric": "<string>",
    "isLatinAlphabet": true,
    "rtl": true
  },
  "languages": [
    {
      "languageCode": "<string>",
      "languageName": "<string>",
      "dialect": "<string>",
      "nativeName": "<string>",
      "isDefault": true,
      "isEnabled": true,
      "flagIconUrl": "<string>",
      "currencyCode": "<string>",
      "currencySymbol": "<string>",
      "hour12": true,
      "measurement": "<string>",
      "temperatureMetric": "<string>",
      "isLatinAlphabet": true,
      "rtl": true
    }
  ]
}

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

Parameter	Type	Description
`orgId`	string	Your organisation ID.

Examples

Retrieve supported languages

curl "https://api.obvlo.com/v2/orgs/YOUR_ORG_ID/org-languages?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

Field	Type	Description
`translationEnabled`	boolean	Whether this organisation has multilingual content enabled.
`defaultLanguage`	object	Full locale metadata for the organisation’s default language. Always present.
`languages`	array	Full locale metadata for each enabled language. Empty when `translationEnabled` is `false`.

Language object

Field	Type	Description
`languageCode`	string	BCP 47 language code (e.g. `en-GB`, `fr-FR`).
`languageName`	string	English name of the language.
`dialect`	string	Regional dialect label (e.g. `British`, `Standard`).
`nativeName`	string	Language name in its own script (e.g. `Français`).
`isDefault`	boolean	`true` for the organisation’s default language.
`isEnabled`	boolean	Whether this language is enabled in the platform.
`flagIconUrl`	string	URL to a flag icon representing the language’s region.
`rtl`	boolean	`true` if the language is right-to-left (e.g. Arabic, Hebrew).
`currencyCode`	string	ISO 4217 currency code associated with the locale (e.g. `GBP`).
`currencySymbol`	string	Display symbol for the currency (e.g. `£`).
`hour12`	boolean	`true` if the locale uses a 12-hour clock.
`measurement`	string	Unit system: `metric` or `imperial`.
`temperatureMetric`	string	`celsius` or `fahrenheit`.
`isLatinAlphabet`	boolean	`true` if the language uses the Latin alphabet.

Authorizations

key

string

query

required

Path Parameters

orgId

string

required

Organization Account Number

Response

Success

translationEnabled

boolean

required

defaultLanguage

object

required

Show child attributes

languages

object[]

required

Show child attributes

Get Host Home

API Changelog

⌘I

Getting started

API

API reference

Widget implementation

Microsite implementation

Infrastructure guides

Language support

Preview

Overview

Request

Required parameters

Examples

Retrieve supported languages

Example response — translations enabled

Example response — translations disabled

Response fields

Top-level

Language object

Authorizations

Path Parameters

Response

​Overview

​Request

​Required parameters

​Examples

​Retrieve supported languages

​Example response — translations enabled

​Example response — translations disabled

​Response fields

​Top-level

​Language object

Authorizations

Path Parameters

Response

Overview

Request

Required parameters

Examples

Retrieve supported languages

Example response — translations enabled

Example response — translations disabled

Response fields

Top-level

Language object