Admin Settings: Channels

List channels (datagrid parity)

Paginated, filterable, sortable channels list. Filters: code, name, hostname. Sort: id, code, name.

get/settings/channels

Request

Query parameters

pageinteger
Example:1

Page number.

per_pageinteger
Example:10

Items per page (default 10, max 50).

codestring
Example:default

Partial code match.

namestring
Example:US

Partial name match.

hostnamestring
Example:example.com

Partial hostname match.

sort'id' | 'code' | 'name'
Example:id

Sort column.

order'asc' | 'desc'
Example:desc

Sort direction.

Response

Paginated channels in the { data, meta } envelope.

idinteger nullable
codestring nullable
namestring nullable
descriptionstring nullable
hostnamestring nullable
themestring nullable
timezonestring nullable
defaultLocaleIdinteger nullable
baseCurrencyIdinteger nullable
rootCategoryIdinteger nullable
isMaintenanceOnboolean nullable
maintenanceModeTextstring nullable
allowedIpsstring[] nullable
logostring nullable
logoUrlstring nullable
faviconstring nullable
faviconUrlstring nullable
localesobject[] nullable
currenciesobject[] nullable
inventorySourcesobject[] nullable
homeSeoobject nullable
translationsobject[] nullable
createdAtstring nullable
updatedAtstring nullable

Changes

No recorded changes to this operation across all 8 revisions of this API.