# List locales

> Retrieve the locales enabled for the catalog.
{/* generated:versioned-pages - edit _pm-authored, not this file */}

`GET /api/locales`

Retrieves the collection of Locale resources.

Returns every locale enabled for the current tenant. Filter by `code` or by `default`, and sort by `order[code]`, `order[createdAt]` or `order[updatedAt]`. Requires the `instance_params:read` scope.

## Query parameters

| Name               | Type       | Required | Description                                                                                                                                                                                                                                                                          |
| ------------------ | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `properties[]`     | `string[]` | -        | Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty} |
| `code`             | `string`   | -        | Locale code                                                                                                                                                                                                                                                                          |
| `code[]`           | `string[]` | -        | Locale code                                                                                                                                                                                                                                                                          |
| `default`          | `boolean`  | -        | Locale default                                                                                                                                                                                                                                                                       |
| `order[code]`      | `string`   | -        | Locale order[code]                                                                                                                                                                                                                                                                   |
| `order[createdAt]` | `string`   | -        | Locale order[createdAt]                                                                                                                                                                                                                                                              |
| `order[updatedAt]` | `string`   | -        | Locale order[updatedAt]                                                                                                                                                                                                                                                              |

## Response

**200** - Locale collection

| Property     | Type       | Required | Description |
| ------------ | ---------- | -------- | ----------- |
| `search`     | `object`   | -        |             |
| `totalItems` | `integer`  | -        |             |
| `member`     | `Locale[]` | Yes      |             |

## Errors

**403** - Access denied. The caller is missing one or more permissions required for this operation.

| Property             | Type               | Required | Description                                                                                                            |
| -------------------- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `@context`           | `string \| object` | -        |                                                                                                                        |
| `@id`                | `string`           | Yes      |                                                                                                                        |
| `@type`              | `string`           | Yes      |                                                                                                                        |
| `detail`             | `string`           | -        |                                                                                                                        |
| `missingPermissions` | `string[]`         | -        | Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. |
| `status`             | `integer`          | -        |                                                                                                                        |
| `title`              | `string`           | -        |                                                                                                                        |
| `type`               | `string`           | -        |                                                                                                                        |

## Examples

### Example request

```bash
curl -X GET 'https://<tenant>.product-management.flowkiwi.net/api/locales' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Flowkiwi-Api-Version: 2026-07' \
  -H 'Accept: application/ld+json'
```

### Example response

```json
{
  "search": {
    "@type": "string",
    "mapping": [
      {
        "@type": "string",
        "property": "string",
        "required": true,
        "variable": "string"
      }
    ],
    "template": "string",
    "variableRepresentation": "string"
  },
  "totalItems": 0,
  "member": [
    {
      "@context": "string",
      "@id": "string",
      "@type": "Locale",
      "code": "fr-FR",
      "createdAt": "2026-01-15T10:00:00+00:00",
      "default": true,
      "updatedAt": "2026-01-15T10:00:00+00:00"
    }
  ]
}
```