Skip to content

List catalog themes

GET
/themes
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/themes \
--header 'x-api-key: <x-api-key>'

Returns the themes in the Ecomweb catalog that a store can add, sorted by name, each at its latest release with the settings it declares. The list is the same for every store and is not paginated.

Required scopes: none. Any secret key for this store works.

Media typeapplication/json
Array<object>
object
info
required

Free-form details the theme’s release publishes, such as a description.

object
key
additional properties
any
settings_schema
required

The settings the theme declares, as a list of groups. Each group has a name and settings, a list of setting definitions (id, type, label, default and so on) and display items such as headers.

Array<object>
object
key
additional properties
any
id
required

Theme ID, such as default.

string
name
required

Theme name.

string
author
required

Who made the theme.

string
version
required

The latest release, as a semantic version such as 1.2.0.

string

Example generated

[
{
"info": {},
"settings_schema": [
{}
],
"id": "example",
"name": "example",
"author": "example",
"version": "example"
}
]

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}