Sign in
Search

Search for elements

Search for elements based on the given <strong>{search term}</strong>. <br> Elements are searched with the fulltext filter applied via Generic Data Index. <br>

get/pimcore-studio/api/search

Request

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

Query parameters

pageinteger required
Example:1

Page number

pageSizeinteger required
Example:10

Number of items per page

searchTermstring
Example:Example string

Search term

Response

Search results for elements

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "customAttributes": {
        "icon": {
          "type": "path",
          "value": "/path/to/icon"
        },
        "tooltip": "<b>My Tooltip</b>",
        "additionalIcons": [
          "some_other_icon"
        ],
        "key": "my_custom_key",
        "additionalCssClasses": [
          "my_custom_class"
        ]
      },
      "elementType": "asset",
      "type": "image",
      "path": "/path/to/asset",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.