> This page is for Developer. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.bigcommerce.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server. # Site Content with the GraphQL Storefront API BigCommerce's GraphQL Storefront API allows you to retrieve site content from each storefront channel. Having access to site content makes it easier to build headless storefront applications using BigCommerce's built-in content, such as theme widgets. Developers can use frontend GraphQL to perform the following: * Query [web page content](https://support.bigcommerce.com/s/article/Web-Pages?language=en_US), including HTML pages, contact forms, blog posts, and more * Retrieve [banner content](https://support.bigcommerce.com/s/article/Creating-Editing-Banners?language=en_US) on home, search, category, and brand pages * Retrieve rendered [widgets](https://support.bigcommerce.com/s/article/Page-Builder?language=en_US#builder) built using Page Builder or the [Widgets API](/developer/docs/admin/widgets-and-scripts) * Retrieve web pages and blog posts using the web page URL For more information on web pages, see [Page Types](/developer/api-reference/rest/admin/content/pages#page-types). Queries don't support RSS-syndicated content pages, as these are deprecated. GraphQL Storefront API queries are made in the context of a particular storefront channel; for example, queries for web pages return only web pages for a specific storefront channel. For information on how to send requests for your storefront context, see [GraphQL Storefront API Overview FAQ](/developer/docs/storefront/guides/graphql-storefront-api#faq-querying-for-channels-other-than-stencil-storefronts-and-querying-from-external-systems). ## Web pages Retrieve web pages using the following example or [using a route](#routes). When you query web pages for the default storefront channel, the response includes the main blog index page. Use the `isVisibleInNavigation` field to filter for only pages that appear in the storefront's navigation menu. Without the filter, queries also return pages that are hidden from the menu, as these pages are still accessible by URL. The filter applies to both web pages and the main index blog page. #### Request **`Example query: Get web pages`** ```graphql title="Example query: Get web pages" showLineNumbers={false} query { site { content { pages (filters: {isVisibleInNavigation: true }) { edges { node { # Fields that return for all web page types ... on WebPage { __typename entityId name parentEntityId seo { pageTitle metaKeywords metaDescription } } # Fields that return for plain-text pages ... on NormalPage { plainTextSummary (characterLimit: 100) path } # Fields that return for external link pages ... on ExternalLinkPage { link } # Fields that return for contact forms ... on ContactPage { path plainTextSummary (characterLimit: 100) contactFields } # Fields that return for raw HTML pages ... on RawHtmlPage { path htmlBody } # Fields that return for main blog index page ... on BlogIndexPage { path } } } } } } } ``` #### Response **`Example query: Get web pages`** ```json title="Example query: Get web pages" showLineNumbers={false} # The response lists web pages ordered by entityId, with the lowest IDs, returned first { "data": { "site": { "content": { "pages": { "edges": [ { "node": { "__typename": "NormalPage", "entityId": 2, "name": "Shipping & Returns", "parentEntityId": null, "seo": { "pageTitle": "Shipping & Returns", "metaKeywords": "Shipping and Return Policy", "metaDescription": "Shipping and Return Policy" }, "plainTextSummary": "To edit this page, log in to your control panel and go to Storefront › Web Pages. Click Edit next...", "path": "/shipping-returns/" } }, { "node": { "__typename": "BlogIndexPage", "entityId": 3, "name": "Blogs for the store", "parentEntityId": null, "seo": { "pageTitle": "Blogs for the store", "metaKeywords": "", "metaDescription": "Blogs about top products" }, "path": "/blogs/" } }, { "node": { "__typename": "ContactPage", "entityId": 6, "name": "Contact Us Form", "parentEntityId": null, "seo": { "pageTitle": "Contact Us Now!!", "metaKeywords": "Contact Us", "metaDescription": "Contact Info" }, "path": "/contact-us-form/", "plainTextSummary": "Visitors can use the form on this page to submit questions or feedback. \r\nStore is located in...", "contactFields": [ "fullname", "phone" ] } }, { "node": { "__typename": "ExternalLinkPage", "entityId": 8, "name": "Youtube page", "parentEntityId": null, "seo": { "pageTitle": "", "metaKeywords": "", "metaDescription": "" }, "link": "https://www.youtube.com/" } }, { "node": { "__typename": "RawHtmlPage", "entityId": 9, "name": "Random page", "parentEntityId": null, "seo": { "pageTitle": "", "metaKeywords": "", "metaDescription": "" }, "path": "/random-page/", "htmlBody": "\r\n\r\n\r\n\r\nExample page\r\n\r\n\r\n\r\n\r\nExample body\r\n\r\n\r\n" } } ] } } } } } ``` ### Rendered regions Retrieve rendered widgets on plain-text pages. This query returns the rendered HTML content for all widgets that are [placed in Regions](/developer/docs/admin/widgets-and-scripts/guide#create-a-placement) on the given page. #### Request **`Example query: Get rendered regions on plain-text pages`** ```graphql title="Example query: Get rendered regions on plain-text pages" showLineNumbers={false} query { site { content { pages (filters: {pageType: NORMAL}) { edges { node { ... on NormalPage { path renderedRegions { regions { name html } } } } } } } } } ``` #### Response **`Example query: Get rendered regions on plain-text pages`** ```json title="Example query: Get rendered regions on plain-text pages" showLineNumbers={false} { "data": { "site": { "content": { "pages": { "edges": [ { "node": { "path": "/shipping-returns/", "renderedRegions": { "regions": [ { "name": "header_below_nav--global", "html": "
\n \n
\n \n
\n\n\n
\n
\n
" }, { "name": "header_bottom--global", "html": "
\n \n
\n \n
\n
\n
\n \n
\n \n
\n\n
\n
\n
\n
\n
\n
\n
\n \n
\n \n
\n
\n \n
\n
" } ] } } } ] } } } } } ``` ## Blogs Retrieve blogs using the following example or [using a route](#routes). Queries for blogs retrieve published blog posts and exclude draft blogs. Queries return published blogs even if they are hidden from the storefront's navigation menu, as the main blog index page and published blog posts are still accessible by URL. #### Request **`Example query: Get blogs`** ```graphql title="Example query: Get blogs" showLineNumbers={false} query { site { content { blog { name description path posts (filters: {tags:["Most Popular", "Holiday"]}) { edges { node { entityId name tags htmlBody plainTextSummary (characterLimit: 100) author path publishedDate { utc } thumbnailImage { url (width: 100, height: 200) urlOriginal altText isDefault } seo { pageTitle metaKeywords metaDescription } } } } } } } } ``` #### Response **`Example query: Get blogs`** ```json title="Example query: Get blogs" showLineNumbers={false} { "data": { "site": { "content": { "blog": { "name": "Blog", "description": "", "path": "/blog/", "posts": { "edges": [ { "node": { "entityId": 4, "name": "How to seed your garden", "tags": [ "Best Reviews", "Most Popular" ], "htmlBody": "

