Skip to main content
GET
/
api
/
v2
/
storefront
/
cms_pages
List all CMS Pages
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/cms_pages
{
  "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": []
        }
      }
    },
    {
      "id": "2",
      "type": "cms_page",
      "attributes": {
        "title": "Privacy Policy",
        "content": "Veniam quasi atque facilis soluta sed corporis. Dignissimos repudiandae aut eos deserunt cupiditate optio nemo neque. Perferendis cupiditate nemo tempora unde quasi beatae sapiente. Illum ipsum adipisci ducimus facilis culpa sunt. Optio quam atque dolorum vero deserunt harum. Saepe eveniet laborum hic vel adipisci maxime. Sit repudiandae iusto totam reprehenderit. Repellendus assumenda blanditiis repellat similique eaque. Illo cumque omnis maiores ex praesentium illum. Voluptates eveniet nulla tempore debitis alias ullam pariatur.",
        "locale": "en",
        "meta_description": null,
        "meta_title": null,
        "slug": "privacy-policy",
        "type": "Spree::Cms::Pages::StandardPage"
      },
      "relationships": {
        "cms_sections": {
          "data": []
        }
      }
    },
    {
      "id": "3",
      "type": "cms_page",
      "attributes": {
        "title": "Shipping Policy",
        "content": "Ab dignissimos perspiciatis blanditiis laborum ipsum. Amet quo laborum vitae incidunt vero error neque. Eius aspernatur sit suscipit minima minus. Iste cupiditate nulla laudantium labore inventore magni. Nemo ipsam quasi consectetur cupiditate iure facilis mollitia. Quos earum cumque recusandae aliquam quasi labore. Autem magni libero eaque vitae veritatis. Sequi vitae amet accusantium perspiciatis adipisci. Dolorem aspernatur veritatis ad consequuntur aliquam sapiente autem necessitatibus.",
        "locale": "en",
        "meta_description": null,
        "meta_title": null,
        "slug": "shipping-policy",
        "type": "Spree::Cms::Pages::StandardPage"
      },
      "relationships": {
        "cms_sections": {
          "data": []
        }
      }
    },
    {
      "id": "4",
      "type": "cms_page",
      "attributes": {
        "title": "Returns Policy",
        "content": "Reiciendis ut repellendus sed explicabo. Omnis hic excepturi officia itaque deserunt. Eos reiciendis recusandae dignissimos asperiores sint. Quisquam temporibus repellendus quod reiciendis rem laborum harum perspiciatis. Nemo nesciunt dolore dicta libero officiis suscipit natus. Impedit sit corporis dolores quibusdam voluptates cum. Commodi asperiores reprehenderit placeat quisquam sed. Voluptas architecto adipisci dolorum officia voluptatem.",
        "locale": "en",
        "meta_description": null,
        "meta_title": null,
        "slug": "returns-policy",
        "type": "Spree::Cms::Pages::StandardPage"
      },
      "relationships": {
        "cms_sections": {
          "data": []
        }
      }
    },
    {
      "id": "31",
      "type": "cms_page",
      "attributes": {
        "title": "Homepage (English)",
        "content": null,
        "locale": "en",
        "meta_description": null,
        "meta_title": null,
        "slug": null,
        "type": "Spree::Cms::Pages::Homepage"
      },
      "relationships": {
        "cms_sections": {
          "data": [
            {
              "id": "10",
              "type": "cms_section"
            },
            {
              "id": "22",
              "type": "cms_section"
            },
            {
              "id": "34",
              "type": "cms_section"
            },
            {
              "id": "46",
              "type": "cms_section"
            },
            {
              "id": "58",
              "type": "cms_section"
            },
            {
              "id": "70",
              "type": "cms_section"
            }
          ]
        }
      }
    },
    {
      "id": "25",
      "type": "cms_page",
      "attributes": {
        "title": "Feature Page",
        "content": null,
        "locale": "en",
        "meta_description": null,
        "meta_title": null,
        "slug": "feature-page",
        "type": "Spree::Cms::Pages::FeaturePage"
      },
      "relationships": {
        "cms_sections": {
          "data": [
            {
              "id": "4",
              "type": "cms_section"
            },
            {
              "id": "16",
              "type": "cms_section"
            },
            {
              "id": "28",
              "type": "cms_section"
            },
            {
              "id": "40",
              "type": "cms_section"
            },
            {
              "id": "52",
              "type": "cms_section"
            },
            {
              "id": "64",
              "type": "cms_section"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": 6,
    "total_count": 6,
    "total_pages": 1
  },
  "links": {
    "self": "http://localhost:3000/api/v2/storefront/cms_pages",
    "next": "http://localhost:3000/api/v2/storefront/cms_pages?page=1",
    "prev": "http://localhost:3000/api/v2/storefront/cms_pages?page=1",
    "last": "http://localhost:3000/api/v2/storefront/cms_pages?page=1",
    "first": "http://localhost:3000/api/v2/storefront/cms_pages?page=1"
  }
}

Query Parameters

​
filter[type]
string

Fetch only resources with corresponding Type

Example:

"home"

​
filter[title]
string

Fetch only resources with correspondingTitle

Example:

"About Us"

​
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"

​
per_page
integer

Number of requested records per page when paginating collection

Response

200 Success - Returns an array of cms_page objects.

​
data
CMS Page · object[]
required
​
meta
object
required
​
links
object
required
​
included
CMS Page Includes · object[]