Sign in

v1

latestSwagger 2.02026-07-13137761.0 MB
Locale

Get a list of locales

This endpoint allows you to get a list of locales. Locales are paginated and sorted by code.

get/api/rest/v1/locales

Query parameters

searchstring

Filter locales, for more details see the <a href="/documentation/filter.html#filter-locales">Filters</a> section

pageinteger

Number of the page to retrieve when using the page pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html#pagination">Pagination</a> section

limitinteger

Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section

with_countboolean

Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Response

Return locales paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "code": "en_US",
        "enable": true
      }
    ]
  }
}