List Channels

Endpoint	Method
/api/admin/settings/channels	GET

Returns every channel (storefront) configured in the store in the { data, meta } envelope. Use it to audit which storefronts a store runs, or look up a channel's id before a detail / update / delete call.

Pagination

Parameter	Description
page	Page number, 1-based. Default 1.
per_page	Items 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 Channels datagrid filters.

Parameter	Match	Example
code	Partial (contains), on the channel code.	?code=default
name	Partial (contains), on the channel's translated name.	?name=Store
hostname	Partial (contains), on the channel hostname.	?hostname=example.com

Sorting

Parameter	Values
sort	id (default), code, name
order	asc, desc (default desc)

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

Notes

• Listing rows are slim: the detail-only nested data — locales, currencies, inventorySources, and translations — is not included here. Fetch a single channel with the detail endpoint to get it populated.
• code and hostname match against the channel row; name matches against the channel's translation for the current locale.

See the Channels overview for field meanings and behaviour.