Perform a server-side search.

Performs a full text search across different categories.

post/_matrix/client/v3/search

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/search/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

next_batchstring

The point to return events from. If given, this should be a next_batch result from a previous call to this endpoint.

Request body

Example request

{
  "search_categories": {
    "room_events": {
      "groupings": {
        "group_by": [
          {
            "key": "room_id"
          }
        ]
      },
      "keys": [
        "content.body"
      ],
      "order_by": "recent",
      "search_term": "martians and men"
    }
  }
}

Response

Results of the search.

Example response

{
  "search_categories": {
    "room_events": {
      "results": [
        {
          "context": {
            "events_after": [
              {
                "content": {
                  "membership": "join"
                },
                "event_id": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
                "origin_server_ts": 1632489532305,
                "sender": "@example:example.org",
                "state_key": "@user:example.org",
                "type": "m.room.member",
                "unsigned": {
                  "age": 1567437,
                  "membership": "join",
                  "redacted_because": {
                    "content": {
                      "reason": "spam"
                    },
                    "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
                    "origin_server_ts": 1632491098485,
                    "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
                    "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
                    "sender": "@moderator:example.org",
                    "type": "m.room.redaction",
                    "unsigned": {
                      "age": 1257
                    }
                  }
                },
                "room_id": "!jEsUZKDJdhlrceRyVU:example.org"
              }
            ],
            "events_before": [
              {
                "content": {
                  "membership": "join"
                },
                "event_id": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
                "origin_server_ts": 1632489532305,
                "sender": "@example:example.org",
                "state_key": "@user:example.org",
                "type": "m.room.member",
                "unsigned": {
                  "age": 1567437,
                  "membership": "join",
                  "redacted_because": {
                    "content": {
                      "reason": "spam"
                    },
                    "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
                    "origin_server_ts": 1632491098485,
                    "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
                    "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
                    "sender": "@moderator:example.org",
                    "type": "m.room.redaction",
                    "unsigned": {
                      "age": 1257
                    }
                  }
                },
                "room_id": "!jEsUZKDJdhlrceRyVU:example.org"
              }
            ]
          },
          "result": {
            "content": {
              "membership": "join"
            },
            "event_id": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
            "origin_server_ts": 1632489532305,
            "sender": "@example:example.org",
            "state_key": "@user:example.org",
            "type": "m.room.member",
            "unsigned": {
              "age": 1567437,
              "membership": "join",
              "redacted_because": {
                "content": {
                  "reason": "spam"
                },
                "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
                "origin_server_ts": 1632491098485,
                "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
                "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
                "sender": "@moderator:example.org",
                "type": "m.room.redaction",
                "unsigned": {
                  "age": 1257
                }
              }
            },
            "room_id": "!jEsUZKDJdhlrceRyVU:example.org"
          }
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.