exchangeRates

Requires at least one of the permissions settings:currency:read or settings:tenant:read.

Lists every exchange rate from a base currency, or all of them when none is given: each target currency, the rate and when it was last updated. The rates are shared by every organization. Requires permission to read currency or tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ExchangeRates {
  exchangeRates {
    id
    createdAt
    fromCurrency
    inverseRate
    lastUpdated
    rate
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ExchangeRates {\n  exchangeRates {\n    id\n    createdAt\n    fromCurrency\n    inverseRate\n    lastUpdated\n    rate\n  }\n}"
}
EOF

Response:

{
  "data": {
    "exchangeRates": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "fromCurrency": "string",
        "inverseRate": 0,
        "lastUpdated": "2025-01-15T00:00:00Z",
        "rate": 0
      }
    ]
  }
}

exchangeRates(
  baseCurrency: String
): [ExchangeRate!]!

Arguments

exchangeRates.baseCurrency ● String scalar

The currency code to list rates from. Omit it to list every rate.

Type

ExchangeRate object

The current exchange rate between two currencies.