Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to create new projects within a user's task management environment. It allows users to specify details such as the project title, parent project, description, color, and other metadata. This is useful for automating project creation workflows, organizing tasks hierarchically, or setting up new projects programmatically based on external triggers or data.

Practical examples include:

  • Automatically creating a new project when a new client is onboarded.
  • Duplicating existing projects with modifications.
  • Setting up project templates with predefined colors and descriptions.

Properties

Name Meaning
Parent Project Title or ID The parent project under which this new project will be created. Can be selected from a list or specified by ID.
Project Title The name/title of the new project. This is a required field.
Additional Fields Optional extra settings for the project:
- Description A textual description of the project.
- Project Color The color associated with the project, represented as a hex color code (e.g., #000000).
- Archived Boolean flag indicating if the project should be archived upon creation.
- Favorite Boolean flag indicating if the project should be marked as a favorite.
- Identifier A unique short identifier for the project, used for building task identifiers.

Output

The node outputs JSON data representing the newly created project as returned by the Vikunja API. This typically includes all project details such as its ID, title, description, color, archival status, favorite status, identifier, and any hierarchical relationships (like parent project ID).

If the node supports binary data output, it is not indicated in the provided source or properties, so the output is purely JSON-based.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API key and base URL are correctly set in the node credentials.
  • Invalid parent project ID: If specifying a parent project by ID, verify that the ID exists and is accessible by the authenticated user.
  • Missing required fields: The "Project Title" is mandatory; omitting it will cause the request to fail.
  • API connectivity issues: Check network access to the Vikunja server and confirm the API endpoint is reachable.
  • Permission errors: The API key must have sufficient permissions to create projects.

Links and References

Discussion