Skip to content

Find currencies

GET
/config/currency/currencies
Required scope: currency:read

Searches for currencies with optional filters and pagination. Results are sorted by currency code. Currencies without a code are left out, as they cannot be addressed by code.

Parameters ​

Query parameters

page  integer
The page number to retrieve. The first page is 1. Cannot be less than 1.
Default value: 1
pageSize  integer
The size of the pages to retrieve. The default is 10. Cannot be less than 1 and larger than 100.
Default value: 10
keywords  string
Whitespace-separated keywords. Each token must match the currency code, name, numeric code or symbol (case-insensitive AND across tokens).
active  enum
Filter by the active status.
Enum: ALLACTIVEINACTIVE
Default value: ACTIVE

Response ​

The response contains the found currencies.