For AI agents: markdown of this page — /docs-content-en/entities/currencies/list.md documentation index — /llms.txt

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
order object — Sorting: ?order[sort]=asc
filter object — Not supported for currencies. Any key returns 400 UNSUPPORTED_FILTER. Retrieve the entire directory and filter records client-side

Examples

curl — personal key

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

curl — OAuth application

Terminal 
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
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 Language
data[].formatString string Display format
data[].decPoint string Decimal separator
data[].thousandsSep string Thousands separator
data[].decimals number Decimal places

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
403 SCOPE_DENIED API key does not have the crm scope
401 TOKEN_MISSING No API key provided

Full list of errors — Errors.

See also