For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Cart Emails
        • Custom Template Associations
        • Email Templates
        • Pages
        • Marketing
        • Store Content
        • Themes
            • GETList Themes
            • POSTUpload Theme
            • GETGet Theme
            • DELDelete Theme
        • Widgets
        • Page Widgets
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminContentThemes

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
1{
2  "data": {
3    "variations": [
4      {
5        "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.",
6        "external_id": "light",
7        "name": "Light",
8        "uuid": "b16c3fe0-7bcb-0136-b5fc-07fe54a9e639"
9      },
10      {
11        "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.",
12        "external_id": "bold",
13        "name": "Bold",
14        "uuid": "b17d57e0-7bcb-0136-b5fc-07fe54a9e639"
15      },
16      {
17        "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.",
18        "external_id": "warm",
19        "name": "Warm",
20        "uuid": "b18ad610-7bcb-0136-b5fc-07fe54a9e639"
21      }
22    ],
23    "uuid": "e3d82ce0-9bae-0133-0de7-525400970412",
24    "name": "Cornerstone",
25    "is_private": false,
26    "is_active": false,
27    "updated_at": "2022-09-15T09:14:15Z"
28  },
29  "meta": {}
30}

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

Was this page helpful?
Previous

Upload Theme

Next

Delete Theme

Built with

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Themesmodifystore_themes_manage

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

uuidstringRequired
The theme identifier.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Response

dataobject
A theme.
metaobject
Response metadata.