Plane icon

Plane

Consume Plane API

Overview

This node interacts with the Plane API to manage various project-related resources, including issue property options. Specifically, for the Issue Property Option resource with the Get Many operation, it retrieves all available options for a given issue property within a specified project.

This is useful when you want to list or process all possible selectable options configured for an issue property in a project management context. For example, if an issue property represents a dropdown field like "Priority" or "Status," this operation fetches all the defined choices (options) for that property.

Practical scenarios include:

  • Displaying all options of a custom issue property to users.
  • Automating workflows based on specific property options.
  • Synchronizing issue property options with other systems.

Properties

Name Meaning
Project ID The unique identifier of the project where the issue property exists. This is required to scope the request to the correct project.
Property ID The unique identifier of the issue property whose options you want to retrieve. This specifies which property's options are fetched.

Output

The output is a JSON array containing the list of issue property options for the specified property. Each option object typically includes details such as:

  • id: The unique identifier of the option.
  • name: The display name of the option.
  • Other metadata related to the option as provided by the Plane API.

This allows downstream nodes or processes to access and utilize the full set of options for the issue property.

The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to the Plane API via an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to Plane's REST endpoints.
  • The user must provide valid Project ID and Property ID parameters to successfully retrieve options.

Troubleshooting

  • Missing or invalid Project ID / Property ID: Ensure that both IDs are correctly provided and correspond to existing entities in Plane. Invalid IDs will cause API errors.
  • API authentication errors: Verify that the Plane API credentials are correctly set up in n8n and have sufficient permissions.
  • Empty results: If no options are returned, confirm that the issue property actually has options defined in the Plane project.
  • Network or API downtime: Temporary connectivity issues can cause failures; retry after some time or check Plane's service status.

Common error messages may include:

  • Unauthorized or forbidden errors due to invalid API keys.
  • Not found errors if the project or property IDs do not exist.
  • Validation errors if parameters are missing.

Resolving these usually involves checking input parameters and API credentials.

Links and References

Discussion