List Currencies

GET

/admin/currencies

Retrieve a list of currencies. The currencies can be filtered by fields such as id. The currencies can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "currencies": [
        {
            "code": "usd",
            "symbol": "$",
            "symbol_native": "$",
            "name": "string",
            "decimal_digits": 0,
            "rounding": 0,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z"
        }
    ],
    "estimate_count": 0
}

Request

Authorization

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

optional

The search term to filter the currency's searchable properties by.

code

optional

One of

code

array[string]

Filter by a currency code.

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Responses

🟢200OK

application/json

Body

The paginated list of currencies.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

currencies

array[object (AdminCurrency) {9}]

required

The list of currencies.

code

string

code

required

The currency's code.

Example:

usd

symbol

string

symbol

required

The currency's symbol.

Example:

symbol_native

string

symbol_native

required

The currency's native symbol, if different than the symbol.

Example:

name

string

name

required

The currency's name.

decimal_digits

number

decimal_digits

required

The number of digits after the decimal for prices in this currency.

rounding

number

rounding

required

The rounding percision applied on prices in this currency.

created_at

string <date-time>

created_at

required

The currency's creation date.

updated_at

string <date-time>

updated_at

required

The currency's update date.

deleted_at

string <date-time>

deleted_at

required

The currency's deletion date.

estimate_count

number

estimate_count

optional

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Get a Currency

Get an Exchange