Planka icon

Planka

Interact with Planka API

Overview

The Planka n8n node allows you to interact with the Planka API, specifically for project management tasks. For the resource 🏢 PROJECT and operation 🔍 Get Project, this node retrieves detailed information about a specific project in your Planka instance using its unique Project ID.

Common scenarios:

  • Automating reporting or dashboard updates by fetching project details.
  • Integrating Planka project data into other systems (e.g., syncing with CRMs, documentation tools).
  • Triggering workflows based on project status or metadata.

Practical example:
You could use this node in an n8n workflow to fetch project details when a new project is created, then send those details via email or update another system.


Properties

Name Type Meaning
Project ID String The unique identifier of the project to retrieve. This is required to specify which project's details should be fetched from Planka.

Output

The output will be a single item (or one per input item) with a json field containing the project details as returned by the Planka API. The structure of this object depends on the Planka API but typically includes fields such as:

{
  "id": "string",
  "name": "string",
  "background": "string",
  "backgroundType": "string",
  "backgroundImage": "string",
  // ...other project-specific fields
}
  • All properties present in the Planka project object will be included.
  • No binary data is returned for this operation.

Dependencies

  • External Service: Requires access to a running Planka instance with API enabled.
  • Authentication: You must configure n8n credentials for plankaApi (API key or token as required by your Planka setup).

Troubleshooting

Common issues:

  • Invalid Project ID: If the provided Project ID does not exist, the node will throw an error indicating that the project was not found.
  • Authentication errors: If the API credentials are missing or incorrect, you may receive authentication/authorization errors.
  • Network issues: If n8n cannot reach your Planka instance (wrong URL, server down), requests will fail.

Error handling:

  • If "Continue On Fail" is enabled, errors will be output as { "error": "<error message>" } in the json field.
  • Otherwise, the workflow will stop on error.

Links and References


Discussion