List Widget Templates

GET

https://api.bigcommerce.com/stores/:store_hash/v3/content/widget-templates

GET

/stores/:store_hash/v3/content/widget-templates

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

{
  "data": [
    {
      "current_version_uuid": "4bd7619e-7992-4454-8610-84fb16449761",
      "date_created": "2020-12-21T19:36:16.896Z",
      "date_modified": "2020-12-21T19:36:16.896Z",
      "icon_name": "default",
      "kind": "custom",
      "name": "Header Images",
      "schema": [],
      "storefront_api_query": "",
      "template": "{{#each images}}{{/each}}",
      "uuid": "f8459145-da8f-4d98-93e4-83aa47da61c6",
      "channel_id": 1,
      "client_rerender": false,
      "template_engine": "handlebars_v3"
    },
    {
      "current_version_uuid": "c23dd66b-fa3f-451d-88ef-9f4082c6051e",
      "date_created": "2020-12-21T19:36:59.384Z",
      "date_modified": "2020-12-21T19:36:59.384Z",
      "icon_name": "default",
      "kind": "custom",
      "name": "Simple List",
      "schema": [],
      "storefront_api_query": "",
      "template": "<ul>{{#each list_items}}<li style='color:{{color}};'>{{text}}</li>{{/each}}</ul>",
      "uuid": "42b42cbb-e2d8-4f2a-97ea-06755032115a",
      "channel_id": 1,
      "client_rerender": false,
      "template_engine": "handlebars_v3"
    },
    {
      "current_version_uuid": "bc820372-368e-4a96-a6d6-f313edba5617",
      "date_created": "2020-12-21T19:38:08.036Z",
      "date_modified": "2020-12-21T19:38:08.036Z",
      "icon_name": "default",
      "kind": "custom",
      "name": "Simple Text with Styling",
      "schema": [],
      "storefront_api_query": "",
      "template": "{{text}}\n",
      "uuid": "17dcc919-982a-4cc0-8ede-a5b49f9ab6dc",
      "channel_id": 1,
      "client_rerender": false,
      "template_engine": "handlebars_v3"
    },
    {
      "current_version_uuid": "873b0a03-b219-46ec-8f06-c3c4522ef25d",
      "date_created": "2020-12-21T19:38:30.223Z",
      "date_modified": "2020-12-21T19:38:30.223Z",
      "icon_name": "default",
      "kind": "custom",
      "name": "YouTube Embed",
      "schema": [],
      "storefront_api_query": "",
      "template": "",
      "uuid": "d9e7fd0e-d5c2-45c9-8919-ce68a5590c12",
      "channel_id": 1,
      "client_rerender": false,
      "template_engine": "handlebars_v3"
    },
    {
      "current_version_uuid": "8fa7ff13-fcfb-4106-9c32-5a084224a444",
      "date_created": "2020-12-21T19:38:46.557Z",
      "date_modified": "2020-12-21T19:38:46.557Z",
      "icon_name": "default",
      "kind": "custom",
      "name": "Slider Template",
      "schema": [],
      "storefront_api_query": "",
      "template": "{{#each slides}}\n{{/each}}",
      "uuid": "30714957-0e01-4c4e-8551-25591261d0d0",
      "channel_id": 1,
      "client_rerender": false,
      "template_engine": "handlebars_v3"
    },
    {
      "current_version_uuid": "7494d009-c695-43ce-a1eb-ba75ef663ba2",
      "date_created": "2020-06-23T18:07:12.110Z",
      "date_modified": "2020-06-23T18:07:12.110Z",
      "icon_name": "default",
      "kind": "pp-cartpage-fullbanner",
      "name": "PayPal Credit Banner - Cart Page (728x90)",
      "schema": [],
      "storefront_api_query": "",
      "template": "",
      "uuid": "2ff24732-6848-47ba-9a7f-c8b1d444f270",
      "channel_id": 0,
      "client_rerender": false,
      "template_engine": "handlebars_v3"
    },
    {
      "current_version_uuid": "ee4978a6-31f9-47e2-ab38-810dd1c78e34",
      "date_created": "2020-06-23T18:07:12.136Z",
      "date_modified": "2020-06-23T18:07:12.136Z",
      "icon_name": "default",
      "kind": "pp-homepage-fullbanner",
      "name": "PayPal Credit Banner - Home Page (728x90)",
      "schema": [],
      "storefront_api_query": "",
      "template": "",
      "uuid": "3002bf5b-5eca-4ac2-8f1f-5240c2b74712",
      "channel_id": 0,
      "client_rerender": false,
      "template_engine": "handlebars_v3"
    }
  ],
  "meta": {
    "pagination": {
      "total": 7,
      "count": 7,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Returns a list of Widget Templates.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Content	modify	`store_v2_content`
Content	read-only	`store_v2_content_read_only`

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

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

pageintegerOptional

Specifies the page number in a limited (paginated) list of products.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of products.

widget_template_kindstringOptional

The kind of widget template.

channel_id:inlist of integersOptional

A comma-separated list of channel ids to filter the results by.

Response

A list of widget templates.

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

422

Unprocessable Entity Error