API:Users

MediaWiki Action API
Basics All Query modules Get properties of pages List pages matching a criterion Get module parameters information Get meta information about the wiki and user Authentication Get tokens for data modifying operations Login Logout Assert user Accounts and Users Create an account Block or unblock a user Get the current user's watchlist as a feed Change user options Change user group membership Send an email Page Operations Parse content of a page Create and edit a page Upload a file Import a page Delete a page Watch or unwatch a page Purge cache for page(s) Rollback a page Move a page Patrol a page or revision Restore revisions of a deleted page Change a page's protection level Change a page's language More... Search Search for a title or text Fetch results in an OpenSearch format Search for wiki pages near a location Search for a language Perform a prefix search for page titles Developer Utilities Access libraries Cross-site requests Creating an API module in an extension Using the API in MediaWiki and extensions Restricting API usage Localisation Implementation strategy

Users
This module cannot be used as a Generator .
Prefix	us
Required rights	none
Post only?	No
Generated help	Current
Version added	≥ 1.12

Get information about a list of users. This module cannot be used as a generator. This module is implemented by ApiQueryUserInfo.php.

Parameters

• ususers: A list of user names to get information for
• ususerids: A list of user IDs to get information for 1.29+
• ustoken: Which tokens to get 1.16+ (deprecated in 1.24)
  • userrights: Token for changing a user's group membership
• usprop: Which properties to get (Default: none)
  • 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 1.18+
  • rights: All rights the user has 1.17+
  • editcount: The number of edits the user has made
  • registration: The time and date the user registered at 1.13+
  • emailable: Whether the user can and wants to receive e-mail through Special:Emailuser. "emailable" element: if it is missing - user cannot be emailed, if it is present and is an empty string: user can be emailed 1.14+
  • gender: Tags the gender of the user. Returns "male", "female", or "unknown" 1.16+

Example

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 [try in ApiSandbox]

Error Codes

None

---

list=users (us)

(main | query | users)

• This module requires read rights.
• Source: MediaWiki
• License: GPL-2.0-or-later

Get information about a list of users.

• https://www.mediawiki.org/wiki/Special:MyLanguage/API:Users

Parameters:

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.

Values (separate with | or alternative): blockinfo, groups, groupmemberships, implicitgroups, rights, editcount, registration, emailable, gender, centralids, cancreate

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 bots).

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 bots).

ustoken

Deprecated.

Use action=query&meta=tokens instead.

Values (separate with | or alternative): userrights

Example:

Return information for user Example.

api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender [open in sandbox]