Outline Wiki icon

Outline Wiki

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

Actions31

Document → Search

AI-generated

Summary

Perform a full-text search for documents within the Outline Wiki, optionally filtering by collection, document status, date range, and limiting the number of results.

Inputs

  • Query (required) — The search query string to find matching documents.
  • Filters — Optional parameters to refine the search results including:
  • - Collection ID — Filter results to a specific collection UUID.
  • - Status Filter — Filter by document status: Published (default), Draft, or Archived.
  • - Date Filter — Restrict results to documents updated within a certain period: All Time, Past Day, Week, Month, or Year.
  • - Limit — Maximum number of search results to return (default 25).

Output shape

a list of document objects matching the search criteria

Returned data contains JSON response from the /documents.search Outline API endpoint, including document details. Pagination beyond the set limit is not included in this operation.

Examples

Example 1: Search for published documents containing the phrase 'meeting notes' updated within the past month, limiting to 10 results.

Set Query to 'meeting notes', Filters with Status Filter as 'Published', Date Filter as 'Past Month', and Limit to 10.

Links

Discussion