MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

meta=notifications (not)

(main | query | notifications)

This module requires read rights.
Source: Echo
License: MIT

Get notifications waiting for the current user.

https://www.mediawiki.org/wiki/Echo_(Notifications)/API

Parameters:

notfilter

Filter notifications returned.

Values (separate with |): read, !read

Default: read|!read

notprop

Details to request.

Values (separate with |): list, count

Default: list

notsections

The notification sections to query (i.e. some combination of 'alert' and 'message').

Values (separate with |): alert, message

Default: alert|message

notgroupbysection

Whether to group the result by section. Each section is fetched separately if set.

Type: boolean (details)

notformat

If specified, notifications will be returned formatted this way.

text: Plaintext format
model: Raw notification data
special: Formatted for Special:Notifications page (and only that!) Do not rely on the HTML as it may change at any given time.
flyout: Deprecated. Use notformat=model for raw data
html: Deprecated. Use notformat=model for raw data

One of the following values: text, model, special, flyout, html

notlimit

The maximum number of notifications to return.

No more than 50 (500 for bots) allowed.

Type: integer or max

Default: 20

notcontinue

When more results are available, use this to continue.

notunreadfirst

Whether to show unread notifications first (only used if groupbysection is not set).

Type: boolean (details)

notalertcontinue

When more alert results are available, use this to continue.

notalertunreadfirst

Whether to show unread message notifications first (only used if groupbysection is set).

Type: boolean (details)

notmessagecontinue

When more message results are available, use this to continue.

notmessageunreadfirst

Whether to show unread alert notifications first (only used if groupbysection is set).

Type: boolean (details)

Examples:

List notifications: api.php?action=query&meta=notifications [open in sandbox]
List notifications, grouped by section, with counts: api.php?action=query&meta=notifications&notprop=count&notsections=alert|message&notgroupbysection=1 [open in sandbox]