## List currencies

`GET /v1/currencies`

Returns the list of currencies in your Bitrix24 account with exchange rates. The directory holds a handful of records.

## Parameters

| Parameter | Type | Default | Description |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Number of records |
| `offset` | number | `0` | Skip N records |
| `select` | string | — | Field selection: `?select=id,fullName,amount` |
| `sort` | string | — | Sorting: `?sort=-sort`. Accepted fields are `sort`, `id`, `fullName`. An unknown name returns `400 UNKNOWN_SORT_FIELD` before Bitrix24 is called |
| `order` | object | — | Sorting in object form: `?order[sort]=asc`. Same accepted fields as `sort`. When both are passed, `sort` takes precedence |
| `filter` | object | — | Not supported for currencies. Any key returns `400 UNSUPPORTED_FILTER`. Retrieve the entire directory and filter records client-side |
| `withTotal` | boolean | — | Accepted, but does not change the response: `meta.total` is returned for any value of the parameter and at any `offset` |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/currencies?select=id,fullName,amount,base" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/currencies?select=id,fullName,amount,base" \
  -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?select=id,fullName,amount,base', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data, meta } = await res.json()
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/currencies?select=id,fullName,amount,base', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data, meta } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of currencies. Elements do not carry `lang` — it is returned by [`GET /v1/currencies/:id`](/docs/entities/currencies/get) |
| `data[].id` | string | Currency code (USD, EUR, …) |
| `data[].amountCnt` | number | Number of units for the rate |
| `data[].amount` | number | Exchange rate |
| `data[].sort` | number | Sort order |
| `data[].base` | boolean | Base currency |
| `data[].fullName` | string | Name ($, €) |
| `data[].lid` | string | ID of the site the currency is bound to |
| `data[].formatString` | string | Display format |
| `data[].decPoint` | string | Decimal separator |
| `data[].thousandsSep` | string | Thousands separator |
| `data[].decimals` | number | Decimal places |
| `data[].dateUpdate` | datetime | Date of the last update |
| `meta.total` | number | Number of currencies in the directory |
| `meta.hasMore` | boolean | Whether there is a next page |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": "USD",
      "fullName": "US dollar",
      "amount": 1,
      "amountCnt": 1,
      "base": true,
      "sort": 100,
      "formatString": "# $",
      "decimals": 2,
      "decPoint": ".",
      "thousandsSep": " "
    },
    {
      "id": "EUR",
      "fullName": "Euro",
      "amount": 92.5,
      "amountCnt": 1,
      "base": false,
      "sort": 200
    }
  ],
  "meta": { "total": 3, "hasMore": false }
}
```


## Error response example

400 — filtering is not supported:

```json
{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_FILTER",
    "message": "UNSUPPORTED_FILTER: 'currencies' does not support server-side filtering. Its Bitrix24 method (crm.currency.list) silently ignores every filter key and returns the full list — retrieve all records and filter client-side."
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `UNSUPPORTED_FILTER` | Any key passed in `filter`. Currencies are not filtered server-side — retrieve the entire directory and filter records client-side |
| 400 | `UNKNOWN_SORT_FIELD` | The field in `sort` or `order` is not one of `sort`, `id`, `fullName`. The message lists the accepted names. Bitrix24 is not called |
| 403 | `SCOPE_DENIED` | API key does not have the `crm` scope |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 429 | `RATE_LIMITED` | Rate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the `x-ratelimit-limit` header. Retry after the delay in the `Retry-After` header |

For the full list of errors, see [Errors](/docs/errors).

## See also

- [Currencies](/docs/entities/currencies)
- [Create currency](/docs/entities/currencies/create)
- [Search currencies](/docs/entities/currencies/search)
- [Aggregate currencies](/docs/entities/currencies/aggregate)
- [Batch](/docs/batch)