Website Settings

Get paginated website settings

Changed on

Get all paginated website settings. <br> You can specify different filters in your request body. Example filters are: <br>

<ul> <li><strong>page</strong>: Used for offset calculation in pagination. To be used, needs to be defined together with the page.size</li> <li><strong>pageSize</strong>: Used for limiting the result numbers per page. To be used, needs to be defined together with the page</li> <li><strong>name</strong>: Filter by settings name</li> <li><strong>type</strong>: Filter by settings type (text, document, asset, object, bool)</li> <li><strong>creationDate</strong>: Filter by creation date (on, from, to)</li> </ul>
post/pimcore-studio/api/website-settings

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/website-settings
  • Auth: none declared

Request body

Example request

{
  "filters": {
    "page": 1,
    "pageSize": 50
  }
}

Response

Paginated website settings with total count

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "id": 1,
      "name": "site_title",
      "language": "en",
      "type": "text",
      "data": {
        "id": 1020,
        "fullPath": "/path/to/object"
      },
      "siteId": 1
    }
  ]
}

Changes