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=readinglistentries (rle)

(main | query | readinglistentries)

This module is internal or unstable. Its operation may change without notice.
This module requires read rights.
This module can be used as a generator.
Source: ReadingLists
License: GPL-2.0-or-later

List the pages of a certain list.

This module has two modes of operation. With the rlelists parameter, it returns the pages in the given list(s). With the rlechangedsince parameter, it returns all list entries from any list 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 entries, although not entries of deleted lists.)

https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:ReadingLists#API

Specific parameters:

Other general parameters are available.

rlelists

The list IDs for which to return pages.

Type: list of integers

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

rlechangedsince

Show list entries that have been changed since this timestamp. Must be after 2024-03-29T16:30:59Z.

Type: timestamp (allowed formats)

rlesort

Property to sort by. name cannot be used together with rlechangedsince. Defaults to updated when rlechangedsince is set, and to name otherwise.

name: Article title. (Project name is ignored. Sorting is by binary value; e.g. any uppercase ASCII character will sort before any lowercase one.)
updated: Last update timestamp.

One of the following values: name, updated

rledir

Sort direction: ascending (A to Z, oldest to newest) or descending.

One of the following values: ascending, descending

Default: ascending

rlelimit

Number of result items to return.

Type: integer or max

The value must be between 1 and 100.

Default: 10

rlecontinue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

Examples:

Get the pages from the reading lists with ID 10, 11 and 12.: api.php?action=query&list=readinglistentries&rlelists=10|11|12 [open in sandbox]
Get the list entries of the current user which have changed since 2013-01-01T00:00:00Z.: api.php?action=query&list=readinglistentries&rlechangedsince=2013-01-01T00:00:00Z [open in sandbox]