Get a list of locales

GET

/api/rest/v1/locales

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

Response Example

200 - Example 1

{
    "_links": {
        "first": {
            "href": "string"
        },
        "next": {
            "href": "string"
        },
        "previous": {
            "href": "string"
        },
        "self": {
            "href": "string"
        }
    },
    "current_page": 0,
    "_embedded": {
        "items": [
            {
                "_links": {
                    "self": {
                        "href": "string"
                    }
                },
                "code": "en_US",
                "enable": true
            }
        ]
    }
}

Request

Query Params

string

optional

Filter locales, for more details see the Filters section

page

integer

optional

Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section

limit

integer

optional

Number of results by page, see Pagination section

with_count

string

optional

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

Responses

🟢200Return locales paginated

application/json

Body

_links

object

optional

first

object

optional

object

optional

object

optional

self

object

optional

current_page

integer

optional

Current page number

_embedded

object

optional

items

array [object {3}]

optional

🟠401Authentication required

🟠403Access forbidden

🟠406Not Acceptable

Modified at 2023-08-15 05:53:55

Update/create a family variant

Get a locale