Retrieve a locale

get /api/locales/{code}

Retrieves a Locale resource.

Returns a single locale by its code, including whether it is the default one.

Path parameters

Name	Type	Required	Description
code	string	required	Locale identifier

Query parameters

Name	Type	Required	Description
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

Response

200 - Locale resource

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	required	A locale identifier in the format ll or ll-CC, where ll is a two-letter lowercase language code (e.g., fr for French), and CC is an optional two-letter uppercase country code (e.g. FR for France). Examples: fr, en-US, de-DE.
createdAt	string	-	The date and time when the resource was created (ISO 8601 format).
default	boolean	-	Whether this locale is the default one. Exactly one locale is the default at any time. To change it, use PUT /api/default_locale.
updatedAt	string	-	The date and time when the resource was last modified (ISO 8601 format).

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-

404 - Not found

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.