API:Users

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
  • 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
• 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

Users
This module cannot be used as a GeneratorAPI: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 ApiQueryUsers.php.

Parameters

• ususers: A list of user names to get information for
• 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