Outline

Interact with Outline knowledge base

Actions53

Overview

This node interacts with the Outline knowledge base API, allowing users to perform various operations on different resources such as collections, documents, users, groups, comments, and more. Specifically, for the Collection - Get operation, it retrieves detailed information about a specific collection by its ID.

Common scenarios where this node is beneficial include:

Fetching metadata or details of a particular collection in Outline.
Integrating Outline collections into automated workflows for documentation management.
Using collection data to trigger further actions or analyses in n8n workflows.

Practical example:

You want to retrieve the details of a collection to display or process its metadata in your workflow. By providing the collection's ID, you can get its name, description, and other relevant information.

Properties

Name	Meaning
Collection ID	The unique identifier of the collection to retrieve. This is required to specify which collection's details to fetch.

Output

The output JSON contains the response from the Outline API for the collection info request. It typically includes fields such as the collection's ID, name, description, creation date, update date, and possibly other metadata related to the collection.

Example structure (simplified):

{
  "id": "string",
  "name": "string",
  "description": "string",
  "createdAt": "string",
  "updatedAt": "string",
  // ... other collection metadata
}

No binary data output is involved in 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

Invalid Collection ID: If the provided collection ID does not exist or is incorrect, the API will return an error. Verify the collection ID is correct.
Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions to access collection data.
Network Issues: Connectivity problems may cause request failures; check network settings and API availability.
API Rate Limits: Excessive requests might be throttled by the Outline API; consider adding delays or handling rate limit errors gracefully.

Links and References

Outline API Documentation (general reference for available endpoints)
Outline Knowledge Base

OutlineInstall