# Plane Developer Documentation > Plane is open-source, modern project management software. These developer docs cover self-hosting, the REST API, and tools for building on Plane. This documentation covers self-hosting (Docker, Kubernetes, and more), the REST API reference for projects, work items, cycles, modules, states, pages, and more, plus developer tools including OAuth apps, webhooks, agents, and the MCP server. ## Table of Contents ### Developer documentation - [Deploy Plane on your infrastructure](https://developers.plane.so/self-hosting/overview.md): Deploy Plane on your own infrastructure with Docker, Kubernetes, or Podman. Complete self-hosting guides for open-source project management with full control and customization. - [Plane API Documentation](https://developers.plane.so/api-reference/introduction.md): Complete REST API reference for Plane. Learn authentication, HTTP methods, pagination, rate limiting, and how to integrate Plane with your applications programmatically. - [Build a Plane App](https://developers.plane.so/dev-tools/build-plane-app/overview.md): Build and integrate an app with Plane using OAuth 2.0 authentication. Covers bot tokens, user tokens, webhooks, and API access for custom integrations. ### Self-host Plane - [Deploy Plane on your infrastructure](https://developers.plane.so/self-hosting/overview.md): Deploy Plane on your own infrastructure with Docker, Kubernetes, or Podman. Complete self-hosting guides for open-source project management with full control and customization. - [Self-hosting 101](https://developers.plane.so/self-hosting/self-hosting-101.md): What self-hosting Plane involves, how it's licensed, what your team operates, and how to plan a deployment. - [Docker Compose](https://developers.plane.so/self-hosting/methods/docker-compose.md): Install Plane using Docker Compose. Step-by-step guide for deploying Plane with Docker on your server with all required services. - [Kubernetes](https://developers.plane.so/self-hosting/methods/kubernetes.md): Deploy Plane on Kubernetes using Helm charts. Complete guide for production-ready Kubernetes deployment with scaling and management. ### API Reference - [Plane API Documentation](https://developers.plane.so/api-reference/introduction.md): Complete REST API reference for Plane. Learn authentication, HTTP methods, pagination, rate limiting, and how to integrate Plane with your applications programmatically. - [Overview](https://developers.plane.so/api-reference/issue/overview.md): Plane Issue API overview. Learn about endpoints, request/response format, and how to work with issue via REST API. - [Overview](https://developers.plane.so/api-reference/project/overview.md): Plane Project API overview. Learn about endpoints, request/response format, and how to work with project via REST API. ### Build and extend - [Webhooks](https://developers.plane.so/dev-tools/intro-webhooks.md): Configure webhooks for Plane. Setup real-time event notifications and automate workflows with webhook integrations. - [Build a Plane App](https://developers.plane.so/dev-tools/build-plane-app/overview.md): Build and integrate an app with Plane using OAuth 2.0 authentication. Covers bot tokens, user tokens, webhooks, and API access for custom integrations. - [MCP server](https://developers.plane.so/dev-tools/mcp-server.md): Connect Cursor, VS Code, Claude, Windsurf, and Zed to your Plane workspace. Create work items, manage cycles, search across projects — all through natural language. - [Agents Overview](https://developers.plane.so/dev-tools/agents/overview.md): Learn how to build AI agents that integrate with Plane workspaces, enabling automated task handling, intelligent responses, and seamless collaboration. ### Self-host Plane - [Deploy Plane on your infrastructure](https://developers.plane.so/self-hosting/overview.md): Deploy Plane on your own infrastructure with Docker, Kubernetes, or Podman. Complete self-hosting guides for open-source project management with full control and customization. - [Self-hosting 101](https://developers.plane.so/self-hosting/self-hosting-101.md): What self-hosting Plane involves, how it's licensed, what your team operates, and how to plan a deployment. - [Understanding Plane's editions](https://developers.plane.so/self-hosting/editions-and-versions.md): Compare Plane Community, Pro, Business, and Enterprise editions. Understand features, pricing tiers, and version differences for self-hosted deployments. - [Plane self-hosted architecture](https://developers.plane.so/self-hosting/plane-architecture.md): Understand Plane self-hosted architecture including web server, API, workers, database, Redis, and storage components. System requirements and service topology. ### Install - [Deployment methods](https://developers.plane.so/self-hosting/methods/overview.md): Choose the best deployment method for your infrastructure. Deploy Plane with Docker, Kubernetes, Podman, or in airgapped environments. - [Kubernetes](https://developers.plane.so/self-hosting/methods/kubernetes.md): Deploy Plane on Kubernetes using Helm charts. Complete guide for production-ready Kubernetes deployment with scaling and management. - [Deploy Plane with Podman Quadlets](https://developers.plane.so/self-hosting/methods/podman-quadlets.md): Install Plane using Podman Quadlets. Guide for deploying Plane with Podman as a Docker alternative with systemd integration. #### Docker - [Docker Compose](https://developers.plane.so/self-hosting/methods/docker-compose.md): Install Plane using Docker Compose. Step-by-step guide for deploying Plane with Docker on your server with all required services. - [Docker AIO (All-in-One)](https://developers.plane.so/self-hosting/methods/docker-aio.md): Deploy Plane with Docker All-in-One (AIO) setup. Quick installation guide for running Plane in a single Docker container. - [Deploy Plane with Docker Swarm](https://developers.plane.so/self-hosting/methods/docker-swarm.md): Deploy Plane on Docker Swarm cluster. Guide for running Plane in a distributed Docker Swarm environment with high availability. - [Download Docker config files](https://developers.plane.so/self-hosting/methods/download-config.md): Download docker-compose.yml and variables.env files for a specific Plane release as a zip archive. #### Kubernetes - [High Availability Deployment](https://developers.plane.so/self-hosting/govern/high-availability.md): How to deploy Plane Commercial Edition on Kubernetes with high availability using the plane-enterprise Helm chart. #### Airgapped Edition - [Airgapped deployment architecture](https://developers.plane.so/self-hosting/methods/airgapped-requirements.md): System requirements and architecture overview for Plane airgapped deployments. Hardware specs, network topology, and prerequisites for offline installations. - [Deploy Plane with Airgapped Docker](https://developers.plane.so/self-hosting/methods/airgapped-edition.md): Deploy Plane in airgapped environment without internet access. Complete guide for offline Plane installation. - [Deploy Plane with airgapped Kubernetes](https://developers.plane.so/self-hosting/methods/airgapped-edition-kubernetes.md): Deploy Plane on Kubernetes using Helm charts. Complete guide for production-ready Kubernetes deployment with scaling and management. - [Clone Docker images to your private registry](https://developers.plane.so/self-hosting/methods/clone-docker-images.md): Mirror Plane Docker images to your private container registry. Pull, tag, and push images for airgapped or restricted network deployments. #### Managed Platforms - [Deploy Plane with Coolify](https://developers.plane.so/self-hosting/methods/coolify.md): Deploy Plane using Coolify, an open-source PaaS. One-click deployment with automatic SSL, domain configuration, and container management. - [Deploy Plane with Portainer](https://developers.plane.so/self-hosting/methods/portainer.md): Deploy and manage Plane using Portainer container management UI. Visual Docker management with stack deployment and monitoring. ### Configure - [Instance admin and God mode](https://developers.plane.so/self-hosting/govern/instance-admin.md): Configure Plane instance admin settings. Learn about God mode and administrative controls for self-hosted Plane. - [Configure SMTP for email notifications](https://developers.plane.so/self-hosting/govern/communication.md): Configure SMTP email settings for Plane. Setup email notifications and communication for your self-hosted instance. - [Configure external services](https://developers.plane.so/self-hosting/govern/database-and-storage.md): Configure external database and storage for Plane. Setup PostgreSQL, Redis, and S3-compatible storage services. - [Configure custom domain](https://developers.plane.so/self-hosting/govern/custom-domain.md): Configure custom domain for self-hosted Plane. Setup your own domain name for your Plane instance. - [Set up SSL](https://developers.plane.so/self-hosting/govern/configure-ssl.md): Configure SSL/TLS certificates for Plane. Setup HTTPS encryption for secure self-hosted Plane deployment. - [Configure DNS for Intake Email](https://developers.plane.so/self-hosting/govern/configure-dns-email-service.md): Configure DNS MX records for Plane intake email. Route incoming emails to create work items automatically in your self-hosted instance. - [Configure OpenSearch for advanced search](https://developers.plane.so/self-hosting/govern/advanced-search.md): Enable full-text search in Plane with OpenSearch. Configure advanced search indexing for work items, projects, and pages in your self-hosted instance. - [Configure Plane AI](https://developers.plane.so/self-hosting/govern/plane-ai/configure-plane-ai.md): Enable Plane AI on your self-hosted instance. Set up a dedicated database, configure OpenSearch, add an LLM API key, and connect PI to your Plane deployment. - [Configure session expiry](https://developers.plane.so/self-hosting/govern/god-mode/session-expiry.md): Set how long user and admin sessions stay active before requiring re-authentication on a self-hosted Plane instance. - [Configure external secrets for Kubernetes deployments](https://developers.plane.so/self-hosting/govern/external-secrets.md): Use external secrets operators with Plane on Kubernetes. Integrate AWS Secrets Manager, HashiCorp Vault, or Azure Key Vault for secure configuration. - [Configure external reverse proxy](https://developers.plane.so/self-hosting/govern/reverse-proxy.md): Configure Nginx, Caddy, or Traefik as a reverse proxy for self-hosted Plane. Setup upstream proxying, headers, and WebSocket support. - [Switch from public to private buckets • Commercial Edition](https://developers.plane.so/self-hosting/govern/private-bucket.md): Switch Plane storage from public to private S3 buckets. Secure file uploads with signed URLs and access control for commercial editions. - [Environment variables reference](https://developers.plane.so/self-hosting/govern/environment-variables.md): Configure environment variables for Plane. Complete reference of all configuration options and settings. - [Data collection and usage](https://developers.plane.so/self-hosting/telemetry.md): Understand what telemetry data Plane collects, how it is used, and how to opt out. Privacy-focused data collection for self-hosted instances. #### Authentication - [Overview](https://developers.plane.so/self-hosting/govern/authentication.md): Configure authentication methods for self-hosted Plane. Setup OAuth, SSO, SAML, OIDC, LDAP and other authentication providers. - [Google OAuth](https://developers.plane.so/self-hosting/govern/google-oauth.md): Setup Google OAuth authentication for Plane. Step-by-step guide to enable Google sign-in for your self-hosted instance. - [Github OAuth](https://developers.plane.so/self-hosting/govern/github-oauth.md): Configure GitHub OAuth authentication for Plane. Enable GitHub sign-in for your self-hosted Plane instance. - [OIDC SSO](https://developers.plane.so/self-hosting/govern/oidc-sso.md): Setup OIDC SSO authentication for Plane. Configure OpenID Connect single sign-on for enterprise authentication. - [SAML SSO](https://developers.plane.so/self-hosting/govern/saml-sso.md): Configure SAML SSO authentication for Plane. Setup Security Assertion Markup Language for enterprise SSO. - [LDAP authentication](https://developers.plane.so/self-hosting/govern/ldap.md): Setup LDAP authentication for Plane. Configure Lightweight Directory Access Protocol for directory-based authentication. - [Reset password](https://developers.plane.so/self-hosting/govern/reset-password.md): Reset user and admin passwords for self-hosted Plane. Recover access to your instance using CLI commands or database operations. #### Integrations - [Configure Bitbucket for Plane integration](https://developers.plane.so/self-hosting/govern/integrations/bitbucket.md): Connect Bitbucket to your self-hosted Plane instance. Sync pull requests and commits with Plane work items for development workflow tracking. - [Configure GitHub for Plane integration](https://developers.plane.so/self-hosting/govern/integrations/github.md): Connect GitHub to your self-hosted Plane instance. Sync pull requests, commits, and branches with Plane work items for seamless development tracking. - [Configure GitLab for Plane integration](https://developers.plane.so/self-hosting/govern/integrations/gitlab.md): Connect GitLab to your self-hosted Plane instance. Sync merge requests and commits with Plane work items for development workflow tracking. - [Configure Sentry for Plane integration](https://developers.plane.so/self-hosting/govern/integrations/sentry.md): Connect Sentry error monitoring to your self-hosted Plane instance. Automatically create work items from Sentry alerts and track error resolution. - [Configure Slack for Plane integration](https://developers.plane.so/self-hosting/govern/integrations/slack.md): Connect Slack to your self-hosted Plane instance. Get notifications for work item updates and interact with Plane from Slack channels. #### Plane AI - [Configure embedding model for semantic search](https://developers.plane.so/self-hosting/govern/plane-ai/configure-embedding-model.md): Configure an embedding model for Plane AI semantic search, duplicate detection, and vector retrieval over work items and pages. - [AWS OpenSearch embedding](https://developers.plane.so/self-hosting/govern/plane-ai/aws-opensearch-embedding.md): Step-by-step guide to deploying a Cohere embedding model on AWS OpenSearch for use with Plane AI semantic search. ### Manage - [Backup and restore data](https://developers.plane.so/self-hosting/manage/backup-restore.md): Backup and restore Plane data. Complete guide for backing up database, storage, and configuration files. - [Upgrade from Community to Commercial Edition](https://developers.plane.so/self-hosting/upgrade-from-community.md): Upgrade self-hosted Plane to the latest version. Step-by-step guide for updating your Plane installation safely. - [Upgrade from Community to Airgapped Edition](https://developers.plane.so/self-hosting/manage/community-to-airgapped.md): Deploy Plane in airgapped environment without internet access. Complete guide for offline Plane installation. - [View container logs](https://developers.plane.so/self-hosting/manage/view-logs.md): View and debug container logs for self-hosted Plane. Monitor Docker and Kubernetes service logs to troubleshoot issues. - [Health checks](https://developers.plane.so/self-hosting/manage/health-checks.md): Liveness, readiness, and health endpoints for self-hosted Plane services, and how to wire them into uptime monitors, load balancers, and Kubernetes or Docker Compose probes. - [Move Plane instance to a new server](https://developers.plane.so/self-hosting/manage/migrate-plane.md): Migrate Plane between servers or environments. Guide for moving your Plane installation to new infrastructure. - [Migrate to external services](https://developers.plane.so/self-hosting/manage/migration/migrate-data-to-external-services.md): Move your Plane data from the default local Postgres and MinIO containers to managed cloud services for a production ready deployment. - [Command line tools](https://developers.plane.so/self-hosting/manage/prime-cli.md): Use Plane Prime CLI for managing your self-hosted instance. Commands for setup, configuration, upgrades, and troubleshooting from the terminal. - [User management](https://developers.plane.so/self-hosting/manage/manage-instance-users.md): Manage instance users, invite instance admins, and control access to God Mode. #### Update Plane - [Update Plane version](https://developers.plane.so/self-hosting/manage/upgrade-plane.md): Upgrade self-hosted Plane to the latest version. Step-by-step guide for updating your Plane installation safely. - [Mandatory checkpoint at v0.14.0](https://developers.plane.so/self-hosting/manage/upgrade-from-0.13.2-0.14.0.md): Upgrade self-hosted Plane to the latest version. Step-by-step guide for updating your Plane installation safely. ##### Airgapped Edition - [Upgrade Airgapped Edition (Docker)](https://developers.plane.so/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md): Upgrade your airgapped Plane instance running on Docker by cloning images, replacing configuration files, and uploading a new license. - [Upgrade Airgapped Edition on Kubernetes](https://developers.plane.so/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md): Upgrade your airgapped Plane instance running on Kubernetes by cloning images, updating the Helm chart, and redeploying. #### Manage licenses ##### Commercial Edition - [Activate Pro and Business licenses](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-pro-and-business.md): Activate your Plane Pro or Business Edition license. Upgrade from Community Edition to unlock advanced project management features. - [Activate Enterprise Grid license](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-enterprise.md): Activate your Enterprise Grid license on the Commercial Edition. ##### Airgapped Edition - [Activate Airgapped Edition license](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-airgapped.md): Activate and configure your Plane Airgapped Edition license. Offline license activation for air-gapped environments without internet access. - [Activate Enterprise Grid on Airgapped Edition](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-airgapped-enterprise.md): Offline Enterprise Grid license activation for airgapped environments without internet access. ### Troubleshoot - [Troubleshooting](https://developers.plane.so/self-hosting/troubleshoot/overview.md): Diagnose and resolve issues with your self-hosted Plane instance. - [Installation errors](https://developers.plane.so/self-hosting/troubleshoot/installation-errors.md): Troubleshoot installation errors. Common issues, error messages, and solutions for self-hosted Plane. - [License errors](https://developers.plane.so/self-hosting/troubleshoot/license-errors.md): Troubleshoot Plane license activation errors. Fix common issues with Pro, Business, Enterprise, and Airgapped license keys. - [CLI errors](https://developers.plane.so/self-hosting/troubleshoot/cli-errors.md): Troubleshoot cli errors. Common issues, error messages, and solutions for self-hosted Plane. - [Storage errors](https://developers.plane.so/self-hosting/troubleshoot/storage-errors.md): Troubleshoot Plane storage and upload errors. Fix S3, MinIO, and file upload issues for self-hosted Plane instances. ### API Reference - [Plane API Documentation](https://developers.plane.so/api-reference/introduction.md): Complete REST API reference for Plane. Learn authentication, HTTP methods, pagination, rate limiting, and how to integrate Plane with your applications programmatically. #### Project - [Overview](https://developers.plane.so/api-reference/project/overview.md): Plane Project API overview. Learn about endpoints, request/response format, and how to work with project via REST API. - [Create a project](https://developers.plane.so/api-reference/project/add-project.md): Create a project via Plane API. HTTP request format, parameters, scopes, and example responses for create a project. - [Create project with template](https://developers.plane.so/api-reference/project/create-project-with-template.md): Create a project from an existing project template via Plane API. HTTP request format, parameters, scopes, and example responses for create project with template. - [List all projects](https://developers.plane.so/api-reference/project/list-projects.md): List all projects via Plane API. HTTP request format, parameters, scopes, and example responses for list all projects. - [Retrieve a project](https://developers.plane.so/api-reference/project/get-project-detail.md): Retrieve a project via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a project. - [Update a project](https://developers.plane.so/api-reference/project/update-project-detail.md): Update a project via Plane API. HTTP request format, parameters, scopes, and example responses for update a project. - [Archive project](https://developers.plane.so/api-reference/project/archive-project.md): Archive project via Plane API. HTTP request format, parameters, scopes, and example responses for archive project. - [Unarchive project](https://developers.plane.so/api-reference/project/unarchive-project.md): Unarchive project via Plane API. HTTP request format, parameters, scopes, and example responses for unarchive project. - [Delete a project](https://developers.plane.so/api-reference/project/delete-project.md): Delete a project via Plane API. HTTP request format, parameters, scopes, and example responses for delete a project. #### Project Features - [Overview](https://developers.plane.so/api-reference/project-features/overview.md): Plane Project Features API overview. Learn how to inspect and update project feature flags with the Plane API. - [Get project features](https://developers.plane.so/api-reference/project-features/get-project-features.md): Get project features via Plane API. HTTP request format, parameters, scopes, and example responses for get project features. - [Update project features](https://developers.plane.so/api-reference/project-features/update-project-features.md): Update project features via Plane API. HTTP request format, parameters, scopes, and example responses for update project features. #### Project Labels - [Overview](https://developers.plane.so/api-reference/project-labels/overview.md): Plane Project Labels API overview. Learn how to manage workspace-level project labels with the Plane API. - [Create project label](https://developers.plane.so/api-reference/project-labels/add-project-label.md): Create project label via Plane API. HTTP request format, parameters, scopes, and example responses for create project label. - [List project labels](https://developers.plane.so/api-reference/project-labels/list-project-labels.md): List project labels via Plane API. HTTP request format, parameters, scopes, and example responses for list project labels. - [Get project label](https://developers.plane.so/api-reference/project-labels/get-project-label-detail.md): Get project label via Plane API. HTTP request format, parameters, scopes, and example responses for get project label. - [Update project label](https://developers.plane.so/api-reference/project-labels/update-project-label-detail.md): Update project label via Plane API. HTTP request format, parameters, scopes, and example responses for update project label. - [Delete project label](https://developers.plane.so/api-reference/project-labels/delete-project-label.md): Delete project label via Plane API. HTTP request format, parameters, scopes, and example responses for delete project label. #### Work Item - [Overview](https://developers.plane.so/api-reference/issue/overview.md): Plane Issue API overview. Learn about endpoints, request/response format, and how to work with issue via REST API. - [Create a work item](https://developers.plane.so/api-reference/issue/add-issue.md): Create a work item via Plane API. HTTP request format, parameters, scopes, and example responses for create a work item. - [List all work items](https://developers.plane.so/api-reference/issue/list-issues.md): List all work items via Plane API. HTTP request format, parameters, scopes, and example responses for list all work items. - [Retrieve a work item by ID](https://developers.plane.so/api-reference/issue/get-issue-detail.md): Retrieve a work item by ID via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a work item by id. - [Retrieve a work item by identifier](https://developers.plane.so/api-reference/issue/get-issue-sequence-id.md): Retrieve a work item by identifier via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a work item by identifier. - [Search work items](https://developers.plane.so/api-reference/issue/search-issues.md): Search work items via Plane API. HTTP request format, parameters, scopes, and example responses for search work items. - [Advanced search work items](https://developers.plane.so/api-reference/issue/advanced-search-work-items.md): Advanced search work items via Plane API. HTTP request format, parameters, scopes, and example responses for advanced search work items. - [Update a work item](https://developers.plane.so/api-reference/issue/update-issue-detail.md): Update a work item via Plane API. HTTP request format, parameters, scopes, and example responses for update a work item. - [Delete a work item](https://developers.plane.so/api-reference/issue/delete-issue.md): Delete a work item via Plane API. HTTP request format, parameters, scopes, and example responses for delete a work item. #### Work Item States - [Overview](https://developers.plane.so/api-reference/state/overview.md): Plane State API overview. Learn about endpoints, request/response format, and how to work with state via REST API. - [Create a state](https://developers.plane.so/api-reference/state/add-state.md): Create a state via Plane API. HTTP request format, parameters, scopes, and example responses for create a state. - [List all states](https://developers.plane.so/api-reference/state/list-states.md): List all states via Plane API. HTTP request format, parameters, scopes, and example responses for list all states. - [Retrieve a state](https://developers.plane.so/api-reference/state/get-state-detail.md): Retrieve a state via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a state. - [Update a state](https://developers.plane.so/api-reference/state/update-state-detail.md): Update a state via Plane API. HTTP request format, parameters, scopes, and example responses for update a state. - [Delete a state](https://developers.plane.so/api-reference/state/delete-state.md): Delete a state via Plane API. HTTP request format, parameters, scopes, and example responses for delete a state. #### Work Item Labels - [Overview](https://developers.plane.so/api-reference/label/overview.md): Plane Label API overview. Learn about endpoints, request/response format, and how to work with label via REST API. - [Create a label](https://developers.plane.so/api-reference/label/add-label.md): Create a label via Plane API. HTTP request format, parameters, scopes, and example responses for create a label. - [List all labels](https://developers.plane.so/api-reference/label/list-labels.md): List all labels via Plane API. HTTP request format, parameters, scopes, and example responses for list all labels. - [Retrieve a label](https://developers.plane.so/api-reference/label/get-label-detail.md): Retrieve a label via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a label. - [Update a label](https://developers.plane.so/api-reference/label/update-label-detail.md): Update a label via Plane API. HTTP request format, parameters, scopes, and example responses for update a label. - [Delete a label](https://developers.plane.so/api-reference/label/delete-label.md): Delete a label via Plane API. HTTP request format, parameters, scopes, and example responses for delete a label. #### Work Item Types - [Overview](https://developers.plane.so/api-reference/issue-types/types/overview.md): Plane Types API overview. Learn about endpoints, request/response format, and how to work with types via REST API. - [Create a work item type](https://developers.plane.so/api-reference/issue-types/types/add-issue-type.md): Create a work item type via Plane API. HTTP request format, parameters, scopes, and example responses for create a work item type. - [List all work item types](https://developers.plane.so/api-reference/issue-types/types/list-issue-types.md): List all work item types via Plane API. HTTP request format, parameters, scopes, and example responses for list all work item types. - [Retrieve a work item type](https://developers.plane.so/api-reference/issue-types/types/get-issue-type-details.md): Retrieve a work item type via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a work item type. - [Get work item type schema](https://developers.plane.so/api-reference/issue-types/types/get-work-item-type-schema.md): Get work item type schema via Plane API. HTTP request format, parameters, scopes, and example responses for get work item type schema. - [Update a work item type](https://developers.plane.so/api-reference/issue-types/types/update-issue-types.md): Update a work item type via Plane API. HTTP request format, parameters, scopes, and example responses for update a work item type. - [Delete a work item type](https://developers.plane.so/api-reference/issue-types/types/delete-issue-type.md): Delete a work item type via Plane API. HTTP request format, parameters, scopes, and example responses for delete a work item type. #### Custom Properties - [Overview](https://developers.plane.so/api-reference/issue-types/properties/overview.md): Plane Properties API overview. Learn about endpoints, request/response format, and how to work with properties via REST API. - [Create a custom property](https://developers.plane.so/api-reference/issue-types/properties/add-property.md): Create a custom property via Plane API. HTTP request format, parameters, scopes, and example responses for create a custom property. - [List custom properties](https://developers.plane.so/api-reference/issue-types/properties/list-properties.md): List custom properties via Plane API. HTTP request format, parameters, scopes, and example responses for list custom properties. - [Retrieve a custom property](https://developers.plane.so/api-reference/issue-types/properties/get-property-details.md): Retrieve a custom property via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a custom property. - [Update a custom property](https://developers.plane.so/api-reference/issue-types/properties/update-property.md): Update a custom property via Plane API. HTTP request format, parameters, scopes, and example responses for update a custom property. - [Delete a custom property](https://developers.plane.so/api-reference/issue-types/properties/delete-property.md): Delete a custom property via Plane API. HTTP request format, parameters, scopes, and example responses for delete a custom property. #### Custom Property Values - [Overview](https://developers.plane.so/api-reference/issue-types/values/overview.md): Plane Values API overview. Learn about endpoints, request/response format, and how to work with values via REST API. - [Add custom property values](https://developers.plane.so/api-reference/issue-types/values/add-property-values.md): Add custom property values via Plane API. HTTP request format, parameters, scopes, and example responses for add custom property values. - [List all custom property values](https://developers.plane.so/api-reference/issue-types/values/list-property-values.md): List all custom property values via Plane API. HTTP request format, parameters, scopes, and example responses for list all custom property values. - [Get property value](https://developers.plane.so/api-reference/issue-types/values/get-property-value-detail.md): Get property value via Plane API. HTTP request format, parameters, scopes, and example responses for get property value. - [Update property value](https://developers.plane.so/api-reference/issue-types/values/update-property-value.md): Update property value via Plane API. HTTP request format, parameters, scopes, and example responses for update property value. - [Delete property value](https://developers.plane.so/api-reference/issue-types/values/delete-property-value.md): Delete property value via Plane API. HTTP request format, parameters, scopes, and example responses for delete property value. #### Custom Property Options - [Overview](https://developers.plane.so/api-reference/issue-types/options/overview.md): Plane Options API overview. Learn about endpoints, request/response format, and how to work with options via REST API. - [Add dropdown options](https://developers.plane.so/api-reference/issue-types/options/add-dropdown-options.md): Add dropdown options via Plane API. HTTP request format, parameters, scopes, and example responses for add dropdown options. - [List all dropdown options](https://developers.plane.so/api-reference/issue-types/options/list-dropdown-options.md): List all dropdown options via Plane API. HTTP request format, parameters, scopes, and example responses for list all dropdown options. - [Retrieve option details](https://developers.plane.so/api-reference/issue-types/options/get-option-details.md): Retrieve option details via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve option details. - [Update dropdown options](https://developers.plane.so/api-reference/issue-types/options/update-dropdown-options.md): Update dropdown options via Plane API. HTTP request format, parameters, scopes, and example responses for update dropdown options. - [Delete dropdown options](https://developers.plane.so/api-reference/issue-types/options/delete-dropdown-options.md): Delete dropdown options via Plane API. HTTP request format, parameters, scopes, and example responses for delete dropdown options. #### Work Item Links - [Overview](https://developers.plane.so/api-reference/link/overview.md): Plane Link API overview. Learn about endpoints, request/response format, and how to work with link via REST API. - [Create a link](https://developers.plane.so/api-reference/link/add-link.md): Create a link via Plane API. HTTP request format, parameters, scopes, and example responses for create a link. - [List all links](https://developers.plane.so/api-reference/link/list-links.md): List all links via Plane API. HTTP request format, parameters, scopes, and example responses for list all links. - [Retrieve a link](https://developers.plane.so/api-reference/link/get-link-detail.md): Retrieve a link via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a link. - [Update a link](https://developers.plane.so/api-reference/link/update-link-detail.md): Update a link via Plane API. HTTP request format, parameters, scopes, and example responses for update a link. - [Delete a link](https://developers.plane.so/api-reference/link/delete-link.md): Delete a link via Plane API. HTTP request format, parameters, scopes, and example responses for delete a link. #### Work Item Activity - [Overview](https://developers.plane.so/api-reference/issue-activity/overview.md): Plane Issue-Activity API overview. Learn about endpoints, request/response format, and how to work with issue-activity via REST API. - [List all work item activity](https://developers.plane.so/api-reference/issue-activity/list-issue-activities.md): List all work item activity via Plane API. HTTP request format, parameters, scopes, and example responses for list all work item activity. - [Retrieve a work item activity](https://developers.plane.so/api-reference/issue-activity/get-issue-activity-detail.md): Retrieve a work item activity via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a work item activity. #### Work Item Comments - [Overview](https://developers.plane.so/api-reference/issue-comment/overview.md): Plane Issue-Comment API overview. Learn about endpoints, request/response format, and how to work with issue-comment via REST API. - [Create a work item comment](https://developers.plane.so/api-reference/issue-comment/add-issue-comment.md): Create a work item comment via Plane API. HTTP request format, parameters, scopes, and example responses for create a work item comment. - [List all work item comments](https://developers.plane.so/api-reference/issue-comment/list-issue-comments.md): List all work item comments via Plane API. HTTP request format, parameters, scopes, and example responses for list all work item comments. - [Retrieve a work item comment](https://developers.plane.so/api-reference/issue-comment/get-issue-comment-detail.md): Retrieve a work item comment via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a work item comment. - [Update a work item comment](https://developers.plane.so/api-reference/issue-comment/update-issue-comment-detail.md): Update a work item comment via Plane API. HTTP request format, parameters, scopes, and example responses for update a work item comment. - [Delete a work item comment](https://developers.plane.so/api-reference/issue-comment/delete-issue-comment.md): Delete a work item comment via Plane API. HTTP request format, parameters, scopes, and example responses for delete a work item comment. #### Work Item Attachments - [Overview](https://developers.plane.so/api-reference/issue-attachments/overview.md): Plane Issue-Attachments API overview. Learn about endpoints, request/response format, and how to work with issue-attachments via REST API. - [List all attachments](https://developers.plane.so/api-reference/issue-attachments/get-attachments.md): List all attachments via Plane API. HTTP request format, parameters, scopes, and example responses for list all attachments. - [Retrieve an attachment](https://developers.plane.so/api-reference/issue-attachments/get-attachment-detail.md): Retrieve an attachment via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve an attachment. - [Get upload credentials](https://developers.plane.so/api-reference/issue-attachments/get-upload-credentials.md): Get upload credentials via Plane API. HTTP request format, parameters, scopes, and example responses for get upload credentials. - [Upload file](https://developers.plane.so/api-reference/issue-attachments/upload-file.md): Upload a file to the presigned storage URL returned by Plane. Includes the required multipart form fields for attachment uploads. - [Complete upload](https://developers.plane.so/api-reference/issue-attachments/complete-upload.md): Complete upload via Plane API. HTTP request format, parameters, scopes, and example responses for complete upload. - [Update an attachment](https://developers.plane.so/api-reference/issue-attachments/update-attachment.md): Update an attachment via Plane API. HTTP request format, parameters, scopes, and example responses for update an attachment. - [Delete an attachment](https://developers.plane.so/api-reference/issue-attachments/delete-attachment.md): Delete an attachment via Plane API. HTTP request format, parameters, scopes, and example responses for delete an attachment. #### Work Item Page Links - [Overview](https://developers.plane.so/api-reference/work-item-pages/overview.md): Plane Work Item Pages API overview. Learn how to link pages to work items using the Plane API. - [Create work item page link](https://developers.plane.so/api-reference/work-item-pages/add-work-item-page.md): Create work item page link via Plane API. HTTP request format, parameters, scopes, and example responses for create work item page link. - [List work item pages](https://developers.plane.so/api-reference/work-item-pages/list-work-item-pages.md): List work item pages via Plane API. HTTP request format, parameters, scopes, and example responses for list work item pages. - [Get work item page link](https://developers.plane.so/api-reference/work-item-pages/get-work-item-page-detail.md): Get work item page link via Plane API. HTTP request format, parameters, scopes, and example responses for get work item page link. - [Delete work item page link](https://developers.plane.so/api-reference/work-item-pages/delete-work-item-page.md): Delete work item page link via Plane API. HTTP request format, parameters, scopes, and example responses for delete work item page link. #### Cycles - [Overview](https://developers.plane.so/api-reference/cycle/overview.md): Plane Cycle API overview. Learn about endpoints, request/response format, and how to work with cycle via REST API. - [Create a cycle](https://developers.plane.so/api-reference/cycle/add-cycle.md): Create a cycle via Plane API. HTTP request format, parameters, scopes, and example responses for create a cycle. - [Add work items to cycle](https://developers.plane.so/api-reference/cycle/add-cycle-work-items.md): Add work items to cycle via Plane API. HTTP request format, parameters, scopes, and example responses for add work items to cycle. - [Transfer cycle work items](https://developers.plane.so/api-reference/cycle/transfer-cycle-work-items.md): Transfer cycle work items via Plane API. HTTP request format, parameters, scopes, and example responses for transfer cycle work items. - [Archive a cycle](https://developers.plane.so/api-reference/cycle/archive-cycle.md): Archive a cycle via Plane API. HTTP request format, parameters, scopes, and example responses for archive a cycle. - [List all cycles](https://developers.plane.so/api-reference/cycle/list-cycles.md): List all cycles via Plane API. HTTP request format, parameters, scopes, and example responses for list all cycles. - [Retrieve a cycle](https://developers.plane.so/api-reference/cycle/get-cycle-detail.md): Retrieve a cycle via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a cycle. - [List all work items in a cycle](https://developers.plane.so/api-reference/cycle/list-cycle-work-items.md): List all work items in a cycle via Plane API. HTTP request format, parameters, scopes, and example responses for list all work items in a cycle. - [List all archived cycles](https://developers.plane.so/api-reference/cycle/list-archived-cycles.md): List all archived cycles via Plane API. HTTP request format, parameters, scopes, and example responses for list all archived cycles. - [Update a cycle](https://developers.plane.so/api-reference/cycle/update-cycle-detail.md): Update a cycle via Plane API. HTTP request format, parameters, scopes, and example responses for update a cycle. - [Restore a cycle](https://developers.plane.so/api-reference/cycle/unarchive-cycle.md): Restore a cycle via Plane API. HTTP request format, parameters, scopes, and example responses for restore a cycle. - [Remove work item from cycle](https://developers.plane.so/api-reference/cycle/remove-cycle-work-item.md): Remove work item from cycle via Plane API. HTTP request format, parameters, scopes, and example responses for remove work item from cycle. - [Delete a cycle](https://developers.plane.so/api-reference/cycle/delete-cycle.md): Delete a cycle via Plane API. HTTP request format, parameters, scopes, and example responses for delete a cycle. #### Modules - [Overview](https://developers.plane.so/api-reference/module/overview.md): Plane Module API overview. Learn about endpoints, request/response format, and how to work with module via REST API. - [Create a module](https://developers.plane.so/api-reference/module/add-module.md): Create a module via Plane API. HTTP request format, parameters, scopes, and example responses for create a module. - [Add work items to module](https://developers.plane.so/api-reference/module/add-module-work-items.md): Add work items to module via Plane API. HTTP request format, parameters, scopes, and example responses for add work items to module. - [Archive a module](https://developers.plane.so/api-reference/module/archive-module.md): Archive a module via Plane API. HTTP request format, parameters, scopes, and example responses for archive a module. - [List all modules](https://developers.plane.so/api-reference/module/list-modules.md): List all modules via Plane API. HTTP request format, parameters, scopes, and example responses for list all modules. - [Retrieve a module](https://developers.plane.so/api-reference/module/get-module-detail.md): Retrieve a module via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a module. - [List all work items in a module](https://developers.plane.so/api-reference/module/list-module-work-items.md): List all work items in a module via Plane API. HTTP request format, parameters, scopes, and example responses for list all work items in a module. - [List all archived modules](https://developers.plane.so/api-reference/module/list-archived-modules.md): List all archived modules via Plane API. HTTP request format, parameters, scopes, and example responses for list all archived modules. - [Update module details](https://developers.plane.so/api-reference/module/update-module-detail.md): Update module details via Plane API. HTTP request format, parameters, scopes, and example responses for update module details. - [Restore a module](https://developers.plane.so/api-reference/module/unarchive-module.md): Restore a module via Plane API. HTTP request format, parameters, scopes, and example responses for restore a module. - [Remove work item from module](https://developers.plane.so/api-reference/module/remove-module-work-item.md): Remove work item from module via Plane API. HTTP request format, parameters, scopes, and example responses for remove work item from module. - [Delete a module](https://developers.plane.so/api-reference/module/delete-module.md): Delete a module via Plane API. HTTP request format, parameters, scopes, and example responses for delete a module. #### Pages - [Overview](https://developers.plane.so/api-reference/page/overview.md): Plane Page API overview. Learn about endpoints, request/response format, and how to work with page via REST API. - [List workspace wiki pages](https://developers.plane.so/api-reference/page/list-workspace-pages.md): List workspace wiki pages via Plane API. HTTP request format, parameters, scopes, and example responses for listing workspace wiki pages. - [Create a wiki page](https://developers.plane.so/api-reference/page/add-workspace-page.md): Create a wiki page via Plane API. HTTP request format, parameters, scopes, and example responses for create a wiki page. - [List project pages](https://developers.plane.so/api-reference/page/list-project-pages.md): List project pages via Plane API. HTTP request format, parameters, scopes, and example responses for listing project pages. - [Create a project page](https://developers.plane.so/api-reference/page/add-project-page.md): Create a project page via Plane API. HTTP request format, parameters, scopes, and example responses for create a project page. - [Retrieve a wiki page](https://developers.plane.so/api-reference/page/get-workspace-page.md): Retrieve a wiki page via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a wiki page. - [Retrieve a project page](https://developers.plane.so/api-reference/page/get-project-page.md): Retrieve a project page via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a project page. #### Intake - [Overview](https://developers.plane.so/api-reference/intake-issue/overview.md): Plane Intake-Issue API overview. Learn about endpoints, request/response format, and how to work with intake-issue via REST API. - [Create an intake work item](https://developers.plane.so/api-reference/intake-issue/add-intake-issue.md): Create an intake work item via Plane API. HTTP request format, parameters, scopes, and example responses for create an intake work item. - [List all intake work items](https://developers.plane.so/api-reference/intake-issue/list-intake-issues.md): List all intake work items via Plane API. HTTP request format, parameters, scopes, and example responses for list all intake work items. - [Retrieve an intake work item](https://developers.plane.so/api-reference/intake-issue/get-intake-issue-detail.md): Retrieve an intake work item via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve an intake work item. - [Update an intake work item](https://developers.plane.so/api-reference/intake-issue/update-intake-issue-detail.md): Update an intake work item via Plane API. HTTP request format, parameters, scopes, and example responses for update an intake work item. - [Delete an intake work item](https://developers.plane.so/api-reference/intake-issue/delete-intake-issue.md): Delete an intake work item via Plane API. HTTP request format, parameters, scopes, and example responses for delete an intake work item. #### Assets - [Overview](https://developers.plane.so/api-reference/assets/overview.md): Plane Assets API overview. Learn how user and workspace asset uploads work through the Plane API. - [Create user asset upload](https://developers.plane.so/api-reference/assets/create-user-asset-upload.md): Create user asset upload via Plane API. HTTP request format, parameters, scopes, and example responses for create user asset upload. - [Update user asset](https://developers.plane.so/api-reference/assets/update-user-asset.md): Update user asset via Plane API. HTTP request format, parameters, scopes, and example responses for update user asset. - [Delete user asset](https://developers.plane.so/api-reference/assets/delete-user-asset.md): Delete user asset via Plane API. HTTP request format, parameters, scopes, and example responses for delete user asset. - [Create workspace asset upload](https://developers.plane.so/api-reference/assets/create-workspace-asset-upload.md): Create workspace asset upload via Plane API. HTTP request format, parameters, scopes, and example responses for create workspace asset upload. - [Get workspace asset](https://developers.plane.so/api-reference/assets/get-workspace-asset.md): Get workspace asset via Plane API. HTTP request format, parameters, scopes, and example responses for get workspace asset. - [Update workspace asset](https://developers.plane.so/api-reference/assets/update-workspace-asset.md): Update workspace asset via Plane API. HTTP request format, parameters, scopes, and example responses for update workspace asset. #### Milestones - [Overview](https://developers.plane.so/api-reference/milestones/overview.md): Plane Milestones API overview. Learn how to manage milestones and milestone work items through the Plane API. - [Create milestone](https://developers.plane.so/api-reference/milestones/add-milestone.md): Create milestone via Plane API. HTTP request format, parameters, scopes, and example responses for create milestone. - [List milestones](https://developers.plane.so/api-reference/milestones/list-milestones.md): List milestones via Plane API. HTTP request format, parameters, scopes, and example responses for list milestones. - [Get milestone](https://developers.plane.so/api-reference/milestones/get-milestone-detail.md): Get milestone via Plane API. HTTP request format, parameters, scopes, and example responses for get milestone. - [List milestone work items](https://developers.plane.so/api-reference/milestones/list-milestone-work-items.md): List milestone work items via Plane API. HTTP request format, parameters, scopes, and example responses for list milestone work items. - [Update milestone](https://developers.plane.so/api-reference/milestones/update-milestone-detail.md): Update milestone via Plane API. HTTP request format, parameters, scopes, and example responses for update milestone. - [Delete milestone](https://developers.plane.so/api-reference/milestones/delete-milestone.md): Delete milestone via Plane API. HTTP request format, parameters, scopes, and example responses for delete milestone. #### Estimates - [Overview](https://developers.plane.so/api-reference/estimate/overview.md): Plane Estimate API overview. Learn about estimate objects, estimate points, and how to work with estimates via REST API. - [Create an estimate](https://developers.plane.so/api-reference/estimate/add-estimate.md): Create an estimate via Plane API. HTTP request format, parameters, scopes, and example responses for create an estimate. - [Get an estimate](https://developers.plane.so/api-reference/estimate/get-estimate.md): Get an estimate via Plane API. HTTP request format, parameters, scopes, and example responses for get an estimate. - [Update an estimate](https://developers.plane.so/api-reference/estimate/update-estimate.md): Update an estimate via Plane API. HTTP request format, parameters, scopes, and example responses for update an estimate. - [Delete an estimate](https://developers.plane.so/api-reference/estimate/delete-estimate.md): Delete an estimate via Plane API. HTTP request format, parameters, scopes, and example responses for delete an estimate. - [List estimate points](https://developers.plane.so/api-reference/estimate/list-estimate-points.md): List estimate points via Plane API. HTTP request format, parameters, scopes, and example responses for list estimate points. - [Create estimate points](https://developers.plane.so/api-reference/estimate/add-estimate-points.md): Create estimate points via Plane API. HTTP request format, parameters, scopes, and example responses for create estimate points. - [Update an estimate point](https://developers.plane.so/api-reference/estimate/update-estimate-point.md): Update an estimate point via Plane API. HTTP request format, parameters, scopes, and example responses for update an estimate point. - [Delete an estimate point](https://developers.plane.so/api-reference/estimate/delete-estimate-point.md): Delete an estimate point via Plane API. HTTP request format, parameters, scopes, and example responses for delete an estimate point. #### Time Tracking - [Overview](https://developers.plane.so/api-reference/worklogs/overview.md): Plane Worklogs API overview. Learn about endpoints, request/response format, and how to work with worklogs via REST API. - [Create a worklog](https://developers.plane.so/api-reference/worklogs/create-worklog.md): Create a worklog via Plane API. HTTP request format, parameters, scopes, and example responses for create a worklog. - [List all worklogs for a work item](https://developers.plane.so/api-reference/worklogs/get-worklogs-for-issue.md): List all worklogs for a work item via Plane API. HTTP request format, parameters, scopes, and example responses for list all worklogs for a work item. - [Get total time for each work item](https://developers.plane.so/api-reference/worklogs/get-total-time.md): Get total time for each work item via Plane API. HTTP request format, parameters, scopes, and example responses for get total time for each work item. - [Update a worklog](https://developers.plane.so/api-reference/worklogs/update-worklog.md): Update a worklog via Plane API. HTTP request format, parameters, scopes, and example responses for update a worklog. - [Delete a worklog](https://developers.plane.so/api-reference/worklogs/delete-worklog.md): Delete a worklog via Plane API. HTTP request format, parameters, scopes, and example responses for delete a worklog. #### Epics - [Overview](https://developers.plane.so/api-reference/epics/overview.md): Plane Epics API overview. Learn about endpoints, request/response format, and how to work with epics via REST API. - [Create an epic](https://developers.plane.so/api-reference/epics/create-epic.md): Create an epic via Plane API. HTTP request format, parameters, scopes, and example responses for create an epic. - [List all epics](https://developers.plane.so/api-reference/epics/list-epics.md): List all epics via Plane API. HTTP request format, parameters, scopes, and example responses for list all epics. - [Retrieve an epic](https://developers.plane.so/api-reference/epics/get-epic-detail.md): Retrieve an epic via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve an epic. - [Update an epic](https://developers.plane.so/api-reference/epics/update-epic.md): Update an epic via Plane API. HTTP request format, parameters, scopes, and example responses for update an epic. - [Delete an epic](https://developers.plane.so/api-reference/epics/delete-epic.md): Delete an epic via Plane API. HTTP request format, parameters, scopes, and example responses for delete an epic. - [Add work items to epic](https://developers.plane.so/api-reference/epics/add-epic-work-items.md): Add work items to epic via Plane API. HTTP request format, parameters, scopes, and example responses for add work items to epic. - [List epic work items](https://developers.plane.so/api-reference/epics/list-epic-work-items.md): List epic work items via Plane API. HTTP request format, parameters, scopes, and example responses for list epic work items. #### Initiatives - [Overview](https://developers.plane.so/api-reference/initiative/overview.md): Plane Initiative API overview. Learn about endpoints, request/response format, and how to work with initiative via REST API. - [Create an initiative](https://developers.plane.so/api-reference/initiative/add-initiative.md): Create an initiative via Plane API. HTTP request format, parameters, scopes, and example responses for create an initiative. - [List all initiatives](https://developers.plane.so/api-reference/initiative/list-initiatives.md): List all initiatives via Plane API. HTTP request format, parameters, scopes, and example responses for list all initiatives. - [Retrieve an initiative](https://developers.plane.so/api-reference/initiative/get-initiative-detail.md): Retrieve an initiative via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve an initiative. - [Update an initiative](https://developers.plane.so/api-reference/initiative/update-initiative-detail.md): Update an initiative via Plane API. HTTP request format, parameters, scopes, and example responses for update an initiative. - [Delete an initiative](https://developers.plane.so/api-reference/initiative/delete-initiative.md): Delete an initiative via Plane API. HTTP request format, parameters, scopes, and example responses for delete an initiative. #### Initiative Labels - [Create an initiative label](https://developers.plane.so/api-reference/initiative/add-initiative-label.md): Create an initiative label via Plane API. HTTP request format, parameters, scopes, and example responses for create an initiative label. - [Add labels to initiative](https://developers.plane.so/api-reference/initiative/add-labels-to-initiative.md): Add labels to initiative via Plane API. HTTP request format, parameters, scopes, and example responses for add labels to initiative. - [List all initiative labels](https://developers.plane.so/api-reference/initiative/list-initiative-labels.md): List all initiative labels via Plane API. HTTP request format, parameters, scopes, and example responses for list all initiative labels. - [Retrieve an initiative label](https://developers.plane.so/api-reference/initiative/get-initiative-label-detail.md): Retrieve an initiative label via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve an initiative label. - [List all labels for an initiative](https://developers.plane.so/api-reference/initiative/list-initiative-labels-for-initiative.md): List all labels for an initiative via Plane API. HTTP request format, parameters, scopes, and example responses for list all labels for an initiative. - [Update an initiative label](https://developers.plane.so/api-reference/initiative/update-initiative-label-detail.md): Update an initiative label via Plane API. HTTP request format, parameters, scopes, and example responses for update an initiative label. - [Remove labels from initiative](https://developers.plane.so/api-reference/initiative/remove-labels-from-initiative.md): Remove labels from initiative via Plane API. HTTP request format, parameters, scopes, and example responses for remove labels from initiative. - [Delete an initiative label](https://developers.plane.so/api-reference/initiative/delete-initiative-label.md): Delete an initiative label via Plane API. HTTP request format, parameters, scopes, and example responses for delete an initiative label. #### Initiative Projects - [Add projects to initiative](https://developers.plane.so/api-reference/initiative/add-projects-to-initiative.md): Add projects to initiative via Plane API. HTTP request format, parameters, scopes, and example responses for add projects to initiative. - [List all projects in an initiative](https://developers.plane.so/api-reference/initiative/list-initiative-projects.md): List all projects in an initiative via Plane API. HTTP request format, parameters, scopes, and example responses for list all projects in an initiative. - [Remove projects from initiative](https://developers.plane.so/api-reference/initiative/remove-projects-from-initiative.md): Remove projects from initiative via Plane API. HTTP request format, parameters, scopes, and example responses for remove projects from initiative. #### Initiative Epics - [Add epics to initiative](https://developers.plane.so/api-reference/initiative/add-epics-to-initiative.md): Add epics to initiative via Plane API. HTTP request format, parameters, scopes, and example responses for add epics to initiative. - [List all epics for an initiative](https://developers.plane.so/api-reference/initiative/list-initiative-epics.md): List all epics for an initiative via Plane API. HTTP request format, parameters, scopes, and example responses for list all epics for an initiative. - [Remove epics from initiative](https://developers.plane.so/api-reference/initiative/remove-epics-from-initiative.md): Remove epics from initiative via Plane API. HTTP request format, parameters, scopes, and example responses for remove epics from initiative. #### Customers - [Overview](https://developers.plane.so/api-reference/customer/overview.md): Plane Customer API overview. Learn about endpoints, request/response format, and how to work with customer via REST API. - [Create a customer](https://developers.plane.so/api-reference/customer/add-customer.md): Create a customer via Plane API. HTTP request format, parameters, scopes, and example responses for create a customer. - [Link work items to customer](https://developers.plane.so/api-reference/customer/link-work-items-to-customer.md): Link work items to customer via Plane API. HTTP request format, parameters, scopes, and example responses for link work items to customer. - [List all customers](https://developers.plane.so/api-reference/customer/list-customers.md): List all customers via Plane API. HTTP request format, parameters, scopes, and example responses for list all customers. - [Retrieve a customer](https://developers.plane.so/api-reference/customer/get-customer-detail.md): Retrieve a customer via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a customer. - [List all customer work items](https://developers.plane.so/api-reference/customer/list-customer-work-items.md): List all customer work items via Plane API. HTTP request format, parameters, scopes, and example responses for list all customer work items. - [Update a customer](https://developers.plane.so/api-reference/customer/update-customer-detail.md): Update a customer via Plane API. HTTP request format, parameters, scopes, and example responses for update a customer. - [Unlink work item from customer](https://developers.plane.so/api-reference/customer/unlink-work-item-from-customer.md): Unlink work item from customer via Plane API. HTTP request format, parameters, scopes, and example responses for unlink work item from customer. - [Delete a customer](https://developers.plane.so/api-reference/customer/delete-customer.md): Delete a customer via Plane API. HTTP request format, parameters, scopes, and example responses for delete a customer. #### Customer Properties - [Create a customer property](https://developers.plane.so/api-reference/customer/add-customer-property.md): Create a customer property via Plane API. HTTP request format, parameters, scopes, and example responses for create a customer property. - [List all customer properties](https://developers.plane.so/api-reference/customer/list-customer-properties.md): List all customer properties via Plane API. HTTP request format, parameters, scopes, and example responses for list all customer properties. - [Retrieve a customer property](https://developers.plane.so/api-reference/customer/get-customer-property-detail.md): Retrieve a customer property via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a customer property. - [List all customer property values](https://developers.plane.so/api-reference/customer/list-customer-property-values.md): List all customer property values via Plane API. HTTP request format, parameters, scopes, and example responses for list all customer property values. - [Retrieve a customer property value](https://developers.plane.so/api-reference/customer/get-customer-property-value.md): Retrieve a customer property value via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a customer property value. - [Update a customer property](https://developers.plane.so/api-reference/customer/update-customer-property-detail.md): Update a customer property via Plane API. HTTP request format, parameters, scopes, and example responses for update a customer property. - [Update a customer property value](https://developers.plane.so/api-reference/customer/update-customer-property-value.md): Update a customer property value via Plane API. HTTP request format, parameters, scopes, and example responses for update a customer property value. - [Delete a customer property](https://developers.plane.so/api-reference/customer/delete-customer-property.md): Delete a customer property via Plane API. HTTP request format, parameters, scopes, and example responses for delete a customer property. #### Customer Requests - [Create a customer request](https://developers.plane.so/api-reference/customer/add-customer-request.md): Create a customer request via Plane API. HTTP request format, parameters, scopes, and example responses for create a customer request. - [List all customer requests](https://developers.plane.so/api-reference/customer/list-customer-requests.md): List all customer requests via Plane API. HTTP request format, parameters, scopes, and example responses for list all customer requests. - [Retrieve a customer request](https://developers.plane.so/api-reference/customer/get-customer-request-detail.md): Retrieve a customer request via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a customer request. - [Update a customer request](https://developers.plane.so/api-reference/customer/update-customer-request-detail.md): Update a customer request via Plane API. HTTP request format, parameters, scopes, and example responses for update a customer request. - [Delete a customer request](https://developers.plane.so/api-reference/customer/delete-customer-request.md): Delete a customer request via Plane API. HTTP request format, parameters, scopes, and example responses for delete a customer request. #### Teamspaces - [Overview](https://developers.plane.so/api-reference/teamspace/overview.md): Plane Teamspace API overview. Learn about endpoints, request/response format, and how to work with teamspace via REST API. - [Create a teamspace](https://developers.plane.so/api-reference/teamspace/add-teamspace.md): Create a teamspace via Plane API. HTTP request format, parameters, scopes, and example responses for create a teamspace. - [List all teamspaces](https://developers.plane.so/api-reference/teamspace/list-teamspaces.md): List all teamspaces via Plane API. HTTP request format, parameters, scopes, and example responses for list all teamspaces. - [Retrieve a teamspace](https://developers.plane.so/api-reference/teamspace/get-teamspace-detail.md): Retrieve a teamspace via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a teamspace. - [Update a teamspace](https://developers.plane.so/api-reference/teamspace/update-teamspace-detail.md): Update a teamspace via Plane API. HTTP request format, parameters, scopes, and example responses for update a teamspace. - [Delete a teamspace](https://developers.plane.so/api-reference/teamspace/delete-teamspace.md): Delete a teamspace via Plane API. HTTP request format, parameters, scopes, and example responses for delete a teamspace. #### Teamspace Members - [List all teamspace members](https://developers.plane.so/api-reference/teamspace/list-teamspace-members.md): List all teamspace members via Plane API. HTTP request format, parameters, scopes, and example responses for list all teamspace members. - [Add members to teamspace](https://developers.plane.so/api-reference/teamspace/add-teamspace-members.md): Add members to teamspace via Plane API. HTTP request format, parameters, scopes, and example responses for add members to teamspace. - [Remove members from teamspace](https://developers.plane.so/api-reference/teamspace/remove-teamspace-members.md): Remove members from teamspace via Plane API. HTTP request format, parameters, scopes, and example responses for remove members from teamspace. #### Teamspace Projects - [List teamspace projects](https://developers.plane.so/api-reference/teamspace/list-teamspace-projects.md): List teamspace projects via Plane API. HTTP request format, parameters, scopes, and example responses for list teamspace projects. - [Add projects to teamspace](https://developers.plane.so/api-reference/teamspace/add-projects-to-teamspace.md): Add projects to teamspace via Plane API. HTTP request format, parameters, scopes, and example responses for add projects to teamspace. - [Remove projects from teamspace](https://developers.plane.so/api-reference/teamspace/remove-projects-from-teamspace.md): Remove projects from teamspace via Plane API. HTTP request format, parameters, scopes, and example responses for remove projects from teamspace. #### Stickies - [Overview](https://developers.plane.so/api-reference/sticky/overview.md): Plane Sticky API overview. Learn about endpoints, request/response format, and how to work with sticky via REST API. - [Create a sticky](https://developers.plane.so/api-reference/sticky/add-sticky.md): Create a sticky via Plane API. HTTP request format, parameters, scopes, and example responses for create a sticky. - [List all stickies](https://developers.plane.so/api-reference/sticky/list-stickies.md): List all stickies via Plane API. HTTP request format, parameters, scopes, and example responses for list all stickies. - [Retrieve a sticky](https://developers.plane.so/api-reference/sticky/get-sticky-detail.md): Retrieve a sticky via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve a sticky. - [Update a sticky](https://developers.plane.so/api-reference/sticky/update-sticky-detail.md): Update a sticky via Plane API. HTTP request format, parameters, scopes, and example responses for update a sticky. - [Delete a sticky](https://developers.plane.so/api-reference/sticky/delete-sticky.md): Delete a sticky via Plane API. HTTP request format, parameters, scopes, and example responses for delete a sticky. #### Workspace Features - [Overview](https://developers.plane.so/api-reference/workspace-features/overview.md): Plane Workspace Features API overview. Learn how to inspect and update workspace feature flags with the Plane API. - [Get workspace features](https://developers.plane.so/api-reference/workspace-features/get-workspace-features.md): Get workspace features via Plane API. HTTP request format, parameters, scopes, and example responses for get workspace features. - [Update workspace features](https://developers.plane.so/api-reference/workspace-features/update-workspace-features.md): Update workspace features via Plane API. HTTP request format, parameters, scopes, and example responses for update workspace features. #### Workspace Invitations - [Overview](https://developers.plane.so/api-reference/workspace-invitations/overview.md): Plane Workspace Invitations API overview. Learn how to create and manage workspace invitations with the Plane API. - [Create workspace invitation](https://developers.plane.so/api-reference/workspace-invitations/add-workspace-invitation.md): Create workspace invitation via Plane API. HTTP request format, parameters, scopes, and example responses for create workspace invitation. - [List workspace invitations](https://developers.plane.so/api-reference/workspace-invitations/list-workspace-invitations.md): List workspace invitations via Plane API. HTTP request format, parameters, scopes, and example responses for list workspace invitations. - [Get workspace invitation](https://developers.plane.so/api-reference/workspace-invitations/get-workspace-invitation-detail.md): Get workspace invitation via Plane API. HTTP request format, parameters, scopes, and example responses for get workspace invitation. - [Update workspace invitation](https://developers.plane.so/api-reference/workspace-invitations/update-workspace-invitation.md): Update workspace invitation via Plane API. HTTP request format, parameters, scopes, and example responses for update workspace invitation. - [Delete workspace invitation](https://developers.plane.so/api-reference/workspace-invitations/delete-workspace-invitation.md): Delete workspace invitation via Plane API. HTTP request format, parameters, scopes, and example responses for delete workspace invitation. #### Members - [Overview](https://developers.plane.so/api-reference/members/overview.md): Plane Members API overview. Learn about endpoints, request/response format, and how to work with members via REST API. - [Get all workspace members](https://developers.plane.so/api-reference/members/get-workspace-members.md): Get all workspace members via Plane API. HTTP request format, parameters, scopes, and example responses for get all workspace members. - [List all project members](https://developers.plane.so/api-reference/members/get-project-members.md): List all project members via Plane API. HTTP request format, parameters, scopes, and example responses for list all project members. - [Create project member](https://developers.plane.so/api-reference/members/add-project-member.md): Create project member via Plane API. HTTP request format, parameters, scopes, and example responses for create project member. - [Get project member](https://developers.plane.so/api-reference/members/get-project-member-detail.md): Get project member via Plane API. HTTP request format, parameters, scopes, and example responses for get project member. - [Update project member](https://developers.plane.so/api-reference/members/update-project-member.md): Update project member via Plane API. HTTP request format, parameters, scopes, and example responses for update project member. - [Delete project member](https://developers.plane.so/api-reference/members/delete-project-member.md): Delete project member via Plane API. HTTP request format, parameters, scopes, and example responses for delete project member. - [Remove workspace member](https://developers.plane.so/api-reference/members/remove-workspace-member.md): Remove workspace member via Plane API. HTTP request format, parameters, scopes, and example responses for remove workspace member. #### User - [Overview](https://developers.plane.so/api-reference/user/overview.md): Plane User API overview. Learn about endpoints, request/response format, and how to work with user via REST API. - [Retrieve current user](https://developers.plane.so/api-reference/user/get-current-user.md): Retrieve current user via Plane API. HTTP request format, parameters, scopes, and example responses for retrieve current user. #### IDP Group Sync - [Overview](https://developers.plane.so/api-reference/idp-group-sync/overview.md): Plane IDP Group Sync API overview. Learn about endpoints, request/response format, and how to manage IdP group sync configuration and mappings via REST API. - [Get group sync config](https://developers.plane.so/api-reference/idp-group-sync/get-group-sync-config.md): Get IdP group sync configuration via Plane API. HTTP request format, parameters, scopes, and example responses for get group sync config. - [Update group sync config](https://developers.plane.so/api-reference/idp-group-sync/update-group-sync-config.md): Update IdP group sync configuration via Plane API. HTTP request format, parameters, scopes, and example responses for update group sync config. - [List project group mappings](https://developers.plane.so/api-reference/idp-group-sync/list-project-mappings.md): List project group mappings via Plane API. HTTP request format, parameters, scopes, and example responses for list project group mappings. - [Create project group mapping](https://developers.plane.so/api-reference/idp-group-sync/create-project-mapping.md): Create a project group mapping via Plane API. HTTP request format, parameters, scopes, and example responses for create project group mapping. - [Get project group mapping](https://developers.plane.so/api-reference/idp-group-sync/get-project-mapping.md): Get a project group mapping via Plane API. HTTP request format, parameters, scopes, and example responses for get project group mapping. - [Update project group mapping](https://developers.plane.so/api-reference/idp-group-sync/update-project-mapping.md): Update a project group mapping via Plane API. HTTP request format, parameters, scopes, and example responses for update project group mapping. - [Delete project group mapping](https://developers.plane.so/api-reference/idp-group-sync/delete-project-mapping.md): Delete a project group mapping via Plane API. HTTP request format, parameters, scopes, and example responses for delete project group mapping. - [List workspace group mappings](https://developers.plane.so/api-reference/idp-group-sync/list-workspace-mappings.md): List workspace group mappings via Plane API. HTTP request format, parameters, scopes, and example responses for list workspace group mappings. - [Create workspace group mapping](https://developers.plane.so/api-reference/idp-group-sync/create-workspace-mapping.md): Create a workspace group mapping via Plane API. HTTP request format, parameters, scopes, and example responses for create workspace group mapping. - [Get workspace group mapping](https://developers.plane.so/api-reference/idp-group-sync/get-workspace-mapping.md): Get a workspace group mapping via Plane API. HTTP request format, parameters, scopes, and example responses for get workspace group mapping. - [Update workspace group mapping](https://developers.plane.so/api-reference/idp-group-sync/update-workspace-mapping.md): Update a workspace group mapping via Plane API. HTTP request format, parameters, scopes, and example responses for update workspace group mapping. - [Delete workspace group mapping](https://developers.plane.so/api-reference/idp-group-sync/delete-workspace-mapping.md): Delete a workspace group mapping via Plane API. HTTP request format, parameters, scopes, and example responses for delete workspace group mapping. ### Build on and extend Plane - [Agents Overview](https://developers.plane.so/dev-tools/agents/overview.md): Learn how to build AI agents that integrate with Plane workspaces, enabling automated task handling, intelligent responses, and seamless collaboration. - [Build a Plane App](https://developers.plane.so/dev-tools/build-plane-app/overview.md): Build and integrate an app with Plane using OAuth 2.0 authentication. Covers bot tokens, user tokens, webhooks, and API access for custom integrations. - [MCP server](https://developers.plane.so/dev-tools/mcp-server.md): Connect Cursor, VS Code, Claude, Windsurf, and Zed to your Plane workspace. Create work items, manage cycles, search across projects — all through natural language. - [Plane Compose](https://developers.plane.so/dev-tools/plane-compose.md): Define Plane projects, workflows, and work items in YAML files. Version control your project structure and sync bidirectionally with Plane using the command line. - [OpenAPI Specification](https://developers.plane.so/dev-tools/openapi-specification.md): Generate and access the OpenAPI 3.0 specification for the Plane public REST API using drf-spectacular. - [Webhooks](https://developers.plane.so/dev-tools/intro-webhooks.md): Configure webhooks for Plane. Setup real-time event notifications and automate workflows with webhook integrations. #### Agents - [Building an Agent](https://developers.plane.so/dev-tools/agents/building-an-agent.md): Step-by-step guide to creating a Plane agent, including OAuth setup, webhook handling, and activity creation. - [Agent best practices](https://developers.plane.so/dev-tools/agents/best-practices.md): Guidelines for building responsive, user-friendly Plane agents that provide a seamless experience. Covers error handling, response patterns, and user communication. - [Signals & Content Payload](https://developers.plane.so/dev-tools/agents/signals-content-payload.md): Detailed reference for activity signals and content payload structures in Plane agents. Includes signal types, payload formats, and content examples. #### Build Plane App - [Create an OAuth Application](https://developers.plane.so/dev-tools/build-plane-app/create-oauth-application.md): Register your Plane OAuth application to get Client ID and Secret. Configure setup URL, redirect URI, and webhook endpoints for your integration. - [Choose token flow](https://developers.plane.so/dev-tools/build-plane-app/choose-token-flow.md): Decide between Bot Token and User Token flows for your Plane app. Compare client credentials and authorization code grant types for different use cases. - [Handling webhooks](https://developers.plane.so/dev-tools/build-plane-app/webhooks.md): Receive and verify webhooks from Plane in your application. Learn about webhook headers, signature verification, event types, and payload handling. - [OAuth Scopes](https://developers.plane.so/dev-tools/build-plane-app/oauth-scopes.md): Complete reference of all OAuth scopes available when building a Plane app. Includes read and write permissions for projects, work items, cycles, modules, and more. - [Plane SDKs](https://developers.plane.so/dev-tools/build-plane-app/sdks.md): Official Plane SDKs for Node.js and Python. Get typed API clients and OAuth helpers to build Plane integrations faster. - [Plane app code examples](https://developers.plane.so/dev-tools/build-plane-app/examples.md): Full code examples for building Plane OAuth apps with Node.js (Express) and Python (Flask). Includes bot token flow, user token flow, and webhook handling. #### MCP Server - [Self-host MCP Server](https://developers.plane.so/dev-tools/mcp-server-self-host.md): Deploy your own Plane MCP Server with Docker Compose or Helm. Register an OAuth app, configure credentials, and point AI clients at your own instance. - [MCP Server Tool Reference](https://developers.plane.so/dev-tools/mcp-server-tools.md): Complete reference for all tools exposed by the Plane MCP Server — work items, projects, cycles, modules, worklogs, epics, milestones, and more. ### Other - [Add intake issue](https://developers.plane.so/api-reference/inbox-issue/add-inbox-issue.md): Create intake issue via Plane API. HTTP POST request format, required fields, and example responses. - [Create work item relation](https://developers.plane.so/api-reference/work-item-relations/create-work-item-relation.md): Create work item relation via Plane API. HTTP request format, parameters, scopes, and example responses for create work item relation. - [Delete intake issue](https://developers.plane.so/api-reference/inbox-issue/delete-inbox-issue.md): Delete an intake issue from the inbox via Plane API. Permanently removes the triaged submission. Returns 204 on success. - [Get intake issue detail](https://developers.plane.so/api-reference/inbox-issue/get-inbox-issue-detail.md): Get intake issue detail details via Plane API. Retrieve complete information for a specific resource. - [List intake issues](https://developers.plane.so/api-reference/inbox-issue/list-inbox-issues.md): List intake issues via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [List work item relations](https://developers.plane.so/api-reference/work-item-relations/list-work-item-relations.md): List work item relations via Plane API. HTTP request format, parameters, scopes, and example responses for list work item relations. - [One-click deploy](https://developers.plane.so/self-hosting/methods/one-click.md): Deploy Plane instantly with one-click installers on popular cloud providers. Quick setup on AWS, DigitalOcean, Render, and Railway. - [Overview](https://developers.plane.so/api-reference/inbox-issue/overview.md): Plane Inbox-Issue API overview. Learn about endpoints, request/response format, and how to work with inbox-issue via REST API. - [Overview](https://developers.plane.so/api-reference/work-item-relations/overview.md): Plane Work Item Relations API overview. Learn how to list, create, and remove work item relationships using the Plane API. - [Remove work item relation](https://developers.plane.so/api-reference/work-item-relations/remove-work-item-relation.md): Remove work item relation via Plane API. HTTP request format, parameters, scopes, and example responses for remove work item relation. - [Update intake issue detail](https://developers.plane.so/api-reference/inbox-issue/update-inbox-issue-detail.md): Update intake issue detail via Plane API. HTTP PATCH request format, editable fields, and example responses.