Sign in
Search

List saved search configurations

Changed on

List the saved search configurations accessible to the current user. <br> Includes configurations owned by the user as well as those shared with them. <br> Optionally filter by name via <strong>searchTerm</strong> and page through the results.

get/pimcore-studio/api/search/saved/configuration

Request

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

Query parameters

pageinteger required
Example:1

Page number

pageSizeinteger required
Example:10

Number of items per page

searchTermstring
Example:Example string

Optional term to filter the saved search configurations by name.

sortBy'name' | 'modificationDate'

Sort by field.

sortOrder'ASC' | 'DESC'
Example:ASC

Sort order (asc or desc).

Response

List of saved search configurations

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "id": 42,
      "name": "My Configuration",
      "description": "My Configuration Description",
      "owner": true,
      "modificationDate": 1634025600,
      "creationDate": 1634025600,
      "menuShortcutGroup": "My Group",
      "elementType": "asset"
    }
  ]
}

Changes