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
list=users (us)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0-or-later
Get information about a list of users.
Specific parameters:
Other general parameters are available.
- usprop
Which pieces of information to include:
- blockinfo
- Tags if the user is blocked, by whom, and for what reason.
- groups
- Lists all the groups each user belongs to.
- groupmemberships
- Lists groups that each user has been explicitly assigned to, including the expiry date of each group membership.
- implicitgroups
- Lists all the groups a user is automatically a member of.
- rights
- Lists all the rights each user has.
- editcount
- Adds the user's edit count.
- registration
- Adds the user's registration timestamp.
- emailable
- Tags if the user can and wants to receive email through Special:Emailuser.
- gender
- Tags the gender of the user. Returns "male", "female", or "unknown".
- centralids
- Adds the central IDs and attachment status for the user.
- cancreate
- Indicates whether an account for valid but unregistered usernames can be created. To check whether the current user can perform the account creation, use action=query&meta=userinfo&uiprop=cancreateaccount.
- Values (separate with | or alternative): blockinfo、cancreate、centralids、editcount、emailable、gender、groupmemberships、groups、implicitgroups、registration、rights
- usattachedwiki
With usprop=centralids, indicate whether the user is attached with the wiki identified by this ID.
- ususers
A list of users to obtain information for.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- ususerids
A list of user IDs to obtain information for.
- Type: list of integers
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
Example:
- Return information for user Example.
- api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender [open in sandbox]