This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of the site's locales, given the provided paging, filtering, and sorting. Up to 200 locales can be returned per request.
The default sort
is locale.id
in ASC
.
For a detailed list of supported operations, see "Locale: Supported Filters and Sorting" (REST | SDK). To learn how to query projects, see API Query Language (REST | SDK).
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
languageCode | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
regionCode | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
visibility | eq() ,ne() ,exists() ,in() ,hasSome() ,ascending() ,descending() |
primaryLocale | eq() ,ne() ,exists() ,in() ,hasSome() ,ascending() ,descending() |
flag | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
regionalFormat | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
effectiveUrlStructure | eq() ,ne() ,exists() ,in() ,hasSome() ,ascending() ,descending() |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.