Skip to content

List Currencies ​

Returns the paginated list of currencies configured in the store — every currency the store can price and display amounts in. This is the data behind the admin Settings → Currencies grid.

Operation ​

OperationTypePurpose
adminSettingsCurrenciesQueryCollection (cursor)List currencies

Arguments ​

All arguments are optional and combine in a single query — filter, sort and paginate together.

Pagination ​

ArgumentDescription
firstNumber of records to return.
afterCursor to fetch the page after (from pageInfo.endCursor).

Filters ​

Each filter narrows the result; supplying more than one combines with logical AND. They mirror the admin Currencies datagrid filters.

ArgumentTypeMatchExample
codeStringPartial (contains)."USD"
nameStringPartial (contains)."Dollar"
symbolStringPartial (contains)."$"

Sorting ​

ArgumentTypeValues
sortStringid (default), code, name
orderStringasc, desc (default desc)

Notes ​

  • Results are cursor-paginated — pass first for the page size and after (an endCursor) to page forward.
  • symbol and currencyPosition may be null for currencies created without those fields set.
  • The seeded default currency (USD) carries null timestamps because it predates timestamp tracking.

Released under the MIT License.