Gets a list of events that the user has been notified about
GET {{baseUrl}}/notifications?from=xxxxx&limit=20&only=highlight
This API is used to paginate through the list of events that the user has been, or would have been notified about.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
from | string | Pagination token to continue from. This should be the next_token | |
| returned from an earlier call to this endpoint. | |||
limit | number | Limit on the number of events to return in this request. | |
only | string | Allows basic filtering of events returned. Supply highlight | |
| to return only events where the notification had the highlight | |||
| tweak set. |
RESPONSES
status: OK
{"next_token":"abcdef","notifications":[{"actions":["notify"],"profile_tag":"hcbvkzxhcvb","read":true,"room_id":"!abcdefg:example.com","ts":1475508881945,"event":{"$ref":"../../event-schemas/examples/m.room.message$m.text.yaml"}}]}