Locales

Locales describe the possible localities available in the system. This is mainly used to provide additional details for your customers.

Locale

code	string <bcp47> Code identifying this locale.
name	string [ 1 .. 255 ] characters Human-readable name consisting of language and, if present, region or country.

{"code": "en-GB",
"name": "English (United Kingdom)"
}

Retrieve all locales

Retrieve a list of supported locales.

SecurityOAuth2

Request

query Parameters

limit	integer <int32> [ 0 .. 1000 ] Default: 25 Limits the amount of resources in result.
offset	integer <int64> >= 0 Default: 0 Offset of resources in result.

Responses

200

Successful response.

Response Schema: application/json

object >= 0 properties

Applied query parameters, including defaults.

limit	integer <int32> [ 0 .. 1000 ] Default: 25 The applied value of the limit query parameter on the resources in result.
offset	integer <int64> >= 0 Default: 0 The applied value of the offset query parameter on the resources in result.
property name* additional property	any

Array of objects (Locale) >= 0 items

List of locales.

Array (>= 0 items)

code	string <bcp47> Code identifying this locale.
name	string [ 1 .. 255 ] characters Human-readable name consisting of language and, if present, region or country.

total

integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/system/locales

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0
},
"result": [{"code": "en-GB",
"name": "English (United Kingdom)"
}
],
"total": 3255
}

Retrieve a locale

Retrieve a single locale by its code.

SecurityOAuth2

Request

path Parameters

locale-code

required

string <bcp47>

Code of the locale to manage.

Example: en-GB