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
meta=readinglists (rl)
- This module is internal or unstable. Its operation may change without notice.
- This module requires read rights.
- Source: ReadingLists
- License: GPL-2.0-or-later
List or filter the user's reading lists and show metadata about them.
This module has four modes of operation. With the rllist parameter, it returns information about the specified list. With the rlchangedsince parameter, it returns all lists of the current user which have been changed since the given date. (This is meant for device sync and, unlike the other modes, includes deleted lists. Only changes to list metadata are considered, not changes to list items.) With the rlproject and rltitle parameters, it returns all lists that include that page. Without any of those parameters, it returns all lists.
- rllist
List ID.
- Type: integer
- The value must be no less than 1.
- rlproject
Project of the page to filter on. Must be used together with rltitle. Will only return lists which include this project and title.
- rltitle
Title of the page to filter on. Must be used together with rlproject. Will only return lists which include this project and title.
- rlchangedsince
Show lists that have been changed since this timestamp. Must be after 2024-11-24T14:47:11Z. Clients should use the timestamp returned in the readinglists-synctimestamp field from an earlier call if they want to ensure that no changes are missed, and should be prepared to receive changes that have already been returned in an earlier response, and handle them in an idempotent way.
- Type: timestamp (allowed formats)
- rlsort
Property to sort by. Ignored when rlproject and rltitle is set (results are returned in DB order). Defaults to updated when rlchangedsince is set, and to name otherwise.
- name
- List name. (Sorting is by binary value; e.g. any uppercase ASCII character will sort before any lowercase one.)
- updated
- Last update timestamp. (Updates include list metadata changes but not changes to list items.)
- One of the following values: name, updated
- rldir
Sort direction: ascending (A to Z, oldest to newest) or descending. Ignored when rlproject and rltitle is set.
- One of the following values: ascending, descending
- Default: ascending
- rllimit
Number of result items to return.
- Type: integer or max
- The value must be between 1 and 10.
- Default: 10
- rlcontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- Get the reading lists of the current user.
- api.php?action=query&meta=readinglists [open in sandbox]
- Get the reading lists of the current user which have changed since 2013-01-01T00:00:00Z.
- api.php?action=query&meta=readinglists&rlchangedsince=2013-01-01T00:00:00Z [open in sandbox]
- Get the reading lists of the current user which contain the page Dog from project en.wikipedia.org
- api.php?action=query&meta=readinglists&rlproject=https%3A%2F%2Fen.wikipedia.org&rltitle=Dog [open in sandbox]