MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

submodule=view-topiclist (vtl)

(main | flow | view-topiclist)
  • This module requires read rights.
  • Source: Flow
  • License: GPL-2.0+

View a list of topics.

Parameters:
vtloffset-dir

Direction to order the topics.

One of the following values: fwd, rev
Default: fwd
vtlsortby

Sorting option of the topics, either updated (ordered by topic update time), or newest (ordered by topic creation time).

One of the following values: newest, updated, user
Default: user
vtlsavesortby

Save sortby option to user preferences, if set.

Type: boolean (details)
vtloffset-id

Offset value (in UUID format) to start fetching topics at; used only with newest ordering

vtloffset

Offset value (as a topic update timestamp, in TS_MW format (YYYYMMDDHHMMSS)), to start fetching topics at; used only with updated ordering

vtlinclude-offset

Includes the offset item in the results as well.

Type: boolean (details)
vtllimit

Number of topics to fetch.

No more than 100 (100 for bots) allowed.
Type: integer or max
Default: 10
vtltoconly

Whether to respond with only the information required for the TOC.

Type: boolean (details)
vtlformat

Format to return the content in.

One of the following values: html, wikitext, fixed-html
Default: wikitext