Plane icon

Plane

Consume Plane API

Overview

This node operation adds a new member to a specified project in the Plane API system. It is useful for managing project team members by inviting or assigning users via their email addresses, along with specifying their display names and roles within the project.

Common scenarios include:

  • Adding collaborators to a project to enable teamwork.
  • Assigning specific roles (Admin, Member, Guest, Viewer) to control access levels.
  • Managing user information such as first and last names for better identification.

Example use case:

  • Automatically add a new team member to a project when onboarding a new employee, specifying their email, display name, and role.

Properties

Name Meaning
Project Name or ID The identifier of the project to which the member will be added. Choose from a list or use an expression.
Email The email address of the user to add to the project.
Display Name The display name of the user being added.
Additional Fields Optional extra details about the user:
- First Name The user's first name.
- Last Name The user's last name.
- Role The role assigned to the user in the project. Options are: Admin, Member, Guest, Viewer.

Output

The output JSON contains the response from the Plane API after adding the member. This typically includes the newly created member's details such as their ID, email, display name, role, and any other metadata returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Plane API service.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The "Project Name or ID" property depends on loading available projects via the Plane API.

Troubleshooting

  • Missing or invalid project ID: Ensure the project ID is correct and accessible by the API key used.
  • Invalid email format: The email must be a valid email address; otherwise, the API may reject the request.
  • Insufficient permissions: The API key must have rights to add members to the specified project.
  • Role value errors: Use one of the predefined role options (Admin, Member, Guest, Viewer); invalid values may cause errors.
  • API request failures: Network issues or Plane API downtime can cause request failures; check connectivity and API status.

Common error messages:

  • "Unauthorized" or "Forbidden": Check API credentials and permissions.
  • "Project not found": Verify the project ID exists.
  • "Invalid input": Review all required fields and their formats.

Links and References

Discussion