Skip to main content

List Branding Themes

Paginated list of branding themes for the selected store. Default sort is is_default descending, then name. Built-in dashboard palettes are not included.

The envelope is { items, pagination }. Default per_page is 25. A page past the last page returns empty items and the requested current_page.

Request

GET /branding-themes

Query Parameters

ParameterTypeRequiredDefaultDescription
pageintegerNo1Page number.
per_pageintegerNo25Items per page (min 1, max 100).

Example Request

curl -X GET "https://cart.easy.tools/api/v1/branding-themes" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response

Success Response (200)

{
"items": [
{
"id": "f670a72a-7a46-4853-9ebb-91ddf691358e",
"name": "Studio",
"is_default": true,
"font": null,
"logo_url": "https://cdn.example.com/branding/studio-logo.png",
"logo_square_url": null,
"brand_color": "#101828",
"background_color": "#f9fafb",
"text_color": "#101828",
"card_background_color": "#ffffff",
"card_text_color": "#101828",
"border_color": "#d0d5dd"
},
{
"id": "9c4e2a18-6b7d-4f31-a8e2-1d5c7b0e4a92",
"name": "Night",
"is_default": false,
"font": null,
"logo_url": null,
"logo_square_url": null,
"brand_color": "#111827",
"background_color": "#030712",
"text_color": "#f9fafb",
"card_background_color": "#111827",
"card_text_color": "#f9fafb",
"border_color": "#374151"
}
],
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 25,
"total": 2
}
}

See Branding Theme Object.

Pagination Object

FieldTypeDescription
current_pageintegerRequested page.
total_pagesintegerTotal pages (at least 1).
per_pageintegerPage size.
totalintegerTotal themes on this store.

Error Responses

Bad Request (400)

Returned when per_page is out of range or not an integer.

{
"message": "Invalid value for 'per_page': '0'"
}

Unauthorized Error (401)

{
"message": "Unauthenticated."
}

Forbidden Error (403)

{
"message": "You do not have API access to the requested store."
}