BizKitHub
DocsAPI ReferenceCurrency/bff/currency/list
getCurrencyAdmin BFF

/bff/currency/list

Returns the full currency master with metadata (name, symbol, decimals, ISO 4217 numeric code, rate-lock flag) plus the latest rate against the organisation default currency: rate (units of base per 1 unit of code), rateDate (the oldest fixing in the resolution path), and hops (0 = direct quote / identity, 1+ = via pivot). Sort: org default first, then alphabetical by ISO code.

CurrencygetBffCurrencyList

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
itemsobject[]Required

All currencies, org default first, then alphabetical.

Each array item:
codestringRequired

ISO 4217 alphabetic code.

ExampleEUR
namestring | nullRequired
One of 2:
Variant 1
string

English display name.

ExampleEuro
Variant 2
null
symbolstringRequired

Native symbol or ISO code as fallback.

Examples€Kč
decimalsnumberRequired

ISO 4217 fractional digits (JPY/HUF/KRW=0, BHD=3, others 2).

Examples20
numericCodestring | nullRequired
One of 2:
Variant 1
string

ISO 4217 numeric code (3 chars), null if unknown.

Example978
Variant 2
null
rateLockbooleanRequired

When true, the daily multi-source sync skips this currency on either side of the pair (manual override wins).

Default: false
ratenumber | nullRequired
One of 2:
Variant 1
number

Latest available rate: how many units of the org default currency 1 unit of code is worth. Null when no rate is reachable in the graph within the lookback window.

Examples24.3551null
Variant 2
null
rateDatestring | nullRequired
One of 2:
Variant 1
string

YYYY-MM-DD of the oldest fixing in the resolution path. Null when rate is null.

Example2026-04-28
Variant 2
null
hopsnumber | nullRequired
One of 2:
Variant 1
number

Number of pivot hops to reach the rate (0 = direct quote / identity, 1+ = via cross-rate path).

Examples012
Variant 2
null
itemCountnumberRequired
Example158
defaultCurrencyCodestringRequired

ISO code of the organisation default currency.

ExampleCZK

Response example

application/json
{
  "items": [
    {
      "code": "EUR",
      "symbol": "€",
      "decimals": 2,
      "rateLock": false
    }
  ],
  "itemCount": 158,
  "defaultCurrencyCode": "CZK"
}

Request example

GET /bff/currency/list

get
curl -X GET "https://api.bizkithub.com/bff/currency/list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key