API:Allusers

This page is part of the MediaWiki action API documentation.

MediaWiki APIsAPI:Main page

• Web APIs showcaseAPI:Web APIs hub
• REST content API

MediaWiki action API

• Introduction and quick startAPI:Main page
• FAQAPI:FAQ
  • Etiquette and usage limitsAPI:Etiquette
• TutorialAPI:Tutorial
• FormatsAPI:Data formats
• Error reportingAPI:Errors and warnings
• Restricting usageAPI:Restricting API usage
• Cross-site requestsAPI:Cross-site requests
• Authentication
  • LoginAPI:Login
  • LogoutAPI:Logout
  • Account creationAPI:Account creation
• QueriesAPI:Query
  • Meta informationAPI:Meta
  • PropertiesAPI:Properties
  • ListsAPI:Lists
• Searching (by title, content, coordinates...)API:Search and discovery
• Parsing wikitext and expanding templatesAPI:Parsing wikitext
• Purging pages' cachesAPI:Purge
• Parameter informationAPI:Parameter information
• Changing wiki contentAPI:Changing wiki content
  • Create and edit pagesAPI:Edit
  • Move pagesAPI:Move
  • Merge pagesAPI:Mergehistory
  • RollbackAPI:Rollback
  • Delete pagesAPI:Delete
  • Restore deleted revisionsAPI:Undelete
  • (Un)protect pagesAPI:Protect
  • (Un)block usersAPI:Block
  • (Un)watch pagesAPI:Watch
  • Mark revisions of watched pages as visitedAPI:SetNotificationTimestamp
  • Send emailAPI:Email
  • Patrol changesAPI:Patrol
  • Import pagesAPI:Import
  • Change user group membershipAPI:User group membership
  • Upload filesAPI:Upload
  • User optionsAPI:Options
  • TokensAPI:Tokens
  • Page languageAPI:PageLanguage
  • More...API:Changing wiki content
• Watchlist feedAPI:Watchlist feed
• WikidataWikibase/API
• ExtensionsAPI:Extensions
• Using the API in MediaWiki and extensionsAPI:Calling internally
• MiscellaneousAPI:Other services
• ImplementationAPI:Implementation Strategy
  • LocalisationAPI:Localisation
• Client codeAPI:Client code
• AssertingAPI:Assert

Allusers
Enumerate all registered users, ordered by username This module cannot be used as a GeneratorAPI:generator.
Prefix	au
Required rights	none
Post only?	No
Generated help	Current
Version added	≥ 1.11

Parameters

• aufrom: The user name to start enumerating from
• auto: The user name to stop enumerating at
• auprefix: Search for all users that begin with this value
• audir: Direction to sort in. One value: ascending, descending. Default: ascending
• augroup: Limit users to given group name(s). Possible values: bot, sysop, bureaucrat (+ any other group that is defined on the wiki). This is different for every wiki; see the API help or action=paraminfo for a list of possible values.
• auexcludegroup: Exclude users in given group name(s). Can not be used together with 'group'.
• aurights: Limit users to given right(s)
• auprop: What pieces of information to include.
  • blockinfo: Adds the information about a current block on the user
  • groups: Lists groups that the user is in. This uses more server resources and may return fewer results than the limit
  • implicitgroups: Lists all the groups the user is automatically in
  • rights: Lists rights that the user has
  • editcount: Adds the edit count of the user
  • registration: Adds the timestamp of when the user registered if available (may be blank) 1.12+
• aulimit: How many total user names to return. No more than 500 (5000 for bots) allowed. (Default: 10)
• auwitheditsonly: Only list users who have made edits
• auactiveusers: Only list users active in the last 30 days(s)

Example

Show a list of usernames starting with Y (or whichever sorts first after that)

api.php?action=query&list=allusers&aufrom=Y [try in ApiSandbox]

Show a list of first 5 sysops

api.php?action=query&list=allusers&augroup=sysop&aulimit=5 [try in ApiSandbox]

Error Codes

Code	Info
augroup-excludegroup	group and excludegroup cannot be used together

Note

This api call is case sensitive, so aufrom=YA doesn't have the same results as aufrom=Ya.