MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

submodule=view-topiclist (vtl)

(main | flow | view-topiclist)

View a list of topics.

Specific parameters:

Other general parameters are available.

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.; Type: integer or max; The value must be between 0 and 100.; 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: fixed-html, html, wikitext; Default: fixed-html

Example:

List topics on Talk:Sandbox: api.php?action=flow&submodule=view-topiclist&page=Talk:Sandbox [open in sandbox]