Retrieve pages matching the specified criteria.
GET
/V1/cmsPage/search
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/cmsPage/search'
Response examples (200)
{
"items": [
{
"id": 42,
"identifier": "string",
"title": "string",
"page_layout": "string",
"meta_title": "string",
"meta_keywords": "string",
"meta_description": "string",
"content_heading": "string",
"content": "string",
"creation_time": "string",
"update_time": "string",
"sort_order": "string",
"layout_update_xml": "string",
"custom_theme": "string",
"custom_root_template": "string",
"custom_layout_update_xml": "string",
"custom_theme_from": "string",
"custom_theme_to": "string",
"active": true
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 42,
"current_page": 42
},
"total_count": 42
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<items type="array">
<item>
<id type="integer">42</id>
<identifier>string</identifier>
<title>string</title>
<page-layout>string</page-layout>
<meta-title>string</meta-title>
<meta-keywords>string</meta-keywords>
<meta-description>string</meta-description>
<content-heading>string</content-heading>
<content>string</content>
<creation-time>string</creation-time>
<update-time>string</update-time>
<sort-order>string</sort-order>
<layout-update-xml>string</layout-update-xml>
<custom-theme>string</custom-theme>
<custom-root-template>string</custom-root-template>
<custom-layout-update-xml>string</custom-layout-update-xml>
<custom-theme-from>string</custom-theme-from>
<custom-theme-to>string</custom-theme-to>
<active type="boolean">true</active>
</item>
</items>
<search-criteria>
<filter-groups type="array">
<filter-group>
<filters type="array">
<filter>
<field>string</field>
<value>string</value>
<condition-type>string</condition-type>
</filter>
</filters>
</filter-group>
</filter-groups>
<sort-orders type="array">
<sort-order>
<field>string</field>
<direction>string</direction>
</sort-order>
</sort-orders>
<page-size type="integer">42</page-size>
<current-page type="integer">42</current-page>
</search-criteria>
<total-count type="integer">42</total-count>
</root>
Response examples (401)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
Response examples (500)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (500)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
Response examples (default)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>