List Widgets

GET

https://api.bigcommerce.com/stores/:store_hash/v3/content/widgets

GET

/stores/:store_hash/v3/content/widgets

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

{
  "data": [
    {
      "channel_id": 1,
      "date_created": "2020-12-21T19:54:16.406Z",
      "date_modified": "2020-12-21T19:54:16.406Z",
      "description": "",
      "name": "Header Images",
      "uuid": "1f05183e-dfa4-4583-af28-250b47e177b2",
      "version_uuid": "c863f77b-e5b4-4462-a9ed-2aff9005140e",
      "widget_configuration": {
        "_": {
          "id": "1f05183e-dfa4-4583-af28-250b47e177b2"
        },
        "images": [
          {
            "image_source": "https://cdn11.bigcommerce.com/s-n0i50vy/images/stencil/1280x1280/products/109/361/kinfolkessentialissue_1024x1024__22507.1456436715.jpg?c=2&imbypass=on"
          },
          {
            "image_source": "https://cdn11.bigcommerce.com/s-n0i50vy/images/stencil/500x659/products/85/282/livingwithplants_grande__26452.1456436666.jpg?c=2&imbypass=on"
          },
          {
            "image_source": "https://cdn11.bigcommerce.com/s-n0i50vy/images/stencil/1280x1280/products/109/361/kinfolkessentialissue_1024x1024__22507.1456436715.jpg?c=2&imbypass=on"
          }
        ]
      },
      "widget_template": {
        "current_version_uuid": "c863f77b-e5b4-4462-a9ed-2aff9005140e",
        "date_created": "2020-12-21T19:49:29.110Z",
        "date_modified": "2020-12-21T19:49:29.110Z",
        "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"
      },
      "storefront_api_query_params": {}
    },
    {
      "channel_id": 1,
      "date_created": "2020-12-21T20:26:18.557Z",
      "date_modified": "2020-12-21T20:26:18.557Z",
      "description": "",
      "name": "Simple List",
      "uuid": "7a842254-96ad-475f-9fe5-a59695e9685f",
      "version_uuid": "c23dd66b-fa3f-451d-88ef-9f4082c6051e",
      "widget_configuration": {
        "_": {
          "id": "7a842254-96ad-475f-9fe5-a59695e9685f"
        },
        "list_items": [
          {
            "color": "blue",
            "text": "The color is blue"
          },
          {
            "color": "green",
            "text": "The color is green"
          },
          {
            "color": "red",
            "text": "The color is red"
          }
        ]
      },
      "widget_template": {
        "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"
      },
      "storefront_api_query_params": {}
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Returns a list of Widgets. Optional parameters can be passed in.

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.

widget_template_uuidstringOptionalformat: "uuid"

The identifier for a specific widget template.

namestringOptional

The URL-encoded name of the widget.

name:inlist of stringsOptional

Use to pass in comma-separated list of widget names. Example: /widgets?name:in=test-widget-name,header%20images

channel_id:inlist of integersOptional

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

site_id:inlist of integersOptional

A comma-separated list of site IDs to filter the results by.

Response

A list of widgets.

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

422

Unprocessable Entity Error