API:Users

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

Quick overview:

v · d · e


MediaWiki version: 1.12

Get information about a list of users. This module cannot be used as a generator.

Parameters [edit]

  • ususers: A list of user names to get information for
  • ustoken: Which tokens to get
  • usprop: Which properties to get
    • blockinfo: Whether the user is blocked, by whom and why
    • groups: All groups the user belongs to
    • implicitgroups: All groups a user is automatically a member of
    • rights: All rights the user has
    • editcount: The number of edits the user has made
    • registration: The time and date the user registered at
    • emailable: Whether the user can and wants to receive e-mail through Special:Emailuser
    • gender: Tags the gender of the user. Returns "male", "female", or "unknown"

Example [edit]

Getting information about a list of users

api.php?action=query&list=users&ususers=1.2.3.4|Catrope|Vandal01|Bob&usprop=blockinfo|groups|editcount|registration|emailable|gender
Result
The following content has been placed in a collapsed box for improved usability. 
<?xml version="1.0"?>
<api>
  <query>
    <users>
      <user name="1.2.3.4" invalid="" />
      <user name="Catrope" editcount="153" registration="2007-06-07T16:36:03Z" emailable="" gender="male" />
      <user name="Vandal01" missing="" />
      <user name="Bob" editcount="4517" registration="2006-11-18T21:55:03Z" emailable="" gender="male">
        <groups>
          <g>*</g>
          <g>user</g>
          <g>autoconfirmed</g>
          <g>reviewer</g>
        </groups>
      </user>
    </users>
  </query>
</api>
The above content has been placed in a collapsed box for improved usability.

Error Codes [edit]

None

Retrieved from "http://www.mediawiki.org/w/index.php?title=API:Users&oldid=614222"