Skip to content

List Channels ​

Returns every channel (storefront) configured in the store, ordered newest-first, with cursor pagination.

Operation ​

OperationTypePurpose
adminSettingsChannelsQueryCollectionList all channels

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

ArgumentTypeMatchExample
codeStringPartial (contains), on the channel code."default"
nameStringPartial (contains), on the channel's translated name."Store"
hostnameStringPartial (contains), on the channel hostname."example.com"

Sorting ​

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

Notes ​

  • Listing rows are slim: the detail-only connections — locales, currencies, inventorySources, and translations — come back empty here, so don't sub-select them on the listing. Fetch a single channel with adminSettingsChannel to get them populated.
  • Page through results with the standard cursor arguments (first, after); read pageInfo and totalCount to drive paging.

Released under the MIT License.