1. Sow at a suitable depth
2. Plant at the specified spacing for your plant

", "plainTextSummary": "1. Sow at a suitable depth2. Plant at the specified spacing for your plant", "author": "Anonymous", "path": "/blog/how-to-seed-your-garden/", "publishedDate": { "utc": "2023-06-06T19:29:58Z" }, "thumbnailImage": { "url": "https://cdn11.bigcommerce.com/s-o8ertuc7vw/images/stencil/100x200/uploaded_images/flower.jpg", "urlOriginal": "https://cdn11.bigcommerce.com/s-o8ertuc7vw/images/stencil/original/uploaded_images/flower.jpg", "altText": "How to seed your garden", "isDefault": true }, "seo": { "pageTitle": "How to seed your garden", "metaKeywords": "Best Reviews,Most Popular", "metaDescription": "Flower products" } } }, { "node": { "entityId": 1, "name": "Indoor Planting", "tags": [ "Holiday", "Lowest Price" ], "htmlBody": "

1. Pay attention to humidity
2. Provide adequate lighting

", "plainTextSummary": "1. Pay attention to humidity2. Provide adequate lighting", "author": "Anonymous", "path": "/blog/indoor-planting/", "publishedDate": { "utc": "2014-02-15T19:31:55Z" }, "thumbnailImage": null, "seo": { "pageTitle": "Indoor Planting", "metaKeywords": "Holiday,Lowest Price", "metaDescription": "" } } } ] } } } } } } ``` ## Routes Retrieve web pages, the main blog index page, and blog posts using the web page URL. The following query retrieves information for the page with the given path URL. #### Request **`Example query: Get page using a route`** ```graphql title="Example query: Get page using a route" showLineNumbers={false} query { site { route(path: "/blogs/") { node { id # Fields that return for plain-text pages, contact forms, and raw HTML pages ... on WebPage { entityId parentEntityId name isVisibleInNavigation seo { metaKeywords metaDescription } } # Fields that return for plain-text pages ... on NormalPage { path plainTextSummary (characterLimit: 100) } # Fields that return for contact forms ... on ContactPage { path plainTextSummary (characterLimit: 100) contactFields } # Fields that return for raw HTML pages ... on RawHtmlPage { path htmlBody } # Fields that return for main blog index page ... on Blog { name description path isVisibleInNavigation posts { edges { node { name tags } } } } # Fields that return for blog posts ... on BlogPost { name tags } } } } } ``` #### Response **`Example query: Get page using a route`** ```json title="Example query: Get page using a route" showLineNumbers={false} { "data": { "site": { "route": { "node": { "id": "QmxvZzoz", "name": "Blogs for the store", "description": "Blogs about top products", "path": "/blogs/", "isVisibleInNavigation": true, "posts": { "edges": [ { "node": { "name": "How to seed your garden", "tags": [ "Best Reviews", "Most Popular" ] } }, { "node": { "name": "Indoor Planting", "tags": [ "Holiday", "Lowest Price" ] } } ] } } } } } } ``` ## Banners Retrieve [banners](https://support.bigcommerce.com/s/article/Creating-Editing-Banners?language=en_US) using the following example. Queries return only visible banners. #### Request **`Example query: Get banners`** ```graphql title="Example query: Get banners" showLineNumbers={false} query { site { content { banners { homePage { edges { node { entityId name content location } } } searchPage { edges { node { entityId name content location } } } categoryPage (categoryEntityId: 29) { edges { node { entityId name content location } } } brandPage (brandEntityId: 41) { edges { node { entityId name content location } } } } } } } ``` #### Response **`Example query: Get banners`** ```json title="Example query: Get banners" showLineNumbers={false} { "data": { "site": { "content": { "banners": { "homePage": { "edges": [ { "node": { "entityId": 1, "name": "Flower Promotion", "content": "

