Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base API, enabling automation workflows to manage collections, documents, users, groups, comments, attachments, and other resources within Outline. Specifically, the "Get Documents" operation under the "Collection" resource retrieves documents contained in a specified collection.

Use cases include:

  • Automatically fetching all documents from a particular collection for processing or reporting.
  • Integrating Outline content retrieval into broader workflows, such as syncing documents with other systems.
  • Filtering and paginating document lists programmatically.

Example: You have a collection of product manuals in Outline and want to retrieve all documents in that collection to generate an aggregated report or export.

Properties

Name Meaning
Collection ID The unique identifier of the collection from which to retrieve documents (required).
Additional Fields (optional) Various optional parameters to refine the document retrieval:
- Limit: Number of documents to return (1-100).
- Offset: Number of documents to skip.
- Sort: Field to sort by (Created At, Updated At, Title, Index).
- Direction: Sort order (Ascending, Descending).
- Date Filter: Filter documents by date range (Day, Week, Month, Year).
- Include Archived: Whether to include archived documents.
- Include Drafts: Whether to include draft documents.
- Status Filter: Filter by document status (Published, Draft, Archived).

Output

The output is a JSON array where each item represents a document retrieved from the specified collection. Each document object contains metadata and content fields as returned by the Outline API's /collections.documents endpoint.

The exact structure depends on the Outline API response but typically includes:

  • Document ID
  • Title
  • Content (markdown)
  • Status (published, draft, archived)
  • Creation and update timestamps
  • Other relevant metadata

No binary data is output by this operation.

Dependencies

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

Troubleshooting

  • Missing or invalid Collection ID: Ensure the Collection ID is correctly provided and exists in your Outline instance.
  • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Rate limits or network issues: The Outline API may throttle requests; handle retries or backoff accordingly.
  • Empty results: If no documents are returned, check filters like status, date range, or pagination parameters.
  • Unexpected API errors: Review error messages returned in the output JSON for details.

Links and References

Discussion