## Get currency localizations

`GET /v1/currencies/:id/localizations`

Reads the currency names and amount display settings per language. Call the method before changing localizations and after a failed write.

Scope: `crm`. A key in `READONLY` mode is accepted.

## Parameters

| Parameter | Type | Required | Default | Description |
|----------|-----|:-----:|-----------|----------|
| `id` (path) | string | yes | — | Currency code from the [currency list](/docs/entities/currencies/list). Leading and trailing spaces are stripped, letters are uppercased |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/currencies/QVC/localizations" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/currencies/QVC/localizations" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/currencies/QVC/localizations', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { success, data } = await res.json()
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/currencies/QVC/localizations', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|----------|
| `success` | boolean | Always `true` on success |
| `data` | object | Map of localizations keyed by language code. If there are no localizations, an empty object `{}` |
| `data.{lang}` | object | Settings for the `{lang}` language, for example `en` or `ru` |
| `data.{lang}.fullName` | string | Full currency name |
| `data.{lang}.formatString` | string | Amount display template, `#` is the placeholder for the number |
| `data.{lang}.decPoint` | string | Decimal separator |
| `data.{lang}.thousandsVariant` | string | Thousands separator variant |
| `data.{lang}.thousandsSep` | string \| null | Thousands separator character or HTML entity |
| `data.{lang}.decimals` | number | Number of digits after the decimal separator |
| `data.{lang}.hideZero` | boolean | Hide trailing zeros in the fractional part |

## Response example

```json
{
  "success": true,
  "data": {
    "en": {
      "fullName": "Example currency",
      "formatString": "# QVC",
      "decPoint": ".",
      "thousandsVariant": "S",
      "thousandsSep": " ",
      "decimals": 2,
      "hideZero": false
    },
    "ru": {
      "fullName": "Example currency",
      "formatString": "# QVC",
      "decPoint": ".",
      "thousandsVariant": "S",
      "thousandsSep": " ",
      "decimals": 2,
      "hideZero": false
    }
  }
}
```

## Error response example

404 — a currency with the specified code is not found:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|----------|
| 400 | `INVALID_ID` | The currency code is empty after the spaces are stripped |
| 404 | `ENTITY_NOT_FOUND` | A currency with the specified code is not found |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected reading the currency or its localizations |
| 403 | `BITRIX_ACCESS_DENIED` | The user has no rights for the operation in Bitrix24 |
| 403 | `SCOPE_DENIED` | The API key does not have the `crm` scope |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `TOKEN_MISSING` | The API key has no configured Bitrix24 tokens |
| 502 | `BITRIX_RESPONSE_INVALID` | A response of an unexpected structure was received |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

HTML entities in the format and separator strings are preserved as is, for example ` `.

## See also

- [Set currency localizations](/docs/entities/currencies/localizations/set)
- [Delete currency localizations](/docs/entities/currencies/localizations/delete)
- [Currency localization fields](/docs/entities/currencies/localizations/fields)
- [Get currency](/docs/entities/currencies/get)