---
title: "Get app metadata"
method: GET
path: "/v1/{appId}"
tags: ["App metadata"]
---

# Get app metadata

`GET /v1/{appId}`

## Request

- Base URL: `https://api.talkjs.com`
- URL: `https://api.talkjs.com/v1/{appId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
- TypeScript: <https://skmtc.dev/talkjs/apis/talkjs-api/docs/v1/:appId/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `appId` string, required

## Response `200`

App metadata retrieved successfully.

- AppMetadata: Metadata for a specific app. _Metadata_ of an app include the app's ID, its default locale, and any custom properties.
  - `id` string: A unique identifier of your TalkJS app. You can find your app ID on the **Settings** page of your [dashboard](https://talkjs.com/dashboard).
  - `custom` object, 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](https://talkjs.com/docs/Features/Themes/Passing_Data_to_Themes/#using-app-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.

## Other responses

- `400`: Bad request
- `404`: Resource not found
- `429`: Too many requests
- `500`: Internal server error

---

[API](https://skmtc.dev/talkjs/apis/talkjs-api.md) - [All operations](https://skmtc.dev/talkjs/apis/talkjs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/talkjs/apis/talkjs-api/revisions/9d4acc9cfa43?raw)
