Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base service, specifically focusing on managing documents within collections. The "Document: List" operation retrieves a list of documents, optionally filtered and sorted by various criteria such as collection ID, date range, status, and pagination parameters. This is useful for scenarios where you want to fetch multiple documents from a specific collection or across collections, for example, to display recent documents, generate reports, or synchronize document data with other systems.

Practical examples:

  • Fetching all published documents in a particular collection to display on a website.
  • Retrieving draft documents for review before publishing.
  • Listing archived documents for audit or archival purposes.
  • Paginating through documents when building an admin interface.

Properties

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

Output

The output is a JSON array where each item represents a document object returned by the Outline API's /documents.list endpoint. Each document object typically includes metadata such as document ID, title, content snippet, status, creation and update timestamps, and collection association.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Outline knowledge base API.
  • The node uses the Outline API endpoints via HTTP POST requests.
  • No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Providing an incorrect or non-existent Collection ID may result in empty results or errors.
    • Exceeding the limit parameter beyond allowed bounds (1-100) will likely cause validation errors.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • Authentication failures: Check that the API key credential is correctly configured and valid.
    • Validation errors: Ensure input parameters like limit, offset, and filters conform to expected types and ranges.
    • Not found errors: Verify that the specified Collection ID exists and is accessible by the authenticated user.

Links and References

Discussion