Outline Wiki icon

Outline Wiki

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

Actions31

Comment → List

AI-generated

Summary

List comments filtered by document or collection with pagination support.

Inputs

  • Filters — Optional filters to narrow the comments list including Document ID (UUID of the document to list comments for), Collection ID (UUID of the collection to list all comments within), Limit (maximum number of results to return), and Offset (offset for pagination).

Output shape

a list of comment objects

The operation returns a JSON object containing the list of comments that match the given filters, with pagination controlled by limit and offset parameters. If no filters are provided, comments are returned unfiltered.

Examples

Example 1: List comments for a specific document with up to 10 results, skipping the first 5.

Set Filters.Document ID to the document UUID, Limit to 10, and Offset to 5.

Links

Discussion