GET
/
api
/
v2
/
platform
/
cms_pages
Return a list of CMS Pages
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/cms_pages \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1",
      "type": "cms_page",
      "attributes": {
        "title": "Modi soluta tenetur velit odit corporis aut.",
        "meta_title": null,
        "content": null,
        "meta_description": null,
        "visible": true,
        "slug": "modi-soluta-tenetur-velit-odit-corporis-aut",
        "type": "Spree::Cms::Pages::StandardPage",
        "locale": "en",
        "deleted_at": null,
        "created_at": "2022-11-08T19:34:00.831Z",
        "updated_at": "2022-11-08T19:34:00.831Z"
      },
      "relationships": {
        "cms_sections": {
          "data": []
        }
      }
    },
    {
      "id": "2",
      "type": "cms_page",
      "attributes": {
        "title": "Distinctio alias numquam porro corrupti enim perferendis fugiat.",
        "meta_title": null,
        "content": null,
        "meta_description": null,
        "visible": true,
        "slug": "distinctio-alias-numquam-porro-corrupti-enim-perferendis-fugiat",
        "type": "Spree::Cms::Pages::StandardPage",
        "locale": "en",
        "deleted_at": null,
        "created_at": "2022-11-08T19:34:00.836Z",
        "updated_at": "2022-11-08T19:34:00.836Z"
      },
      "relationships": {
        "cms_sections": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/cms_pages?page=1&per_page=&include=&filter[type_eq]=&filter[locale_eq]=&filter[title_cont]=",
    "next": "http://www.example.com/api/v2/platform/cms_pages?filter%5Blocale_eq%5D=&filter%5Btitle_cont%5D=&filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/cms_pages?filter%5Blocale_eq%5D=&filter%5Btitle_cont%5D=&filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/cms_pages?filter%5Blocale_eq%5D=&filter%5Btitle_cont%5D=&filter%5Btype_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/cms_pages?filter%5Blocale_eq%5D=&filter%5Btitle_cont%5D=&filter%5Btype_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[type_eq]
string
​
filter[locale_eq]
string
​
filter[title_cont]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.