BUY A Flower TODAY!!! 

", "location": "TOP" } } ] }, "searchPage": { "edges": [ { "node": { "entityId": 6, "name": "Buy One Get One Free", "content": "

Buy a plant, get one free!

", "location": "TOP" } } ] }, "categoryPage": { "edges": [ { "node": { "entityId": 2, "name": "Spring Flower Sale", "content": "

20% off all outdoor flowers

", "location": "BOTTOM" } } ] }, "brandPage": { "edges": [ { "node": { "entityId": 3, "name": "Most Recommended Brand", "content": "

Best reviews on all marketplace channels

", "location": "TOP" } } ] } } } } } } ``` ## Resources ### Docs and reference * [Pages - page types](/developer/api-reference/rest/admin/content/pages#page-types) * [Widgets overview](/developer/docs/admin/widgets-and-scripts) * [Tutorial on widget placement](/developer/docs/admin/widgets-and-scripts/guide#create-a-placement) ### GraphQL Storefront API * [GraphQL Storefront API overview](/developer/docs/storefront/guides/graphql-storefront-api) * [GraphQL Storefront playground](/developer/api-reference/rest/storefront/overview) ### Help Center articles * [Web pages](https://support.bigcommerce.com/s/article/Web-Pages?language=en_US) * [Banners](https://support.bigcommerce.com/s/article/Creating-Editing-Banners?language=en_US) * [Widgets](https://support.bigcommerce.com/s/article/Page-Builder?language=en_US#builder)