Skip to content

List Currencies

EndpointMethod
/api/admin/settings/currenciesGET

Returns every currency configured in the store in the { data, meta } envelope. Use it to populate a currency picker, audit which currencies a store supports, or look up a currency's id before a detail / update / delete call.

Pagination

ParameterDescription
pagePage number, 1-based. Default 1.
per_pageItems per page. Default 10, max 50.

Filters

Query parameters that narrow the result. Supplying more than one narrows further — they combine with logical AND. They mirror the admin Currencies datagrid filters.

ParameterMatchExample
codePartial (contains).?code=USD
namePartial (contains).?name=Dollar
symbolPartial (contains).?symbol=$

Sorting

ParameterValues
sortid (default), code, name
orderasc, desc (default desc)

Both the compound form ?sort=name-asc and the split form ?sort=name&order=asc are accepted.

Notes

  • symbol and currencyPosition may be null for currencies created without those fields set.
  • The seeded default currency (USD) may carry null createdAt / updatedAt.

Released under the MIT License.