Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Theme

List Themes

List of all themes available in the workspace

get/workspaces/{workspace_id}/themes

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Theme ID

public_idstring nullable

Theme public ID

workspace_idinteger

Workspace ID

namestring

The original name of the theme

custom_namestring nullable

A custom name to override the theme name

current_style_idinteger nullable

The style that will be applied to the theme

created_atstring date-time nullable

Created at

updated_atstring date-time nullable

Updated at

template_pagesobject

A map whose keys are template-type names and whose values are the public id (string) of the page that renders each template type, or null when none is configured. The object is open-ended — there are approximately 22 template types in total (for example: home_template_page, not_found_template_page, coming_soon_template_page, order_confirmation_template_page, checkout_template_page, blog_template_page, blogs_post_template_page, product_template_page, member_login_template_page, customer_center_template_page, and others).

Example response

[
  {
    "id": 2,
    "public_id": "dkGlMT",
    "workspace_id": 42000,
    "name": "Original Name",
    "custom_name": "Custom Name",
    "current_style_id": 5,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "styles": [
      {
        "id": 5,
        "name": "Example Style"
      },
      {
        "id": 4,
        "name": "Example Style"
      }
    ],
    "template_pages": {
      "home_template_page": "RcHPAt",
      "not_found_template_page": "Bd2kQ9",
      "coming_soon_template_page": null
    }
  }
]