Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to create a link share for a specified project. A link share allows users to share access to a project with others via a generated link, optionally protected by a password and assigned specific access rights. This is useful in scenarios where you want to collaborate or share project data externally without adding users directly to the project.

Practical examples:

  • Sharing a project with external stakeholders who need read-only access.
  • Allowing team members to edit a project via a shared link with write permissions.
  • Creating an admin-level link share for trusted collaborators to manage the project.

Properties

Name Meaning
Project Title or ID The target project to create the link share for. Can be selected from a searchable list of projects or specified by its ID.
Right The permission level granted by the link share: Read Only, Read & Write, or Admin.
Additional Fields Optional settings for the link share:
- Name A custom name for the link share; actions performed via this link will be associated with this name.
- Password An optional password to protect the link share. It can only be set during creation and not retrieved later.
- Sharing Type Whether the link share requires a password ("With Password") or not ("Without Password").

Output

The node outputs JSON data representing the created link share object returned by the Vikunja API. This typically includes details such as the link share ID, URL, permissions, name, and other metadata. No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Vikunja API.
  • The base URL of the Vikunja instance must be configured in the node credentials.
  • The node uses HTTP requests to interact with the Vikunja REST API endpoints.

Troubleshooting

  • Common issues:
    • Invalid project ID or project not found: Ensure the project exists and the ID is correct.
    • Insufficient permissions: The API key used must have rights to create link shares on the project.
    • Password setting errors: Password can only be set at creation; attempts to retrieve or update it later will fail.
  • Error messages:
    • "Unauthorized" or "Authentication failed": Check API key validity and permissions.
    • "Project not found": Verify the project ID or selection.
    • "Invalid parameters": Confirm that required fields like project and shareRight are provided and valid.

Links and References

Discussion