matrix-spec-proposals/api/client-server/definitions/event_filter.json

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "description":
        "The maximum number of events to return."
    },
    "types": {
      "type": "array",
      "description":
        "A list of event types to include. If this list is absent then all event types are included. A '*' can be used as a wildcard to match any sequence of characters.",
      "items": {
        "type": "string"
      }
    },
    "not_types": {
      "type": "array",
      "description":
        "A list of event types to exclude. If this list is absent then no event types are excluded. A matching type will be excluded even if it is listed in the 'types' filter. A '*' can be used as a wildcard to match any sequence of characters.",
      "items": {
        "type": "string"
      }
    },
    "senders": {
      "type": "array",
      "description":
        "A list of senders IDs to include. If this list is absent then all senders are included. A '*' can be used as a wildcard to match any sequence of characters.",
      "items": {
        "type": "string"
      }
    },
    "not_senders": {
      "type": "array",
      "description":
        "A list of sender IDs to exclude. If this list is absent then no senders are excluded. A matching sender will be excluded even if it is listed in the 'senders' filter. A '*' can be used as a wildcard to match any sequence of characters.",
      "items": {
        "type": "string"
      }
    }
  }
}