Plane icon

Plane

Consume Plane API

Overview

This node interacts with the Plane API to manage issue properties within a project management context. Specifically, for the Issue Property resource and the Get Many operation, it retrieves all issue properties associated with a given project and issue type.

This is useful when you want to dynamically fetch metadata or custom fields (properties) defined for issues of a specific type in a project. For example, if your project tracks software bugs and feature requests as different issue types, each might have distinct properties like severity, environment, or estimated effort. This node operation allows you to list all such properties for further processing or display.

Practical scenarios include:

  • Automating workflows that adapt based on available issue properties.
  • Synchronizing issue property definitions between Plane and other tools.
  • Building dynamic forms or reports that reflect current issue property configurations.

Properties

Name Meaning
Project ID The unique identifier of the project from which to retrieve issue properties.
Issue Type ID The unique identifier of the issue type whose properties you want to list.

Output

The output is a JSON array where each element represents an issue property object associated with the specified project and issue type. Each property object typically includes details such as its ID, display name, type, and other metadata describing the property.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Plane API via an authenticated API key credential configured in n8n.
  • The node uses internal helper functions to make HTTP GET requests to endpoints like /projects/{projectId}/issue-types/{typeId}/issue-properties.
  • No additional external services are required beyond the Plane API.

Troubleshooting

  • Common Issues:

    • Invalid or missing Project ID or Issue Type ID parameters will cause the API request to fail.
    • Network connectivity problems or incorrect API credentials can result in authentication errors.
    • If the specified project or issue type does not exist, the API may return a 404 error.
  • Error Messages:

    • Errors from the Plane API are propagated; typical messages include "Not Found" for invalid IDs or "Unauthorized" for credential issues.
    • If no issue properties are found, the output will be an empty array rather than an error.
  • Resolution Tips:

    • Verify that the Project ID and Issue Type ID are correct and correspond to existing entities in Plane.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Check network connectivity and Plane API status.

Links and References

Discussion