Sign in

v1

latestOpenAPI 3.1.02026-08-04177151.5 KB
locale

Get Locale

Returns a locale by its ID or locale code.

get/v2/locales/{localeIdOrCode}

Path parameters

localeIdOrCodestring required

The locale ID or locale code.

Query parameters

siteIdstring uuid

The site ID required when using a locale code instead of a locale ID.

Headers

x-api-keystring required

API key authentication. Accepts either:

  • App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)
  • Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Response

object'locale' required
idstring uuid nullable required

The ID of the locale you are getting.

localestring required

We support the subset of locales specified with ISO 3166 that are composed of language and optionally a region.

domainstring uri nullable required

The domain URL for domain-based localization.

pathPrefixstring nullable required

Custom URL path prefix. Null means the locale code is used as the default prefix.

isDefaultboolean required

The flag that indicates whether this locale is the default locale for the site.