API:Allusers

From MediaWiki.org
Jump to: navigation, search
Tools clipart.png This page is part of the MediaWiki API documentation.
MediaWiki API

Quick overview:

v · d · e
MediaWiki version: 1.11

Parameters[edit | edit source]

  • from : The user name to start enumerating from
  • to : The user name to stop enumerating at
  • prefix : Search for all users that begin with this value
  • dir : Direction to sort in. One value: ascending, descending. Default: ascending
  • group : 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.
  • excludegroup : Exclude users in given group name(s)
  • rights : Limit users to given right(s)
  • prop : 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)
  • limit : How many total user names to return. No more than 500 (5000 for bots) allowed. (Default: 10)
  • witheditsonly: Only list users who have made edits
  • activeusers : Only list users active in the last 30 days(s)

Example[edit | edit source]

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

Show a list of first 5 sysops

Error Codes[edit | edit source]

None