Skip to content

List Locales

Returns every locale configured in the store as a cursor-paginated connection. Use it to populate a locale picker, audit which languages a store supports, or look up a locale's _id before a detail / update / delete call.

Operation

OperationTypePurpose
adminSettingsLocalesQueryCollectionList all locales (cursor-paginated)

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 Locales datagrid filters.

ArgumentTypeMatchExample
idStringExact. Single id or a comma-separated list."1" · "1,10,35"
codeStringPartial (contains)."en"
nameStringPartial (contains)."Eng"
directionStringExact — ltr or rtl."rtl"

Sorting

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

Notes

  • Pass first (and after: <cursor>) to page through results. The connection exposes pageInfo and totalCount.
  • direction is ltr or rtl and controls the text direction of the storefront when that locale is active.
  • logoPath is the stored relative path; logoUrl is its fully-qualified public URL. Both are null for locales without a logo.
  • Seeded core locales (such as English) may have null createdAt / updatedAt.

See the Locales overview for field meanings and behaviour.

Released under the MIT License.