Get Theme

GET

https://api.bigcommerce.com/stores/:store_hash/v3/themes/:uuid

GET

/stores/:store_hash/v3/themes/:uuid

curl https://api.bigcommerce.com/stores/store_hash/v3/themes/uuid \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200response

{
  "data": {
    "variations": [
      {
        "description": "Ideal for a wide range of businesses and brands, this design is fully responsive, simple, and ready for you to add your branding, logo, and products. It comes ready to build a clean looking and beautiful store with features such as homepage carousel, social media icons, featured and top selling products, and faceted search (which is available on select BigCommerce plans). Fully express your brand by using our Theme Editor to quickly and easily style your site’s fonts and colors, all without the need to write code.",
        "external_id": "light",
        "name": "Light",
        "uuid": "b16c3fe0-7bcb-0136-b5fc-07fe54a9e639"
      },
      {
        "description": "Ideal for a wide range of businesses and brands, this design is fully responsive, simple, and ready for you to add your branding, logo, and products. It comes ready to build a clean looking and beautiful store with features such as homepage carousel, social media icons, featured and top selling products, and faceted search (which is available on select BigCommerce plans). Fully express your brand by using our Theme Editor to quickly and easily style your site’s fonts and colors, all without the need to write code.",
        "external_id": "bold",
        "name": "Bold",
        "uuid": "b17d57e0-7bcb-0136-b5fc-07fe54a9e639"
      },
      {
        "description": "Ideal for a wide range of businesses and brands, this design is fully responsive, simple, and ready for you to add your branding, logo, and products. It comes ready to build a clean looking and beautiful store with features such as homepage carousel, social media icons, featured and top selling products, and faceted search (which is available on select BigCommerce plans). Fully express your brand by using our Theme Editor to quickly and easily style your site’s fonts and colors, all without the need to write code.",
        "external_id": "warm",
        "name": "Warm",
        "uuid": "b18ad610-7bcb-0136-b5fc-07fe54a9e639"
      }
    ],
    "uuid": "e3d82ce0-9bae-0133-0de7-525400970412",
    "name": "Cornerstone",
    "is_private": false,
    "is_active": false,
    "updated_at": "2022-09-15T09:14:15Z"
  },
  "meta": {}
}

Returns a store Theme. The theme variation is not available at this endpoint.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Themes	modify	`store_themes_manage`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

uuidstringRequired

The theme identifier.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

dataobjectOptional

A theme.

metaobjectOptional

Response metadata.