List Placements

GET

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

GET

/stores/:store_hash/v3/content/placements

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

{
  "data": [
    {
      "channel_id": 1,
      "date_created": "2020-12-21T20:43:16.796Z",
      "date_modified": "2020-12-21T20:43:16.796Z",
      "entity_id": "21",
      "region": "category_header_banner",
      "sort_order": 1,
      "status": "active",
      "template_file": "pages/category",
      "uuid": "89eac5b3-91d7-48e5-92e7-ff53ecf07f8c",
      "widget": {
        "channel_id": 1,
        "date_created": "2020-12-21T19:54:16.406Z",
        "date_modified": "2020-12-21T20:40:45.173Z",
        "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": {}
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Returns a list of Placements.

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.

template_filestringOptional

The template file, for example: pages/home.

widget_uuidstringOptionalformat: "uuid"

The identifier for a specific widget.

widget_template_uuidstringOptionalformat: "uuid"

The identifier for a specific widget template.

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 widget placements.

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

422

Unprocessable Entity Error