> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# QueryLocales

# Package: localeManagement

# Namespace: LocalesService

# Method link: https://dev.wix.com/docs/api-reference/business-management/multilingual/locale-management/locales/query-locales.md

## Permission Scopes:
Wix Multilingual: SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS

## Introduction

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`.

To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md).

---

## REST API

### Schema

```
 Method: queryLocales
 Description: 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`.  To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md).
 URL: https://www.wixapis.com/v2/locale/query
 Method: POST
 Method parameters:
   param name: query | type: CursorQuery   
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Maximum number of items to return in the results. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: QueryLocalesResponse
  - name: locales | type: array<Locale> | description: Retrieved locales. 
     - name: id | type: string | description: Locale GUID.  The locale GUID is made up of the language and region codes supported by Wix. For example, `"en-US"` for U.S. English. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the locale is updated. To prevent conflicting changes, the existing revision must be passed when updating the locale object. 
     - name: createdDate | type: string | description: Date and time the locale was created. 
     - name: updatedDate | type: string | description: Date and time the locale was last updated. 
     - name: languageCode | type: string | description: Language code. For example, `"en"` for English. 
     - name: regionCode | type: string | description: Region code. For example, `"UK"` for United Kingdom. 
     - name: visibility | type: LocaleVisibility | description: Locale visibility status. 
         - enum:
         -     HIDDEN: Locale is hidden from site visitors. A site's locale should be hidden when a translation is not ready to be exposed to visitors.
         -     VISIBLE: Locale is visible to site visitors. A site can only have up to 100 visible locales.
     - name: primaryLocale | type: boolean | description: Whether the locale is the site's primary locale. 
     - name: visitorPrimaryLocale | type: boolean | description: Whether the locale is the site's visitor primary locale. 
     - name: flag | type: string | description: Flag icon as a 3-letter language code based on Wix's supported locales. For example, `"USA"` for the United States flag icon. 
     - name: regionalFormat | type: string | description: Regional format for determining how to display data types such as dates, times, numbers, and currencies. For example, `"en-US"` to format dates like this: `MM-DD-YYYY`. 
     - name: effectiveUrlStructure | type: UrlStructure | description: Default URL structure for the locale's live site URL, based on the locale's settings, unless overridden. 
         - enum:
         -     SUBDIRECTORY: URL structure as a subdirectory. For example, `"www.mysite.com/fr"`.
         -     SUBDOMAIN: URL structure as a subdomain. For example, `"fr.mysite.com"`.
         -     QUERY_PARAM: URL structure as a query parameter. For example, `"www.mysite.com?lang=fr"`.
     - name: urlStructureOverride | type: UrlStructureOverride | description: Optional override for the locale's default URL structure. 
        - name: urlStructure | type: UrlStructure | description: URL structure to use instead of the default. 
     - name: machineTranslationCode | type: string | description: Language code based on Wix's supported locales, used to specify the target language when translatable content is sent for machine translation. For example, `"ES"` for Spanish or `"ZH_TW"` for Traditional Chinese.  Default: The locale's `languageCode` value. 
     - name: effectiveDisplayName | type: string | description: The locale's `displayName`, unless overridden. 
     - name: displayName | type: string | description: Default display name for the locale, inferred from the locale GUID and region code. 
     - name: overrideDisplayName | type: string | description: Optional override for the locale's display name. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 
     - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### Query Locales
```curl
curl -X POST \
  'https://www.wixapis.com/locales/v2/locale/en' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "query": {
      "filter": {
        "visibility": "HIDDEN"
      }
    }
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.localeManagement.LocalesService.queryLocales(query)
 Description: 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`.  To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md).
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  query
 Method parameters: 
   param name: query | type: LocaleQuery   | required: true
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Maximum number of items to return in the results. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum: ASC, DESC
 Return type: PROMISE<QueryLocalesResponse>
  - name: locales | type: array<Locale> | description: Retrieved locales. 
     - name: _id | type: string | description: Locale GUID.  The locale GUID is made up of the language and region codes supported by Wix. For example, `"en-US"` for U.S. English. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the locale is updated. To prevent conflicting changes, the existing revision must be passed when updating the locale object. 
     - name: _createdDate | type: Date | description: Date and time the locale was created. 
     - name: _updatedDate | type: Date | description: Date and time the locale was last updated. 
     - name: languageCode | type: string | description: Language code. For example, `"en"` for English. 
     - name: regionCode | type: string | description: Region code. For example, `"UK"` for United Kingdom. 
     - name: visibility | type: LocaleVisibility | description: Locale visibility status. 
         - enum:
         -     HIDDEN: Locale is hidden from site visitors. A site's locale should be hidden when a translation is not ready to be exposed to visitors.
         -     VISIBLE: Locale is visible to site visitors. A site can only have up to 100 visible locales.
     - name: primaryLocale | type: boolean | description: Whether the locale is the site's primary locale. 
     - name: visitorPrimaryLocale | type: boolean | description: Whether the locale is the site's visitor primary locale. 
     - name: flag | type: string | description: Flag icon as a 3-letter language code based on Wix's supported locales. For example, `"USA"` for the United States flag icon. 
     - name: regionalFormat | type: string | description: Regional format for determining how to display data types such as dates, times, numbers, and currencies. For example, `"en-US"` to format dates like this: `MM-DD-YYYY`. 
     - name: effectiveUrlStructure | type: UrlStructure | description: Default URL structure for the locale's live site URL, based on the locale's settings, unless overridden. 
         - enum:
         -     SUBDIRECTORY: URL structure as a subdirectory. For example, `"www.mysite.com/fr"`.
         -     SUBDOMAIN: URL structure as a subdomain. For example, `"fr.mysite.com"`.
         -     QUERY_PARAM: URL structure as a query parameter. For example, `"www.mysite.com?lang=fr"`.
     - name: urlStructureOverride | type: UrlStructureOverride | description: Optional override for the locale's default URL structure. 
        - name: urlStructure | type: UrlStructure | description: URL structure to use instead of the default. 
     - name: machineTranslationCode | type: string | description: Language code based on Wix's supported locales, used to specify the target language when translatable content is sent for machine translation. For example, `"ES"` for Spanish or `"ZH_TW"` for Traditional Chinese.  Default: The locale's `languageCode` value. 
     - name: effectiveDisplayName | type: string | description: The locale's `displayName`, unless overridden. 
     - name: displayName | type: string | description: Default display name for the locale, inferred from the locale GUID and region code. 
     - name: overrideDisplayName | type: string | description: Optional override for the locale's display name. 
  - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 
     - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### queryLocales
```javascript
import { locales } from '@wix/multilingual';

async function queryLocales(query) {
  const response = await locales.queryLocales(query);
};
```

### queryLocales (with elevated permissions)
```javascript
import { locales } from '@wix/multilingual';
import { auth } from '@wix/essentials';

async function myQueryLocalesMethod(query) {
  const elevatedQueryLocales = auth.elevate(locales.queryLocales);
  const response = await elevatedQueryLocales(query);
}
```

### queryLocales (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { locales } from '@wix/multilingual';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { locales },
  // Include the auth strategy and host as relevant
});


async function queryLocales(query) {
  const response = await myWixClient.locales.queryLocales(query);
};
```

---