MAmatrix
Room participation

Get events and state around the specified event.

This API returns a number of events that happened just before and after the specified event. This allows clients to get the context surrounding an event.

Note: This endpoint supports lazy-loading of room member events. See Lazy-loading room members for more information.

get/_matrix/client/v3/rooms/{roomId}/context/{eventId}

Request

Path parameters

roomIdstring required

The room to get events from.

eventIdstring required

The event to get context around.

Query parameters

limitinteger

The maximum number of context events to return. The limit applies to the sum of the events_before and events_after arrays. The requested event ID is always returned in event even if limit is 0. Defaults to 10.

filterstring

A JSON RoomEventFilter to filter the returned events with. The filter is only applied to events_before, events_after, and state. It is not applied to the event itself. The filter may be applied before or/and after the limit parameter - whichever the homeserver prefers.

See Filtering for more information.

Response

The events and state surrounding the requested event.

endstring

A token that can be used to paginate forwards with using GET /messages.

startstring

A token that can be used to paginate backwards with using GET /messages.

Example response

{
  "event": {
    "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_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"
    }
  ],
  "state": [
    {
      "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.