Outline Wiki icon

Outline Wiki

Interact with the Outline Wiki API — documents, collections, comments, attachments, users, shares

Actions31

Document → List

AI-generated

Summary

List documents filtered by collection, parent document, status, limit, and offset to paginate results.

Inputs

  • Collection ID — UUID of the collection to filter documents by.
  • Filters — Optional filters including Parent Document ID (UUID), Status Filter (All, Draft, Published, Archived), Limit (maximum number of results), and Offset (pagination offset).

Output shape

a list of document objects matching the specified filters

Supports optional pagination via 'Limit' and 'Offset'. Filtering by collection ID or parent document is optional. Status filter defaults to all documents if not set.

Examples

Example 1: List first 25 documents in a specific collection that are published.

Set 'Collection ID' to the target collection UUID, set 'Filters' > 'Status Filter' to 'Published', and use default limit 25 and offset 0.

Links

Discussion