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.

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.

Response

200 - application/vnd.api+json

data

object

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

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.content

string | null

data.attributes.locale

string

data.attributes.meta_description

string | null

data.attributes.meta_title

string | null

data.attributes.slug

string | null

data.attributes.title

string

data.attributes.type

string

data.id

string

required

data.relationships

object

required

Show child attributes

data.relationships.cms_sections

object

Show child attributes

data.relationships.cms_sections.data

array | null

Show child attributes

data.relationships.cms_sections.data.id

string

required

data.relationships.cms_sections.data.type

string

required

data.type

string

default:

cms_page

required

included

object[]

Show child attributes

included.attributes

object

required

Show child attributes

included.attributes.content

object | null

included.attributes.fit

string

included.attributes.image_one_lg

string | null

included.attributes.image_one_md

string | null

included.attributes.image_one_sm

string | null

included.attributes.image_one_xl

string | null

included.attributes.image_three_lg

string | null

included.attributes.image_three_md

string | null

included.attributes.image_three_sm

string | null

included.attributes.image_three_xl

string | null

included.attributes.image_two_lg

string | null

included.attributes.image_two_md

string | null

included.attributes.image_two_sm

string | null

included.attributes.image_two_xl

string | null

included.attributes.is_full_screen

boolean

included.attributes.link

string | null

included.attributes.name

string

included.attributes.position

integer

included.attributes.settings

object | null

included.attributes.type

string

included.id

string

required

included.relationships

object

required

Show child attributes

included.relationships.linked_resource

object

Show child attributes

included.relationships.linked_resource.data

object | null

Show child attributes

included.relationships.linked_resource.data.id

string

required

included.relationships.linked_resource.data.type

string

required

included.type

string

default:

cms_section

required