Locale catalog

What a destination can be. Locales are always regional (en-GB, de-DE); a bare en is never accepted anywhere on this surface. Per country, the locales the catalog offers with the default marked. The same list is published at Markets and Languages.

Requires the read:prompts scope.


GET /v1/brands/{brand_id}/localization/catalog

Authorization

Header	Type	Required
`Authorization`	`Bearer asky_sk_…`	required

Path parameters

Parameter	Type	Required	Description
`brand_id`	`uuid`	required	From List brands

Query parameters

Parameter	Type	Required	Description
`country_code`	`string`	optional	Restrict to one country, e.g. `CH`

Request

cURL


curl --request GET \
  --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/localization/catalog' \
  --header 'Authorization: Bearer <api-key>'

Response

200


{
  "data": {
    "locales": [
      {
        "locale_code": "de-CH",
        "name": "German (Switzerland)",
        "native_name": "Deutsch (Schweiz)",
        "language": "de"
      }
    ],
    "countries": [
      {
        "country_code": "CH",
        "country_name": "Switzerland",
        "offered": [
          {
            "locale_code": "de-CH",
            "is_default": false
          },
          {
            "locale_code": "fr-CH",
            "is_default": false
          },
          {
            "locale_code": "it-CH",
            "is_default": false
          }
        ]
      }
    ],
    "locale_count": 73,
    "country_count": 1
  },
  "request_id": "req_2f7b90c14ae8471da3cd"
}

Response fields

Field	Type	Description
`data.locales`	`object[]`	required. Every enabled regional locale
`data.countries`	`object[]`	required. `{ country_code, country_name, offered[] }` with `offered[].is_default`

Errors

Status	Code	When
401	`invalid_token`	The key is missing, malformed, or does not exist
403	`insufficient_scope`	The key does not carry `read:prompts`
404	`not_found`	The brand does not exist, or this key is not allowed to reach it
429	`rate_limited`	Over the per-minute limit for this endpoint