Plane icon

Plane

Consume Plane API

Overview

This node interacts with the "Issue State" resource of the Plane API, specifically supporting the Get operation. It retrieves detailed information about a specific issue state within a given project by its state ID.

Use cases include:

  • Fetching metadata or configuration details about an issue state to understand its properties.
  • Integrating issue state data into workflows for reporting, automation, or synchronization with other tools.
  • Validating or displaying the current states available in a project’s workflow.

For example, you might use this node to get the details of a particular issue state (like "In Progress" or "Done") to display its name, group, or other attributes in a dashboard or to make decisions in an automated process.

Properties

Name Meaning
Project ID The unique identifier of the project containing the issue state.
State ID The unique identifier of the specific issue state to retrieve within the project.

Output

The output is a JSON object representing the requested issue state. It typically includes fields such as:

  • id: The unique identifier of the issue state.
  • name: The name of the issue state.
  • group: The group classification of the state (e.g., backlog, todo, in_progress).
  • Other metadata fields related to the issue state as provided by the Plane API.

The node returns this data as a JSON array with one element per input item processed.

Dependencies

  • Requires an active Plane API credential configured in n8n to authenticate requests.
  • Depends on the Plane API service being accessible and the specified project and state IDs existing.
  • Uses internal helper functions to perform HTTP GET requests to endpoints like /projects/{projectId}/states/{stateId}.

Troubleshooting

  • Invalid Project ID or State ID: If either ID does not exist or is incorrect, the API will return an error. Verify that the IDs are correct and correspond to existing resources in your Plane workspace.
  • Authentication Errors: Ensure the Plane API credential is valid and has sufficient permissions to access the project and issue state.
  • Network Issues: Connectivity problems can cause request failures. Check network access and Plane API status.
  • Empty or Unexpected Response: If the response lacks expected fields, confirm the Plane API version compatibility and that the resource exists.

Common error messages may include:

  • "Resource not found" — check IDs.
  • "Unauthorized" — verify credentials.
  • "Request failed" — inspect network and API availability.

Links and References

Discussion