Skip to content

List Theme Customizations

List the theme customization blocks configured for the store. Returns the standard { data, meta } admin envelope. The per-locale options content is returned only by the detail endpoint.

Endpoint

MethodPathPurpose
GET/api/admin/settings/themesList theme customization blocks

Query parameters

All parameters are optional and combine in a single request — filter, sort and paginate together.

Pagination

ParameterDescription
pagePage number (1-based).
per_pageItems per page (default 10, max 50).

Filters

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

ParameterMatchExample
namePartial (contains).Banner
typeExact.product_carousel
theme_codeExact.default
channel_idExact.1
statusExact — 0 or 1.1

Sorting

ParameterValues
sortid (default), name, type, sort_order, theme_code, channel_id, status
orderasc, desc

All operations require an admin Bearer token — see Authentication.

Released under the MIT License.