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

Currency search

POST /v1/currencies/search

Returns the Bitrix24 account currencies with field selection, sorting, and pagination passed in the POST request body.

Server-side filtering is not supported for currencies: any key in filter returns 400 UNSUPPORTED_FILTER. To pick the currencies you need, retrieve the whole directory and filter the records client-side. A Bitrix24 account has only a handful of currencies, so the request returns the same directory as the currency list — the only difference is that parameters are passed in the request body instead of the query string.

Request fields (body)

Parameter Type Required Default Description
Parameterselect Typestring[] Requiredno Default— DescriptionField selection: ["id", "fullName", "amount"]
Parametersort Typestring Requiredno Default— DescriptionSorting: "-sort". Accepted fields are sort, id, fullName. An unknown name returns 400 UNKNOWN_SORT_FIELD before Bitrix24 is called
Parameterorder Typeobject Requiredno Default— DescriptionSorting in object form: { "sort": "asc" }. Same accepted fields as sort. When both are passed, sort takes precedence
Parameterlimit Typenumber Requiredno Default50 DescriptionNumber of records
Parameteroffset Typenumber Requiredno Default0 DescriptionSkip N records from the start of the selection
Parameterfilter Typeobject Requiredno Default— DescriptionNot supported for currencies. Any key returns 400 UNSUPPORTED_FILTER. Retrieve the whole directory and filter the records client-side

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/currencies/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "select": ["id", "fullName", "amount", "base"],
    "order": { "sort": "asc" },
    "limit": 3
  }'

curl — OAuth application

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/currencies/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "select": ["id", "fullName", "amount", "base"],
    "order": { "sort": "asc" },
    "limit": 3
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/currencies/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    select: ['id', 'fullName', 'amount', 'base'],
    order: { sort: 'asc' },
    limit: 3,
  }),
})

const { success, data, meta } = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/currencies/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    select: ['id', 'fullName', 'amount', 'base'],
    order: { sort: 'asc' },
    limit: 3,
  }),
})

const { success, data, meta } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of currencies (fields — see Fields)
Fieldmeta.total Typenumber DescriptionHow many currencies are in the directory
Fieldmeta.hasMore Typeboolean DescriptionWhether there is a next page
Fieldmeta.durationMs Typenumber DescriptionRequest duration in milliseconds

The meta fields sit next to data, not inside it. Iterate over pages using meta.hasMore: a data length equal to limit does not rule out the last page.

Response example

JSON 
{
  "success": true,
  "data": [
    { "id": "USD", "fullName": "US Dollar", "amount": 1, "base": true },
    { "id": "THB", "fullName": "Baht", "amount": 5, "base": false },
    { "id": "EUR", "fullName": "Euro", "amount": 1, "base": false }
  ],
  "meta": { "total": 7, "hasMore": true, "durationMs": 148 }
}

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 whole directory and filter the 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 DescriptionThe API 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 common API errors, see Errors.

See also