TAtalkjs
App metadata

Get app metadata

Gets metadata for your app. Metadata include the app's ID, its default locale, and any custom properties.

get/v1/{appId}

Request

Path parameters

appIdstring required
Example:abcd1234

A unique identifier of your TalkJS app. You can find your app ID on the Settings page of your dashboard.

Response

App metadata retrieved successfully.

idstring

A unique identifier of your TalkJS app. You can find your app ID on the Settings page of your dashboard.

customobject nullable

Global custom fields for the entire app. Custom fields can be used in themes and notification settings. For more on custom fields, see: Custom fields.

defaultLocale'ar' | 'bg-BG' | 'bs-BA' | 'cs-CZ' | 'da-DK' | 'de-DE' | 'el-GR' | 'en-US' | 'es-ES' | 'et-EE' | 'fa' | 'fi-FI' | 'fr-FR' | 'he-IL' | 'hi-IN' | 'hr-HR' | 'hu-HU' | 'id-ID' | 'it-IT' | 'ja-JP' | 'ka-GE' | 'ko-KR' | 'nb-NO' | 'nl-NL' | 'pl-PL' | 'pt-BR' | 'ro-RO' | 'ru-RU' | 'sq-AL' | 'sr-SP' | 'sv-SE' | 'tr-TR' | 'uk-UA' | 'vi-VN' | 'zh-CN' | 'zh-TW'

An IETF language tag for the app's default locale, for localization purposes. The default locale must be one of the supported languages. You can override the default locale for each user.

Example response

{
  "id": "abcd1234",
  "custom": {
    "website": "https://www.example.com"
  },
  "defaultLocale": "ar"
}

Changes

No recorded changes to this operation across all 1 revision of this API.