GET
/
api
/
v2
/
platform
/
cms_sections
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/cms_sections \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1",
      "type": "cms_section",
      "attributes": {
        "name": "Culpa natus incidunt nisi itaque quod harum quisquam nesciunt.",
        "content": {},
        "settings": {
          "gutters": "No Gutters"
        },
        "fit": "Screen",
        "destination": null,
        "type": "Spree::Cms::Sections::HeroImage",
        "position": 1,
        "linked_resource_type": "Spree::Taxon",
        "created_at": "2022-11-08T19:34:03.525Z",
        "updated_at": "2022-11-08T19:34:03.525Z"
      },
      "relationships": {
        "cms_page": {
          "data": {
            "id": "13",
            "type": "cms_page"
          }
        },
        "linked_resource": {
          "data": null
        }
      }
    },
    {
      "id": "2",
      "type": "cms_section",
      "attributes": {
        "name": "Aperiam quo deserunt qui quidem unde ratione.",
        "content": {
          "link_type_one": "Spree::Taxon",
          "link_type_two": "Spree::Taxon",
          "link_type_three": "Spree::Taxon"
        },
        "settings": {
          "layout_style": "Default"
        },
        "fit": "Container",
        "destination": null,
        "type": "Spree::Cms::Sections::ImageGallery",
        "position": 2,
        "linked_resource_type": null,
        "created_at": "2022-11-08T19:34:03.529Z",
        "updated_at": "2022-11-08T19:34:03.529Z"
      },
      "relationships": {
        "cms_page": {
          "data": {
            "id": "13",
            "type": "cms_page"
          }
        },
        "linked_resource": {
          "data": null
        }
      }
    },
    {
      "id": "3",
      "type": "cms_section",
      "attributes": {
        "name": "Molestiae quo distinctio enim dignissimos laborum cumque.",
        "content": {},
        "settings": {
          "gutters": "No Gutters"
        },
        "fit": "Screen",
        "destination": null,
        "type": "Spree::Cms::Sections::FeaturedArticle",
        "position": 3,
        "linked_resource_type": "Spree::Taxon",
        "created_at": "2022-11-08T19:34:03.534Z",
        "updated_at": "2022-11-08T19:34:03.534Z"
      },
      "relationships": {
        "cms_page": {
          "data": {
            "id": "13",
            "type": "cms_page"
          }
        },
        "linked_resource": {
          "data": null
        }
      }
    },
    {
      "id": "4",
      "type": "cms_section",
      "attributes": {
        "name": "Quaerat ad enim consequuntur vitae.",
        "content": {},
        "settings": {
          "gutters": "No Gutters"
        },
        "fit": "Screen",
        "destination": null,
        "type": "Spree::Cms::Sections::HeroImage",
        "position": 4,
        "linked_resource_type": "Spree::Product",
        "created_at": "2022-11-08T19:34:03.539Z",
        "updated_at": "2022-11-08T19:34:03.539Z"
      },
      "relationships": {
        "cms_page": {
          "data": {
            "id": "13",
            "type": "cms_page"
          }
        },
        "linked_resource": {
          "data": {
            "id": "21",
            "type": "product"
          }
        }
      }
    },
    {
      "id": "5",
      "type": "cms_section",
      "attributes": {
        "name": "Quod saepe occaecati et eaque eum expedita ut.",
        "content": {},
        "settings": {
          "gutters": "No Gutters"
        },
        "fit": "Screen",
        "destination": null,
        "type": "Spree::Cms::Sections::HeroImage",
        "position": 5,
        "linked_resource_type": "Spree::Product",
        "created_at": "2022-11-08T19:34:03.543Z",
        "updated_at": "2022-11-08T19:34:03.543Z"
      },
      "relationships": {
        "cms_page": {
          "data": {
            "id": "13",
            "type": "cms_page"
          }
        },
        "linked_resource": {
          "data": {
            "id": "21",
            "type": "product"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 5,
    "total_count": 5,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/cms_sections?page=1&per_page=&include=&filter[name_eq]=",
    "next": "http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/cms_sections?filter%5Bname_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[name_eq]
string

Response

200
application/vnd.api+json
Records returned
​
data
object[]
required
​
meta
object
required
​
links
object
required

Was this page helpful?

Suggest editsRaise issue
Update a CMS PageCreate a CMS Section