Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base service, specifically managing comments in this context. The "Comment: List" operation retrieves a list of comments associated with a document. It supports filtering and pagination options to control which comments are returned and how many.

Typical use cases include:

  • Fetching all comments for a specific document to display or process them.
  • Retrieving a subset of comments with pagination for large documents.
  • Filtering comments by status or date range to analyze recent activity or archived discussions.

For example, you might use this node to gather all published comments on a document to show user feedback or discussion threads in an application.

Properties

Name Meaning
Document ID (Optional) The ID of the document to filter comments by. If omitted, comments from all documents may be listed.
Additional Fields A collection of optional filters and controls:
- Date Filter Filter comments by date range: Day, Week, Month, or Year.
- Include Archived Whether to include archived comments in the results (boolean).
- Include Drafts Whether to include draft comments in the results (boolean).
- Limit Number of comments to return (1 to 100).
- Offset Number of comments to skip (for pagination).
- Sort Field to sort by: Created At, Updated At, Title, or Index.
- Direction Sort direction: Ascending or Descending.
- Status Filter Filter by comment status: Published, Draft, Archived (multi-select).

Output

The output is a JSON array where each item represents a comment object as returned by the Outline API. Each comment includes details such as its content, associated document ID, status, creation and update timestamps, and other metadata.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Outline knowledge base API.
  • The node makes HTTP POST requests to Outline's endpoints to perform operations.
  • No additional environment variables are required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Providing an invalid document ID may result in empty results or errors.
    • Exceeding the limit or offset bounds could lead to unexpected pagination behavior.

  • Error messages:

    • Authentication failures typically indicate incorrect or expired API keys; verify and update credentials.
    • "Not found" errors suggest the specified document or comment does not exist; check IDs carefully.
    • Rate limiting errors may occur if too many requests are made in a short time; implement retries or backoff.

Links and References

Discussion