API basics

Storefront API

Authentication
Account
Account / Address
Account / Credit Cards
Account / Orders
Order Status
Cart
Cart / Line Items
Cart / Other
Cart / Coupons
Checkout
Checkout / State
Checkout / Shipments
Checkout / Payments
Checkout / Store Credit
Stripe
Products
Vendors
Stores
Taxons
Countries
CMS Pages
- GET
  List all CMS Pages
- GET
  Retrieve a CMS Page
Menus
Wishlists
Wishlists / Wished Items
Digital Downloads

Platform API

Authentication
Addresses
Adjustments
Classifications
CMS Pages
CMS Sections
Countries
Data Feeds
Digital Links
Digital Assets
Line Items
Menu Items
Menus
Option Types
Option Values
Orders
Payment Methods
Payments
Products
Promotion Actions
Promotion Categories
Promotion Rules
Promotions
Roles
Shipments
Shipping Categories
Shipping Methods
States
Stock Items
Stock Locations
Store Credit Categories
Store Credit Types
Store Credits
Tax Categories
Tax Rates
Taxonomies
Taxons
Users
Variants
Vendors
Webhook Events
Webhook Subscribers
Wished Items
Wishlists
Zones

CMS Pages

Retrieve a CMS Page

To return a single CMS Page you can use the CMS Page slug:

GET /api/v2/storefront/cms_pages/about-us

or CMS Page ID:

GET /api/v2/storefront/cms_pages/37

Note: API will attempt a Slug lookup before an ID lookup.

GET

api

storefront

cms_pages

{cms_page_slug}

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

application/vnd.api+json

200 Success - Returns the `cms_page` object.

data

object

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

included

object[]

Hello!

Was this page helpful?

Suggest edits Raise issue

List all CMS Pages List all Menus

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": []
      }
    }
  }
}