Skip to main content
GET
/
api
/
v2
/
storefront
/
cms_pages
/
{cms_page_slug}
Retrieve a CMS Page
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/cms_pages/{cms_page_slug}
{
  "data": {
    "id": "1",
    "type": "cms_page",
    "attributes": {
      "title": "About Us",
      "content": "Corporis consequuntur cumque dicta doloremque. Laborum corrupti nobis magni quos. Veniam ea laudantium tempora libero perferendis illum. Maiores maxime quibusdam quam porro omnis. Libero vitae nesciunt occaecati quasi ipsa laudantium deserunt fuga. Vitae ducimus optio dolorem aliquam inventore fugiat. Minima laborum illo aliquam quam fuga. Ducimus nam quis quo rerum.",
      "locale": "en",
      "meta_description": null,
      "meta_title": null,
      "slug": "about-us",
      "type": "Spree::Cms::Pages::StandardPage"
    },
    "relationships": {
      "cms_sections": {
        "data": []
      }
    }
  }
}

Path Parameters

​
cms_page_slug
string
required

CMS Page Slug

Query Parameters

​
include
string

Pass cms_sections as an include value to fetch the CMS Sections associated with each CMS Page. If you need to fetch the CMS Sections Linked Resource, you can pass cms_sections.linked_resource.

Example:

"cms_sections.linked_resource"

Response

200 Success - Returns the cms_page object.

​
data
object

The CMS Page model contains page data for Standard pages, Feature Pages and Homepages.

​
included
CMS Page Includes · object[]