Outline Wiki icon

Outline Wiki

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

Document → Search

AI-generated

Summary

Search documents using a full-text query with optional filters to refine results by collection ID, document status, last update date, and limit on number of returned results.

Inputs

  • Query (required) — The search query string to find matching content within documents.
  • Filters — Optional filters to narrow search results, including Collection ID to limit search to a specific collection UUID, Status Filter to select published, draft, or archived documents, Date Filter to restrict documents updated within a certain period, and Limit to specify the maximum number of results returned.

Output shape

a list of document objects matching the search criteria

The operation returns JSON data containing a list of documents that satisfy the full-text search query and filter conditions. The result is paginated according to the specified limit; no offset parameter is available for pagination.

Examples

Example 1: Search for documents containing 'meeting notes' within a specific collection, only returning published documents updated in the past month, limiting results to 10.

Set 'Query' to 'meeting notes', set 'Filters.Collection ID' to the desired collection UUID, set 'Filters.Status Filter' to 'Published (default)', set 'Filters.Date Filter' to 'Past Month', and set 'Filters.Limit' to 10.

Links

Discussion