Skip to content

SavedSearch

Endpoints · All schemas

FieldRequiredDescription
nameYesName shown in the search palette
queryYesThe search body to run, as the client sends it to the search endpoints

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "name": {
      "description": "Name shown in the search palette",
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "query": {
      "additionalProperties": {},
      "description": "The search body to run, as the client sends it to the search endpoints",
      "type": "object"
    }
  },
  "required": [
    "name",
    "query"
  ],
  "type": "object"
}