MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

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/Special:MyLanguage/Echo_(Notifications)/API

Specific parameters:

Other general parameters are available.

notwikis

List of wikis to fetch notifications from (defaults to only current wiki).

Values (separate with | or alternative): *, 2b2twiki, 25minresearchwiki, aditicawiki, adrenaliniwiki, aeronauticawiki, aetasantewiki, afterthewinterwiki, aion2wikiwiki, ajetwiki, algicosathlonwiki, allwikiwiki, ampgwiki, angiowadwiki, animefootballwiki, annexwiki, anothereidoswiki, antimonywiki, antlionguardwiki, arkivetwiki, artwiki, asttefwiki, autismwiki, backroomswiki, backroomwiki, ballcommunitywiki, barneybunchwiki, battlefordandysworldwiki, beastchildscartelwiki, bfdiwiki, bibliatecawiki, biketrooperswiki, birdwiki, biteismewiki, bitrealmwiki, blockstrikewiki, bloxrpwiki, bobthebozowiki, brainwiki, brawlboardwiki, btwikiwiki, bubtoradndwiki, caesiawiki, calvoesferawiki, carnelianwiki, cecawiki, cheddapediawiki, chesapeakestudioswiki, chidurianwikiwiki, christianfolklorewiki, cirruswiki, citynamereviewerswiki, clashpediawiki, cognwiki, countduckulawiki, countryhumanswiki, csmwwiki, ctwikiwiki, cyberwariwiki, cyyscwiki, daggerheartwiki, danceofdragonswiki, dandysworldwiki, darkbrosswiki, darudeman11wiki, deepdiversrblxwiki, dencroftystaffwiki, devoidofwisdomwiki, dexwikiwiki, dgfrancewiki, dhammawiki, dinopediawiki, dissociationwiki, dominationearthwiki, doomswiki, dovepediawiki, drakosmonswiki, drawingwiki, drcklinnwiki, dreamindigowiki, dubpanapanawiki, eberrondayswiki, eclipticawiki, encyclospaciawiki, enquickpediawiki, eslwiki, esufranchisewiki, evelysiawiki, exonimiawiki, farmoballswiki, fastfoodsimwiki, feudalworldwiki, founderswikiwiki, fourfatswiki, foxwiki, fpbcamidemarwiki, fracctalwiki, freiweltrpgwiki, freshwebsiteswiki, gamerzgamezwiki, garwikiwiki, germanologiewiki, globalrizewiki, globemcwiki, greenheraldwiki, grpxboxsafrwiki, heeheepediawiki, heritagehomewiki, hkfoodwiki, hourglassachiveswiki, howtoeswiki, howtowiki, humorpediawiki, hypixelwiki, iamspewiki, independenciawiki, inovatestwiki, instipediawiki, isocorewiki, iulianarianwiki, jacobwpwiki, janawiki, jezewikiwiki, jollymetrowiki, jsmpwiki, justanotherwikiwiki, kabachokwiki, kakuutetudouwikiwiki, karashiwikiwiki, kbwiki, keynotathlonwiki, khsbdbwiki, kingdomsmcwiki, kingilikesminecraftwiki, klwiki, krugstonwiki, lakessmilewiki, lambdawarswikiwiki, liberapediawiki, libertymyselfwiki, lifebrightlywiki, literarycartographywiki, loginwiki, lorelibrarywiki, lotwwiki, loveanddeepspacewiki, lsewiki, lucky11wiki, luluwiki, madnessdescentwiki, magicbuildingwiki, magicdudeswiki, manjuurancherwiki, marfilwiki, massshooterswiki, mdfanprojectswiki, medfordhistoricwiki, medipediawiki, metawiki, mgmuawiki, miassduchywiki, mikesbirthdaywiki, mimfwiki, mldofficialwikiwiki, moderntropeswiki, monaasliwiki, msh2025pbpwiki, myfrictionalwikiwiki, mygeekswiki, myinapediawiki, mythoswiki, namasteitalywiki, neoetruscanwiki, neowikiwiki, neurobanewiki, newpediawiki, newvaliswiki, nicopediawiki, niramwiki, nowherewiki, oaklandswikiwiki, objectshowwiki, officialurbanwiki, ofpwiki, okowiki, omegaversewiki, oocjzwiki, opinionistetwiki, ostarlandwiki, palonewikiwiki, panikclassicrobloxgamewiki, parlopediawiki, parulawiki, pdxrpbronzeandironwiki, pesosuwiki, peuthwiki, placeopediawiki, pmodelwiki, pocoyowiki, policialocaldeandaluciawiki, politicshubwiki, popmusicwiki, powyspediawiki, prideandfallwiki, primwikiwiki, progressivismwiki, progrostarwiki, projectherzlwiki, projectspapowiki, projectwikimiquelmusteraadricabrerawiki, psyctaleswiki, publicdomainlyricswiki, pyrrhiawiki, qasawiki, qytrinewiki, radicalcitywiki, randompediawiki, rapiddromedarieswiki, realitylostwiki, realmofthroneswiki, regretevatorwiki, remstiniawiki, researchifaesuwiki, robloxindiewikiswiki, robloxmysterykillerwiki, rogerrabbitwiki, rollspelsfansinwiki, romhavenwiki, ruswikiawiki, s4swiki, sandieshawwiki, sbrprobloxwiki, scienceolympiadwiki, shngameswiki, skyfrostwiki, slwiki, smowiki, solarawiki, solarpunkwiki, soldierwiki, songnguxyzwiki, soulboundsanctuarywiki, spacecomebywiki, spazioautisticowiki, spongebobwiki, ss14finalfontierwiki, sswiki, staffwiki, stratagptwiki, superkeynotewiki, supermariohunterwiki, supermariowiki, talesandtravelswiki, tecnicawiki, test2wiki, test3wiki, test5wiki, test6wiki, testabcwiki, testwiki, thaeciawiki, thebeatlesvideoprojectwiki, thefabsocietywiki, thekeywiki, thenexxxwiki, thestudioshowwiki, thetowerswiki, theworldofterakkwiki, timoeberronwiki, tinkypediafinkywiki, todwikiwiki, toscanainstradawiki, totoparodywiki, trainsandbuseswiki, trihhictionarywiki, tsdonwiki, tunapediawiki, turkiyewiki, tvburpwiki, twrwiki, uamusicwiki, ubercatoverdrivewiki, ucpacfoundationwiki, uerwiki, utgarchivewiki, uticwiki, valhirwiki, varnishwiki, victoriassecretwiki, waki285wiki, wangzijianwiki, warehousewarswiki, weenwiki, whiteywiki, wikathlonwiki, wikiaeveryonewiki, wikiballiawiki, wikicordwiki, wikifactwiki, wikigeniuswiki, wikipluswiki, wikiswikiswiki, wikizunawiki, wouwiki, wowcomicswiki, wutheringwaveswiki, wyndwiki, yudukiyukariwiki, zhbackroomswiki, zkestrelwiki

Maximum number of values is 50 (500 for clients that are allowed higher limits).

Default: biteismewiki

notfilter

Filter notifications returned.

Values (separate with | or alternative): !read, read

Default: read|!read

notprop

Details to request.

Values (separate with | or alternative): count, list, seenTime

Default: list

notsections

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

Values (separate with | or alternative): 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.

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: flyout, html, model, special

notlimit

The maximum number of notifications to return.

Type: integer or max

The value must be between 1 and 50.

Default: 20

notcontinue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

notunreadfirst

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

Type: boolean (details)

nottitles

Only return notifications for these pages. To get notifications not associated with any page, use [] as a title.

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

notbundle

Whether to show bundle compatible unread notifications according to notification types bundling rules.

Type: boolean (details)

notnotifiertypes

Notifier types for which to return notifications.

Values (separate with | or alternative): email, web

Default: web

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)

notcrosswikisummary

True to opt in to a summary notification of notifications on foreign wikis.

Type: boolean (details)

Examples:

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