ReferenceREST APIAPI ReferenceLocale

Get Locale

Returns a locale by its ID or locale code.

Authentication

x-api-keystring
API key authentication. Accepts either: - App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ) - Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Path parameters

localeIdOrCodestringRequired
The locale ID or locale code.

Query parameters

siteIdstringOptionalformat: "uuid"
The site ID required when using a locale code instead of a locale ID.

Response

objectenum
Allowed values:
idstring or nullformat: "uuid"
The ID of the locale you are getting.
localestring
We support the subset of locales specified with ISO 3166 that are composed of language and optionally a region.
domainstring or nullformat: "uri"

The domain URL for domain-based localization.

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

Errors