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
Parameterlimit Typenumber Default50 DescriptionNumber of records
Parameteroffset Typenumber Default0 DescriptionSkip N records
Parameterselect Typestring Default— DescriptionField selection: ?select=id,fullName,amount
Parametersort Typestring Default— DescriptionSorting: ?sort=-sort. Accepted fields are sort, id, fullName. An unknown name returns 400 UNKNOWN_SORT_FIELD before Bitrix24 is called
Parameterorder Typeobject Default— DescriptionSorting in object form: ?order[sort]=asc. Same accepted fields as sort. When both are passed, sort takes precedence
Parameterfilter Typeobject Default— DescriptionNot supported for currencies. Any key returns 400 UNSUPPORTED_FILTER. Retrieve the entire directory and filter records client-side
ParameterwithTotal Typeboolean Default— DescriptionAccepted, but does not change the response: meta.total is returned for any value of the parameter and at any offset

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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of currencies. Elements do not carry lang — it is returned by GET /v1/currencies/:id
Fielddata[].id Typestring DescriptionCurrency code (USD, EUR, …)
Fielddata[].amountCnt Typenumber DescriptionNumber of units for the rate
Fielddata[].amount Typenumber DescriptionExchange rate
Fielddata[].sort Typenumber DescriptionSort order
Fielddata[].base Typeboolean DescriptionBase currency
Fielddata[].fullName Typestring DescriptionName ($, €)
Fielddata[].lid Typestring DescriptionID of the site the currency is bound to
Fielddata[].formatString Typestring DescriptionDisplay format
Fielddata[].decPoint Typestring DescriptionDecimal separator
Fielddata[].thousandsSep Typestring DescriptionThousands separator
Fielddata[].decimals Typenumber DescriptionDecimal places
Fielddata[].dateUpdate Typedatetime DescriptionDate of the last update
Fieldmeta.total Typenumber DescriptionNumber of currencies in the directory
Fieldmeta.hasMore Typeboolean DescriptionWhether 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
HTTP400 CodeUNSUPPORTED_FILTER DescriptionAny key passed in filter. Currencies are not filtered server-side — retrieve the entire directory and filter records client-side
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionThe field in sort or order is not one of sort, id, fullName. The message lists the accepted names. Bitrix24 is not called
HTTP403 CodeSCOPE_DENIED DescriptionAPI key does not have the crm scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP429 CodeRATE_LIMITED DescriptionRate 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.

See also