MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

action=notifications

(main | notifications)

Retrieve notifications for the current user.

Parameters:
do

The end point action to perform such as getNotificationsForUser.

This parameter is required.
page

The page number starting point of notifications to retrieve.

This parameter is required.
Type: integer
Default: 0
itemsPerPage

The number of notifications to return per page retrieved.

This parameter is required.
Type: integer
Default: 50
type

The type of notifications to return in the response. Accepts a comma delimited list of types.

read

Return only read notifications in the response.

Type: integer
unread

Return only unread notifications in the response.

Type: integer
notificationId

The notification ID passed to dismissNotification to be dismissed taken from the original response from getNotificationsForUser.

dismissedAt

The Unix Epoch formatted timestamp of when the notification was read. To mark a notification as unread set this to 0.

Type: integer
Examples:
Get all notifications for the logged in user limited by the current page number and number of items per page.
api.php?action=notifications&do=getNotificationsForUser&page=0&itemsPerPage=50 [open in sandbox]
Make a POST request with the notification ID and the Unix Epoch formatted timestamp of the dismissed time. Set dismissedAt to zero to mark a notification as unread. Logged in users can only dismiss their own notifications.
api.php?action=notifications&do=dismissNotification&notificationId=1&dismissedAt=1562006555 [open in sandbox]
Make a POST request to mark all notifications for the logged in user as read.
api.php?action=notifications&do=dismissAllNotifications [open in sandbox]