MAmatrix
Push notifications

Gets a list of events that the user has been notified about

This API is used to paginate through the list of events that the user has been, or would have been notified about.

get/_matrix/client/v3/notifications

Request

Query parameters

fromstring

Pagination token to continue from. This should be the next_token returned from an earlier call to this endpoint.

limitinteger

Limit on the number of events to return in this request.

onlystring

Allows basic filtering of events returned. Supply highlight to return only events where the notification had the highlight tweak set.

Response

A batch of events is being returned

next_tokenstring

The token to supply in the from param of the next /notifications request in order to request more events. If this is absent, there are no more results.

Example response

{
  "notifications": [
    {
      "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",
            "sender": "@moderator:example.org",
            "type": "m.room.redaction",
            "unsigned": {
              "age": 1257,
              "membership": "leave"
            }
          }
        }
      }
    }
  ]
}

Changes

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