Locale

These are the endpoints that are available under the /locale path, which lists all the different locales that are available on your business account.

Endpoint	Description
GET /locale	Returns a locale object with a list of key-value pairs.

There are no parameters included with locale calls.

GET /locale

{
    "ar": "Arabic",
    "ar-AE": "Arabic (United Arab Emirates)",
    "ar-BH": "Arabic (Bahrain)",
    "ar-DZ": "Arabic (Algeria)",
    "ar-EG": "Arabic (Egypt)",
    "ar-IQ": "Arabic (Iraq)",
    "ar-JO": "Arabic (Jordan)",
    "ar-KW": "Arabic (Kuwait)",
    "ar-LB": "Arabic (Lebanon)",
    "ar-LY": "Arabic (Libya)",
    "ar-MA": "Arabic (Morocco)",
    "ar-OM": "Arabic (Oman)",
    "ar-QA": "Arabic (Qatar)",
    "ar-SA": "Arabic (Saudi Arabia)",
    "ar-SD": "Arabic (Sudan)",
    "ar-SY": "Arabic (Syria)",
    "ar-TN": "Arabic (Tunisia)",
    "ar-YE": "Arabic (Yemen)",
    "be": "Belarusian",
    "be-BY": "Belarusian (Belarus)",
    "bg": "Bulgarian",
    "bg"-BG: "Bulgarian (Bulgaria)",
    "ca": "Catalan",
    "ca-ES": "Catalan (Spain)",
    "cs": "Czech",
    "cs-CZ": "Czech (Czech Republic)",
    "da": "Danish",
    "da-DK": "Danish (Denmark)",
    "de": "German",
    "de-AT": "German (Austria)",
    "de-CH": "German (Switzerland)",
    "de-DE": "German (Germany)",
    "de-GR": "German (Greece)",
    "de-LU": "German (Luxembourg)",
    "el": "Greek",
    "el-CY": "Greek (Cyprus)",
    "el-GR": "Greek (Greece)",
    "en": "English",
    "en-AU": "English (Australia)",
    "en-CA": "English (Canada)",
    "en-GB": "English (United Kingdom)",
    "en-IE": "English (Ireland)",
    "en-IN": "English (India)",
    "en-MT": "English (Malta)",
    "en-NZ": "English (New Zealand)",
    "en-PH": "English (Philippines)",
    "en-SG": "English (Singapore)",
    "en-US": "English (United States)",
    "en-ZA": "English (South Africa)",
    "es": "Spanish",
    "es-AR": "Spanish (Argentina)",
    "es-BO": "Spanish (Bolivia)",
    "es-CL": "Spanish (Chile)",
    "es-CO": "Spanish (Colombia)",
    "es-CR": "Spanish (Costa Rica)",
    "es-CU": "Spanish (Cuba)",
    "es-DO": "Spanish (Dominican Republic)",
    "es-EC": "Spanish (Ecuador)",
    "es-ES": "Spanish (Spain)",
    "es-GT": "Spanish (Guatemala)",
    "es-HN": "Spanish (Honduras)",
    "es-MX": "Spanish (Mexico)",
    "es-NI": "Spanish (Nicaragua)",
    "es-PA": "Spanish (Panama)",
    "es-PE": "Spanish (Peru)",
    "es-PR": "Spanish (Puerto Rico)",
    "es-PY": "Spanish (Paraguay)",
    "es-SV": "Spanish (El Salvador)",
    "es-US": "Spanish (United States)",
    "es-UY": "Spanish (Uruguay)",
    "es-VE": "Spanish (Venezuela)",
    "et": "Estonian",
    "et-EE": "Estonian (Estonia)",
    "fi": "Finnish",
    "fi-FI": "Finnish (Finland)",
    "fr": "French",
    "fr-BE": "French (Belgium)",
    "fr-CA": "French (Canada)",
    "fr-CH": "French (Switzerland)",
    "fr-FR": "French (France)",
    "fr-LU": "French (Luxembourg)",
    "ga": "Irish",
    "ga-IE": "Irish (Ireland)",
    "he": "Hebrew",
    "he-IL": "Hebrew (Israel)",
    "hi": "Hindi",
    "hi-IN": "Hindi (India)",
    "hr": "Croatian",
    "hr-HR": "Croatian (Croatia)",
    "hu": "Hungarian",
    "hu-HU": "Hungarian (Hungary)",
    "id": "Indonesian",
    "id-ID": "Indonesian (Indonesia)",
    "is": "Icelandic",
    "is-IS": "Icelandic (Iceland)",
    "it": "Italian",
    "it-CH": "Italian (Switzerland)",
    "it-IT": "Italian (Italy)",
    "ja": "Japanese",
    "ja-JP": "Japanese (Japan)",
    "ja-JP-u-ca-japanese-x-lvariant-JP": "Japanese (Japan,JP)",
    "ko": "Korean",
    "ko-KR": "Korean (South Korea)",
    "lt": "Lithuanian",
    "lt-LT": "Lithuanian (Lithuania)",
    "lv": "Latvian",
    "lv-LV": "Latvian (Latvia)",
    "mk": "Macedonian",
    "mk-MK": "Macedonian (Macedonia)",
    "ms": "Malay",
    "ms-MY": "Malay (Malaysia)",
    "mt": "Maltese",
    "mt-MT": "Maltese (Malta)",
    "nl": "Dutch",
    "nl-BE": "Dutch (Belgium)",
    "nl-NL": "Dutch (Netherlands)",
    "nn-NO": "Norwegian (Norway,Nynorsk)",
    "no": "Norwegian",
    "no-NO": "Norwegian (Norway)",
    "pl": "Polish",
    "pl-PL": "Polish (Poland)",
    "pt": "Portuguese",
    "pt-BR": "Portuguese (Brazil)",
    "pt-PT": "Portuguese (Portugal)",
    "ro": "Romanian",
    "ro-RO": "Romanian (Romania)",
    "ru": "Russian",
    "ru-RU": "Russian (Russia)",
    "sk": "Slovak",
    "sk-SK": "Slovak (Slovakia)",
    "sl": "Slovenian",
    "sl-SI": "Slovenian (Slovenia)",
    "sq": "Albanian",
    "sq-AL": "Albanian (Albania)",
    "sr": "Serbian",
    "sr-BA": "Serbian (Bosnia and Herzegovina)",
    "sr-CS": "Serbian (Serbia and Montenegro)",
    "sr-Latn": "Serbian (Latin)",
    "sr-Latn-BA": "Serbian (Latin,Bosnia and Herzegovina)",
    "sr-Latn-ME": "Serbian (Latin,Montenegro)",
    "sr-Latn-RS": "Serbian (Latin,Serbia)",
    "sr-ME": "Serbian (Montenegro)",
    "sr-RS": "Serbian (Serbia)",
    "sv": "Swedish",
    "sv-SE": "Swedish (Sweden)",
    "th": "Thai",
    "th-TH": "Thai (Thailand)",
    "th-TH-u-nu-thai-x-lvariant-TH": "Thai (Thailand,TH)",
    "tr": "Turkish",
    "tr-TR": "Turkish (Turkey)",
    "uk": "Ukrainian",
    "uk-UA": "Ukrainian (Ukraine)",
    "vi": "Vietnamese",
    "vi-VN": "Vietnamese (Vietnam)",
    "zh": "Chinese",
    "zh-CN": "Chinese (China)",
    "zh-HK": "Chinese (Hong Kong)",
    "zh-SG": "Chinese (Singapore)",
    "zh-TW": "Chinese (Taiwan)"
}

Look at the API response provided above for the full value set, but essentially a GET /locale call returns an object of key value pairs, where the key is the locale code and the value is the display name. Wherever a locale is set on an object - such as the business object - you would want to set it to the key, not the display name. For example, if you wanted to set your business to a locale of English (United States), you would set the locale property on the business object to "en-US", which is the key, and not to "English (United States)", which is the value or display name. The display name only returns so that you have a reference for what each key actually means in layman's terms.

TimeTap API

Locale

Locale API Endpoints

Locale API Parameters

Locale API Responses

Locale Object Values