Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base platform, specifically managing users when the Resource is set to "User" and the Operation is "List". It retrieves a list of users from the Outline system, optionally filtered and paginated according to user-specified parameters.

Common scenarios for this node include:

  • Synchronizing or auditing users in an Outline workspace.
  • Displaying or processing user lists for administrative or reporting purposes.
  • Integrating user data from Outline into other workflows or systems.

For example, you might use this node to fetch all users currently registered in your Outline knowledge base, then filter or process them downstream in your automation workflow.

Properties

Name Meaning
Additional Fields A collection of optional filters and pagination controls:
- Date Filter Filter users by date range: Day, Week, Month, Year (if applicable)
- Include Archived Whether to include archived users/documents in results (boolean)
- Include Drafts Whether to include draft users/documents in results (boolean)
- Limit Number of results to return (1 to 100, default 25)
- Offset Number of results to skip before starting to collect results (default 0)
- 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 (multi-select, default: Published)

Note: Although some options mention documents, these fields are reused across multiple resources including users. For the User List operation, mainly pagination and sorting options apply.

Output

The node outputs JSON data representing the list of users retrieved from the Outline API. The structure corresponds directly to the API response for the /users.list endpoint, typically an array of user objects containing details such as user ID, name, email, roles, and status.

If multiple input items are processed, the output will be an array of such user lists corresponding to each input item.

No binary data output is produced 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 POST requests to retrieve user information.
  • No additional external dependencies beyond the Outline API and proper credential configuration in n8n.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Exceeding rate limits imposed by the Outline API may result in request failures.
    • Providing invalid parameter values (e.g., negative limit or offset) may cause API errors.

  • Error messages:

    • Authentication errors usually indicate incorrect or expired API keys; verify and update credentials.
    • Validation errors from the API often specify which parameter is invalid; adjust inputs accordingly.
    • Network or timeout errors suggest connectivity issues; retry or check network settings.

  • To handle errors gracefully, enable the "Continue On Fail" option in the node to capture error messages in the output instead of stopping execution.

Links and References

Discussion