API Key Auth

Path parameters

Discord

GitHub

x-api-key

Plane

API Reference

Plane One

Sign in

Get label details

Plane is an extensible, open source project and product management tool. It allows users to start with a basic task tracking tool and gradually adopt various project management frameworks like Agile, Waterfall, and many more.

Home

Plane Documentation

This section helps you get comfortable with Plane and find your way around more effectively.

Quick start

Quick Start

Plane is still in its early days, not everything is perfect yet, and hiccups may happen. Please let us know of any suggestions, ideas, or bugs that you encounter on our [Discord](https://discord.com/invite/A92xrEGCge)

Overview

Self-Hosting Plane

Docker Compose

Kubernetes

Starting 0.14, we are introducing a new role for self-managed instances called `Instance admin`.

Instance admin and God Mode

Plane offers several methods you can choose from to let your users log in to your Plane instance. Configure these methods in `Authentication` on `/god-mode` of your instance.

Authentication

Either during your set-up or sometime later, you will want to set SMTP settings to let your users get emails to reset passwords, onboard themselves right, and get notifications for changes, and receive exports of your data.

Communication

Email communication

Host your Plane instance in your custom domain. Our steps differ slightly depending on whether you are hosting on a public IP or a private/internal IP. Follow the steps listed below.

Brand instance

Users can reset their password through the terminal of the Plane application. You need to login to backend docker container and run the below command for resetting a user's password.

Reset Password

Telemetry

Anonymous data collection

Workspaces in Plane are where you can access all of your projects which contain including issues, cycles, and modules. Everything is organized within a workspace. To help you understand, you can think of a workspace as similar to a server on Discord or an organization on Slack, where you can bring your entire team together to work.

Members can be your collaborators, employees, executives, managers or even clients. Each member in your workspace needs a role for them to start using Plane.

Members

Your account encompasses details of your profiles, workspaces, activities, and preferences. Within a workspace, your account information is utilized to customize the Home page and to display your notifications.

Your account settings offer the ability to adjust your profile details, password, theme preferences, and email notification settings. Additionally, you can access a comprehensive list of all activities across workspaces.

Settings

Projects let you manage teams and tasks within your Workspace. After creating your [**Workspace**](/core-concepts/workspaces/overview.mdx), you will need to create a new project.

Projects have states, labels, estimations along with integrations and automations which can be setup to run your project smoothly.

Running your project

In Plane, an issue serves as the fundamental unit of work, which can be assigned, managed, and completed. Issues represent the tasks you need to accomplish to make progress. They are analogous to tasks in the project management domain.

A breakdown of all the properties available in issues for members to update

Properties

Visualise and filter issues

Issue Types

Add, configure and control your issue types

A cycle is a method for timeboxing the issues you're working on within a project. This approach aids in delivering issues within a fixed timeframe, boosting your team's momentum. Cycles share similarities with sprints in the agile methodology.

Cycles

Modules are a flexible way to organise issues in your project. Modules can be goal based, where you track progress of a new feature you are building, they can be milestone based where you track the work for a new marketing campaign or they can be discrete pieces in your software architecture like a specific micro-service, which have a lead.

Modules

Views are collections of filters applied to issues, enabling you to investigate and analyze them collectively.

Views

Pages in Plane help you record and organise information which is useful for your project just like docs. They can be used to record meeting notes or explain the technical or product requirements. Rather than having to create docs in other tools, with pages you can collaborate quickly in the context of a project.

List of all the content blocks available in the page, description and comment editors.

Editor blocks

Intake

Triage issues before adding them to your project

Imagine transforming your entire Workspace data into a structured dataset that provides actionable insights, enhancing your understanding of your work. Plane Analytics does just that, acting as your personal analyst. It swiftly answers your queries, forecasts demand, and determines scope within moments. Dive into data with Plane Analytics and make smarter decisions.

Analytics

Plane Analytics

Publish

Plane Publish

Power K, formerly called the Command Menu or just CMD + K, is a list of shortcuts to actions you can take in Plane. It is your quick, keyboard-first, Plane navigator that offers several wishlist accessways to Plane’s destinations.

Power K

Github

Github Sync

Integrate Plane with Slack effortlessly to streamline your project management experience. Follow these simple steps to bring your workspace and communication channels together seamlessly.

Slack

Slack Sync

Github Importer

GitHub Importer

Integrate seamlessly with Jira using the Jira Importer feature in Plane, effortlessly importing your issues into your Plane projects. Follow these straightforward steps to import your Jira issues into Plane.

Jira Importer

The Plane API is organized around REST. Our API has predictable resource-oriented URLs, accepts application/json request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.

Introduction

Plane API Documentation

Projects let you manage teams and tasks within your Workspace.

Add project

List projects

Get project details

Update project details

Delete project

Add state

List states

Get state details

Update state details

Delete state

Add label

List labels

Update label details

Delete label

Links can be added to an issue to point to some external resources

Add link

List links

Get link details

Update link details

Delete link

Inside an issue, you can add as many details as you like to get your work done.

Add issue

List issues

Get issue details

Update issue details

Delete issue

Issue activities are the history of all the changes that happened to the issue like property changes etc.

List issue activity

Get issue activity details

Add issue comment

List issue comments

Gets the details of a comment of an issue

Get issue comment details

Update issue comment details

Delete issue comment

Modules are smaller, focused projects that help you group and organize issues within a specific time frame. They allow you to break down your work into manageable chunks and track progress towards specific goals or objectives.

Add module

List modules

Get module details

Update module details

Delete module

It contains all the list of issues which are inside a module.

Add module issue

List module issues

Delete module issue

Add cycle

List cycles

Get cycle details

Update cycle details

Delete cycle

Add cycle issue

List cycle issues

Delete cycle issue

Add inbox issue

List inbox issues

Get inbox issue detail

Update inbox issue detail

Delete inbox issue

A webhook triggers a HTTP POST request on the specified url, whenever there is a change in an event. Like a new project is created, updated or deleted then a webhook can be triggered to receive the required payload.

API Reference

​Path parameters

Path parameters