Vikunja icon

Vikunja

Get data from Vikunja's API

Overview

This node integrates with the Vikunja API to manage teams within the system. Specifically, the "Update" operation for the "Team" resource allows users to modify existing team details such as the team's name and description. This is useful in scenarios where team information needs to be kept current, for example, when a team's purpose changes or additional context needs to be added.

Practical examples include:

  • Renaming a team to reflect a new project focus.
  • Adding or updating a description to clarify the team's role or membership criteria.

Properties

Name Meaning
Team Name or ID Select the team to update either by choosing from a searchable list of existing teams or by specifying the team's unique ID directly.
Team Name The new name to assign to the team. This is a required field when updating a team.
Description A textual description providing more details about the team. Optional but recommended for clarity.

Output

The node outputs JSON data representing the updated team object as returned by the Vikunja API. This typically includes fields such as the team's ID, updated name, description, and possibly other metadata related to the team.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Vikunja API.
  • The base URL for the Vikunja API must be configured in the node credentials.
  • Network access to the Vikunja server hosting the API.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent team ID will result in errors indicating the team could not be found.
    • Missing required fields like the new team name will cause validation errors.
    • Incorrect API URL or network issues can lead to connection failures.
  • Error messages and resolutions:

    • "Team not found": Verify that the team ID or selected team from the list exists.
    • "Missing required parameter 'name'": Ensure the "Team Name" property is filled.
    • Authentication errors: Check that the API key credential is correctly set and has sufficient permissions.
    • Network errors: Confirm the API URL is correct and accessible from the n8n environment.

Links and References

Discussion