# Plane Developer Documentation > Plane is agentic work infrastructure: a shared system for projects, knowledge, and work intake, where people and supported AI agents can act with context, ownership, permissions, and history visible. This site is the developer documentation: build on Plane and run it yourself. 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. Every page is also available as Markdown: append `.md` to its URL or request it with `Accept: text/markdown`. ## When to use these docs Use these docs when you need to: - Call the REST API: `https://api.plane.so/api/v1/` on Plane Cloud, or `https:///api/v1/` when self-hosted. Authenticate with an `X-API-Key` header, or an OAuth bearer token for Plane apps. - Connect an AI client or agent to Plane through the MCP server. - Receive webhooks for events in a workspace. - Build a Plane app with OAuth 2.0 bot and user tokens. - Self-host Plane with Docker Compose, Kubernetes, or the Airgapped Edition. For how to use the product itself, see the [product documentation](https://docs.plane.so/llms.txt). ## Table of Contents ### 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. - [All Commercial Edition releases](https://developers.plane.so/self-hosting/all-releases.md): Every Plane Commercial Edition self-hosted release from 1.0.0 onward, with its release date and release notes. - [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. - [FIPS deployment](https://developers.plane.so/self-hosting/methods/fips-deployment.md): Deploy the FIPS variant of Plane Enterprise on a FIPS-enforcing host, including prerequisites, image list, and verification. - [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): Run Plane in a single Docker container with the All-in-One (AIO) image, for evaluations and proofs of concept. Not for production. - [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. - [Kubernetes Best Practices](https://developers.plane.so/self-hosting/govern/kubernetes-best-practices.md): How to configure PodDisruptionBudgets and spread Plane's pods across availability zones and nodes 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. Set up HTTPS with Let's Encrypt or bring your own certificate from a corporate CA on Docker Compose, airgapped and Kubernetes deployments. - [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 sensitive data scanning](https://developers.plane.so/self-hosting/govern/sensitive-data-scanning.md): Deploy Argus, Plane's sensitive data and PII scanner, on Kubernetes, Docker Compose, Docker AIO, Podman, Coolify, Portainer and airgapped installs. Covers the fingerprint secret, routing, database access and troubleshooting. - [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 OpenTelemetry](https://developers.plane.so/self-hosting/govern/opentelemetry.md): Export traces, metrics, and logs from a self-hosted Plane instance to any OpenTelemetry-compatible backend using the plane-enterprise Helm chart. - [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. - [Use IRSA or EKS Pod Identity for S3 storage](https://developers.plane.so/self-hosting/govern/aws-workload-identity.md): Configure Plane on Amazon EKS to reach its S3 bucket with an IAM role instead of static access keys, using IRSA or EKS Pod Identity. - [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. - [Microsoft Teams integration](https://developers.plane.so/self-hosting/govern/integrations/ms-teams.md): Configure the Microsoft Teams integration on a self-hosted Plane instance. - [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 - [How self-hosted licensing works](https://developers.plane.so/self-hosting/manage/manage-licenses/overview.md): Understand where Plane licenses activate, what a license key is bound to, how your instance stays licensed, and what happens when it cannot reach Plane. - [Activate Pro and Business licenses](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-pro-and-business.md): Activate a Plane Pro or Business license key on a workspace in the self-hosted Commercial Edition, using a key from the Prime portal. - [Activate Enterprise Grid license](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-enterprise.md): Activate an Enterprise Grid license on a self-hosted Plane instance from God mode, so every workspace on the instance gets Enterprise features. - [Activate Enterprise Grid on Airgapped Edition](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-airgapped-enterprise.md): Activate an Enterprise Grid license on an airgapped Plane instance from God mode, using an offline license file downloaded from the Prime portal. - [Manage your license](https://developers.plane.so/self-hosting/manage/manage-licenses/manage-your-license.md): Sync a plan change, add or remove seats, change plan, reach the billing portal, delink a license key, and move a licensed Plane instance to another server. ### 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): Every Plane self-hosted license error by the message you see, with the cause and the fix, for Pro, Business, Enterprise Grid, and Airgapped. - [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 v2](https://developers.plane.so/api-reference/v2/introduction.md): Introduction to the Plane REST API v2 — base URL, authentication, and a first request to verify your API key. - [Authentication](https://developers.plane.so/api-reference/v2/authentication.md): Authenticate Plane API v2 requests with an X-Api-Key personal access token or an OAuth 2.0 bearer token, and understand the global and fine-grained scope model. - [Pagination](https://developers.plane.so/api-reference/v2/pagination.md): How Plane API v2 paginates list endpoints. Offset pagination by default, opt-in cursor pagination, the response envelopes for each, and how to page through a full result set. - [Filtering and ordering](https://developers.plane.so/api-reference/v2/filtering-and-ordering.md): How Plane API v2 list queries work. Exact, membership, null and range filters, relation filters by id, free-text search, and semantic ordering with order_by. - [Sparse fields](https://developers.plane.so/api-reference/v2/sparse-fields.md): Use ?fields= to return only the keys you need from the Plane v2 REST API. Omit semantics, the all token, deferred and detail-only fields, and how it composes with ?expand=. - [Expanding relations](https://developers.plane.so/api-reference/v2/expanding-relations.md): How ?expand= works in Plane API v2. Sparse reads, the separate-key expansion contract, which resources support expansion, and the exact shape of each expanded object. - [Errors](https://developers.plane.so/api-reference/v2/errors.md): The Plane API v2 error model — RFC 9457 problem+json responses, the full error code table, validation error arrays, rate limiting, and mode conflicts. - [Migrating from v1](https://developers.plane.so/api-reference/v2/migrating-from-v1.md): A practical guide to moving an integration from the Plane REST API v1 to v2. Path and header changes, PATCH-only writes, RFC 9457 errors, sparse reads, the new pagination envelope, renamed fields, and what v2 does not cover yet. ### Core Resources #### States (Project) - [States overview](https://developers.plane.so/api-reference/v2/states/overview.md): The Plane API v2 state object. Attributes, workflow groups, the default and triage states, and how states gate work item transitions. - [List states](https://developers.plane.so/api-reference/v2/states/list-states.md): List the workflow states in a Plane project with the v2 REST API. Filters, search, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a state](https://developers.plane.so/api-reference/v2/states/get-state.md): Retrieve a single workflow state from a Plane project with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a state](https://developers.plane.so/api-reference/v2/states/create-state.md): Create a workflow state in a Plane project with the v2 REST API. Body parameters, workflow groups, OAuth scopes, error codes, and code examples. - [Update a state](https://developers.plane.so/api-reference/v2/states/update-state.md): Update a workflow state in a Plane project with the v2 REST API. Partial PATCH semantics, body parameters, the default state flag, OAuth scopes, error codes, and code examples. - [Delete a state](https://developers.plane.so/api-reference/v2/states/delete-state.md): Delete a workflow state from a Plane project with the v2 REST API. Protected default states, states holding work items, OAuth scopes, error codes, and code examples. - [Upsert a state](https://developers.plane.so/api-reference/v2/states/upsert-state.md): Upsert a state with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create states](https://developers.plane.so/api-reference/v2/states/bulk-create-states.md): Bulk create up to 50 states in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update states](https://developers.plane.so/api-reference/v2/states/bulk-update-states.md): Bulk update up to 50 states in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete states](https://developers.plane.so/api-reference/v2/states/bulk-delete-states.md): Bulk delete up to 50 states in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. #### States (Workspace) - [Workspace states overview](https://developers.plane.so/api-reference/v2/workspace-states/overview.md): The Plane API v2 workspace state object. The workspace catalog of work item states under workspace governance, the read-only cross-project view in other workspaces, the triage exclusion, and the endpoints. - [List workspace states](https://developers.plane.so/api-reference/v2/workspace-states/list-workspace-states.md): List work item states at the workspace level with the Plane v2 REST API. The governance catalog, or every project's states in an ungoverned workspace. Filters, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workspace state](https://developers.plane.so/api-reference/v2/workspace-states/get-workspace-state.md): Retrieve one work item state through the workspace-level states route with the Plane v2 REST API. Catalog states under workspace governance, project states otherwise. Path parameters, OAuth scopes, error codes, and code examples. - [Create a workspace state](https://developers.plane.so/api-reference/v2/workspace-states/create-workspace-state.md): Create a catalog work item state in a workspace with governance turned on, with the Plane v2 REST API. Body parameters, name rules, workflow placement, OAuth scopes, error codes, and code examples. - [Update a workspace state](https://developers.plane.so/api-reference/v2/workspace-states/update-workspace-state.md): Update a catalog work item state in a workspace with governance turned on, with the Plane v2 REST API. Partial PATCH semantics, body parameters, name rules, OAuth scopes, error codes, and code examples. - [Delete a workspace state](https://developers.plane.so/api-reference/v2/workspace-states/delete-workspace-state.md): Delete a catalog work item state in a workspace with governance turned on, with the Plane v2 REST API. States still used by a workflow or by work items, the triage state, OAuth scopes, error codes, and code examples. #### Labels - [Labels overview](https://developers.plane.so/api-reference/v2/labels/overview.md): The Plane API v2 label object. Attributes, nested labels via parent_id, name uniqueness within a project, and the label endpoints. - [List labels](https://developers.plane.so/api-reference/v2/labels/list-labels.md): List the labels in a Plane project with the v2 REST API. Filters, search, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a label](https://developers.plane.so/api-reference/v2/labels/get-label.md): Retrieve a single label from a Plane project with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a label](https://developers.plane.so/api-reference/v2/labels/create-label.md): Create a label in a Plane project with the v2 REST API. Body parameters, nesting with parent_id, name uniqueness, OAuth scopes, error codes, and code examples. - [Update a label](https://developers.plane.so/api-reference/v2/labels/update-label.md): Update a label in a Plane project with the v2 REST API. Partial PATCH semantics, body parameters, OAuth scopes, error codes, and code examples. - [Delete a label](https://developers.plane.so/api-reference/v2/labels/delete-label.md): Delete a label from a Plane project with the v2 REST API. Path parameters, what happens to tagged work items, OAuth scopes, error codes, and code examples. - [Upsert a label](https://developers.plane.so/api-reference/v2/labels/upsert-label.md): Upsert a label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create labels](https://developers.plane.so/api-reference/v2/labels/bulk-create-labels.md): Bulk create up to 50 labels in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update labels](https://developers.plane.so/api-reference/v2/labels/bulk-update-labels.md): Bulk update up to 50 labels in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete labels](https://developers.plane.so/api-reference/v2/labels/bulk-delete-labels.md): Bulk delete up to 50 labels in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. #### Cycles - [Cycles overview](https://developers.plane.so/api-reference/v2/cycles/overview.md): The Plane API v2 cycle object. Attributes, start and end dates, time zones, cycle ownership, and the endpoints for managing project cycles. - [List cycles](https://developers.plane.so/api-reference/v2/cycles/list-cycles.md): List the cycles in a Plane project with the v2 REST API. Filters, search, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a cycle](https://developers.plane.so/api-reference/v2/cycles/get-cycle.md): Retrieve a single Plane cycle by id with the v2 REST API. Path parameters, response fields, OAuth scopes, error codes, and code examples. - [Create a cycle](https://developers.plane.so/api-reference/v2/cycles/create-cycle.md): Create a time-boxed cycle in a Plane project with the v2 REST API. Body parameters, dates and time zones, OAuth scopes, error codes, and code examples. - [Update a cycle](https://developers.plane.so/api-reference/v2/cycles/update-cycle.md): Partially update a Plane cycle with the v2 REST API. PATCH body parameters, date and time zone changes, OAuth scopes, error codes, and code examples. - [Delete a cycle](https://developers.plane.so/api-reference/v2/cycles/delete-cycle.md): Delete a Plane cycle with the v2 REST API. Path parameters, the 204 response, OAuth scopes, error codes, and code examples. - [Upsert a cycle](https://developers.plane.so/api-reference/v2/cycles/upsert-cycle.md): Upsert a cycle with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create cycles](https://developers.plane.so/api-reference/v2/cycles/bulk-create-cycles.md): Bulk create up to 50 cycles in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update cycles](https://developers.plane.so/api-reference/v2/cycles/bulk-update-cycles.md): Bulk update up to 50 cycles in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete cycles](https://developers.plane.so/api-reference/v2/cycles/bulk-delete-cycles.md): Bulk delete up to 50 cycles in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Add or remove cycle work items](https://developers.plane.so/api-reference/v2/cycles/manage-cycle-work-items.md): Add or remove cycle work items with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Transfer work items between cycles](https://developers.plane.so/api-reference/v2/cycles/transfer-cycle-work-items.md): Transfer work items between cycles with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Archive a cycle](https://developers.plane.so/api-reference/v2/cycles/archive-cycle.md): Archive a Plane cycle with the v2 REST API. Bodyless POST, the end_date rule, idempotent repeats, list visibility, OAuth scopes, error codes, and code examples. - [Unarchive a cycle](https://developers.plane.so/api-reference/v2/cycles/unarchive-cycle.md): Restore an archived Plane cycle with the v2 REST API. Bodyless POST, clearing archived_at, idempotent repeats, OAuth scopes, error codes, and code examples. #### Modules - [Modules overview](https://developers.plane.so/api-reference/v2/modules/overview.md): The Plane API v2 module object. Attributes, the module status enum, lead and member handling, name uniqueness, and how modules differ from v1. - [List modules](https://developers.plane.so/api-reference/v2/modules/list-modules.md): List the modules in a Plane project with the v2 REST API. Filter by status, lead, and external id, search by name, order, paginate, and handle errors. - [Get a module](https://developers.plane.so/api-reference/v2/modules/get-module.md): Retrieve a single module from a Plane project with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a module](https://developers.plane.so/api-reference/v2/modules/create-module.md): Create a module in a Plane project with the v2 REST API. Body parameters, the module status enum, lead validation, OAuth scopes, error codes, and code examples. - [Update a module](https://developers.plane.so/api-reference/v2/modules/update-module.md): Partially update a module in a Plane project with the v2 REST API. PATCH body parameters, status transitions, lead validation, OAuth scopes, and error codes. - [Delete a module](https://developers.plane.so/api-reference/v2/modules/delete-module.md): Delete a module from a Plane project with the v2 REST API. Path parameters, what happens to the module's work items, OAuth scopes, error codes, and code examples. - [Upsert a module](https://developers.plane.so/api-reference/v2/modules/upsert-module.md): Upsert a module with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create modules](https://developers.plane.so/api-reference/v2/modules/bulk-create-modules.md): Bulk create up to 50 modules in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update modules](https://developers.plane.so/api-reference/v2/modules/bulk-update-modules.md): Bulk update up to 50 modules in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete modules](https://developers.plane.so/api-reference/v2/modules/bulk-delete-modules.md): Bulk delete up to 50 modules in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Add or remove module work items](https://developers.plane.so/api-reference/v2/modules/manage-module-work-items.md): Add or remove module work items with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Archive a module](https://developers.plane.so/api-reference/v2/modules/archive-module.md): Archive a Plane module with the v2 REST API. Bodyless POST, the status rule, idempotent repeats, list visibility, OAuth scopes, error codes, and code examples. - [Unarchive a module](https://developers.plane.so/api-reference/v2/modules/unarchive-module.md): Restore an archived Plane module with the v2 REST API. Bodyless POST, clearing archived_at, idempotent repeats, OAuth scopes, error codes, and code examples. #### Milestones - [Milestones overview](https://developers.plane.so/api-reference/v2/milestones/overview.md): The Plane API v2 milestone object. Attributes, endpoints, OAuth scopes and behavior. - [List milestones](https://developers.plane.so/api-reference/v2/milestones/list-milestones.md): List milestones with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a milestone](https://developers.plane.so/api-reference/v2/milestones/get-milestone.md): Read a milestone with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a milestone](https://developers.plane.so/api-reference/v2/milestones/create-milestone.md): Create a milestone with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a milestone](https://developers.plane.so/api-reference/v2/milestones/update-milestone.md): Update a milestone with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a milestone](https://developers.plane.so/api-reference/v2/milestones/delete-milestone.md): Delete a milestone with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Upsert a milestone](https://developers.plane.so/api-reference/v2/milestones/upsert-milestone.md): Upsert a milestone with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create milestones](https://developers.plane.so/api-reference/v2/milestones/bulk-create-milestones.md): Bulk create up to 50 milestones in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update milestones](https://developers.plane.so/api-reference/v2/milestones/bulk-update-milestones.md): Bulk update up to 50 milestones in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete milestones](https://developers.plane.so/api-reference/v2/milestones/bulk-delete-milestones.md): Bulk delete up to 50 milestones in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Add or remove milestone work items](https://developers.plane.so/api-reference/v2/milestones/manage-milestone-work-items.md): Add or remove milestone work items with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Estimates - [Estimates overview](https://developers.plane.so/api-reference/v2/estimates/overview.md): The Plane API v2 estimate object. Attributes, endpoints, OAuth scopes and behavior. - [List estimates](https://developers.plane.so/api-reference/v2/estimates/list-estimates.md): List estimates with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an estimate](https://developers.plane.so/api-reference/v2/estimates/get-estimate.md): Read an estimate with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an estimate](https://developers.plane.so/api-reference/v2/estimates/create-estimate.md): Create an estimate with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an estimate](https://developers.plane.so/api-reference/v2/estimates/update-estimate.md): Update an estimate with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an estimate](https://developers.plane.so/api-reference/v2/estimates/delete-estimate.md): Delete an estimate with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Upsert an estimate](https://developers.plane.so/api-reference/v2/estimates/upsert-estimate.md): Upsert an estimate with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create estimates](https://developers.plane.so/api-reference/v2/estimates/bulk-create-estimates.md): Bulk create up to 50 estimates in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update estimates](https://developers.plane.so/api-reference/v2/estimates/bulk-update-estimates.md): Bulk update up to 50 estimates in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete estimates](https://developers.plane.so/api-reference/v2/estimates/bulk-delete-estimates.md): Bulk delete up to 50 estimates in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. #### Estimate Points - [Estimate points overview](https://developers.plane.so/api-reference/v2/estimate-points/overview.md): The Plane API v2 estimate point object. Attributes, endpoints, OAuth scopes and behavior. - [List estimate points](https://developers.plane.so/api-reference/v2/estimate-points/list-estimate-points.md): List estimate points with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an estimate point](https://developers.plane.so/api-reference/v2/estimate-points/get-estimate-point.md): Read an estimate point with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an estimate point](https://developers.plane.so/api-reference/v2/estimate-points/create-estimate-point.md): Create an estimate point with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an estimate point](https://developers.plane.so/api-reference/v2/estimate-points/update-estimate-point.md): Update an estimate point with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an estimate point](https://developers.plane.so/api-reference/v2/estimate-points/delete-estimate-point.md): Delete an estimate point with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Upsert an estimate point](https://developers.plane.so/api-reference/v2/estimate-points/upsert-estimate-point.md): Upsert an estimate point with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create estimate points](https://developers.plane.so/api-reference/v2/estimate-points/bulk-create-estimate-points.md): Bulk create up to 50 estimate points in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update estimate points](https://developers.plane.so/api-reference/v2/estimate-points/bulk-update-estimate-points.md): Bulk update up to 50 estimate points in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete estimate points](https://developers.plane.so/api-reference/v2/estimate-points/bulk-delete-estimate-points.md): Bulk delete up to 50 estimate points in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. #### Intake - [Intake work items overview](https://developers.plane.so/api-reference/v2/intake-work-items/overview.md): The Plane API v2 intake work item object. Attributes, endpoints, OAuth scopes and behavior. - [List intake work items](https://developers.plane.so/api-reference/v2/intake-work-items/list-intake-work-items.md): List intake work items with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an intake work item](https://developers.plane.so/api-reference/v2/intake-work-items/get-intake-work-item.md): Read an intake work item with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an intake work item](https://developers.plane.so/api-reference/v2/intake-work-items/create-intake-work-item.md): Create an intake work item with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an intake work item](https://developers.plane.so/api-reference/v2/intake-work-items/update-intake-work-item.md): Update an intake work item with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an intake work item](https://developers.plane.so/api-reference/v2/intake-work-items/delete-intake-work-item.md): Delete an intake work item with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. ### Work Item Resources #### Work Items - [Work items overview](https://developers.plane.so/api-reference/v2/work-items/overview.md): The Plane API v2 work item object. Sparse id-based reads, the PROJ-123 identifier, custom fields, human-readable write inputs, expandable relations, and every work item endpoint. - [List work items](https://developers.plane.so/api-reference/v2/work-items/list-work-items.md): List work items in a Plane project with the v2 REST API. Filters, search, ordering, offset and cursor pagination, expandable relations, OAuth scopes, and code examples. - [List work items across a workspace](https://developers.plane.so/api-reference/v2/work-items/list-workspace-work-items.md): List workspace work items with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a work item](https://developers.plane.so/api-reference/v2/work-items/get-work-item.md): Retrieve a single work item by UUID or identifier with the Plane v2 REST API. Path parameters, expandable relations, custom fields, OAuth scopes, error codes, and code examples. - [Get a work item by identifier](https://developers.plane.so/api-reference/v2/work-items/get-work-item-by-identifier.md): Look up a Plane work item by its PROJ-123 human key across a workspace, without knowing the project UUID. Path parameters, expandable relations, OAuth scopes, errors, and code examples. - [Create a work item](https://developers.plane.so/api-reference/v2/work-items/create-work-item.md): Create a work item in a Plane project with the v2 REST API. Body parameters, id and human-readable inputs, priority values, OAuth scopes, error codes, and code examples. - [Update a work item](https://developers.plane.so/api-reference/v2/work-items/update-work-item.md): Partially update a Plane work item with the v2 REST API. PATCH semantics, id and human-readable inputs, replacing assignees and labels, workflow rules, scopes, errors, and code examples. - [Delete a work item](https://developers.plane.so/api-reference/v2/work-items/delete-work-item.md): Delete a work item in a Plane project with the v2 REST API. Soft-delete behavior, the 204 response, when to archive instead, OAuth scopes, error codes, and code examples. - [Upsert a work item](https://developers.plane.so/api-reference/v2/work-items/upsert-work-item.md): Upsert a work item with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create work items](https://developers.plane.so/api-reference/v2/work-items/bulk-create-work-items.md): Bulk create up to 50 work items in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update work items](https://developers.plane.so/api-reference/v2/work-items/bulk-update-work-items.md): Bulk update up to 50 work items in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete work items](https://developers.plane.so/api-reference/v2/work-items/bulk-delete-work-items.md): Bulk delete up to 50 work items in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Archive a work item](https://developers.plane.so/api-reference/v2/work-items/archive-work-item.md): Archive a Plane work item with the v2 REST API. Bodyless POST, the archived_at timestamp, visibility of archived items, OAuth scopes, error codes, and code examples. - [Unarchive a work item](https://developers.plane.so/api-reference/v2/work-items/unarchive-work-item.md): Restore an archived Plane work item with the v2 REST API. Bodyless POST, clearing archived_at, idempotent behavior, OAuth scopes, error codes, and code examples. #### Comments - [Work item comments overview](https://developers.plane.so/api-reference/v2/work-item-comments/overview.md): The Plane API v2 work item comment object. HTML bodies, INTERNAL and EXTERNAL access, the sub-resource path, and why comments never conflict. - [List comments](https://developers.plane.so/api-reference/v2/work-item-comments/list-comments.md): List the comments on a Plane work item with the v2 REST API. Access filter, external id lookup, search, ordering, pagination, scopes, and code examples. - [Get a comment](https://developers.plane.so/api-reference/v2/work-item-comments/get-comment.md): Retrieve a single comment on a Plane work item with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a comment](https://developers.plane.so/api-reference/v2/work-item-comments/create-comment.md): Post a comment on a Plane work item with the v2 REST API. HTML bodies, INTERNAL and EXTERNAL access, external ids, OAuth scopes, errors, and code examples. - [Update a comment](https://developers.plane.so/api-reference/v2/work-item-comments/update-comment.md): Edit a comment on a Plane work item with the v2 REST API. Partial PATCH body, access changes, edited_at, OAuth scopes, error codes, and code examples. - [Delete a comment](https://developers.plane.so/api-reference/v2/work-item-comments/delete-comment.md): Delete a comment from a Plane work item with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Upsert a comment](https://developers.plane.so/api-reference/v2/work-item-comments/upsert-comment.md): Upsert a comment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create comments](https://developers.plane.so/api-reference/v2/work-item-comments/bulk-create-comments.md): Bulk create up to 50 comments in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update comments](https://developers.plane.so/api-reference/v2/work-item-comments/bulk-update-comments.md): Bulk update up to 50 comments in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk delete comments](https://developers.plane.so/api-reference/v2/work-item-comments/bulk-delete-comments.md): Bulk delete up to 50 comments in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. #### Attachments - [Work item attachments overview](https://developers.plane.so/api-reference/v2/work-item-attachments/overview.md): The Plane API v2 attachment object. Attributes, endpoints, OAuth scopes and behavior. - [List attachments](https://developers.plane.so/api-reference/v2/work-item-attachments/list-attachments.md): List attachments with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an attachment](https://developers.plane.so/api-reference/v2/work-item-attachments/get-attachment.md): Read an attachment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a work item attachment upload](https://developers.plane.so/api-reference/v2/work-item-attachments/create-attachment-upload.md): Create an attachment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an attachment](https://developers.plane.so/api-reference/v2/work-item-attachments/delete-attachment.md): Delete an attachment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Confirm a work item attachment upload](https://developers.plane.so/api-reference/v2/work-item-attachments/confirm-attachment-upload.md): Update an attachment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Links - [Work item links overview](https://developers.plane.so/api-reference/v2/work-item-links/overview.md): The Plane API v2 link object. Attributes, endpoints, OAuth scopes and behavior. - [List links](https://developers.plane.so/api-reference/v2/work-item-links/list-links.md): List links with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a link](https://developers.plane.so/api-reference/v2/work-item-links/get-link.md): Read a link with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a link](https://developers.plane.so/api-reference/v2/work-item-links/create-link.md): Create a link with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a link](https://developers.plane.so/api-reference/v2/work-item-links/update-link.md): Update a link with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a link](https://developers.plane.so/api-reference/v2/work-item-links/delete-link.md): Delete a link with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Pages - [Work item pages overview](https://developers.plane.so/api-reference/v2/work-item-pages/overview.md): The Plane API v2 work item page object, the link between a work item and a page. Attributes, which pages you can link, endpoints, and differences from v1. - [List work item pages](https://developers.plane.so/api-reference/v2/work-item-pages/list-work-item-pages.md): List the pages linked to a Plane work item with the v2 REST API. The page_id filter, ordering, pagination, sparse fields, expand, OAuth scopes, error codes, and code examples. - [Get a work item page](https://developers.plane.so/api-reference/v2/work-item-pages/get-work-item-page.md): Retrieve one page link on a Plane work item with the v2 REST API. The link id, expand page, sparse fields, OAuth scopes, error codes, and code examples. - [Create a work item page](https://developers.plane.so/api-reference/v2/work-item-pages/create-work-item-page.md): Link a page to a Plane work item with the v2 REST API. Project and wiki pages, duplicate links, activity, OAuth scopes, error codes, and code examples. - [Delete a work item page](https://developers.plane.so/api-reference/v2/work-item-pages/delete-work-item-page.md): Unlink a page from a Plane work item with the v2 REST API. The link id, what stays untouched, OAuth scopes, error codes, and code examples. #### Activities - [Work item activities overview](https://developers.plane.so/api-reference/v2/work-item-activities/overview.md): The Plane API v2 activity object. Attributes, endpoints, OAuth scopes and behavior. - [List activities](https://developers.plane.so/api-reference/v2/work-item-activities/list-activities.md): List activities with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an activity](https://developers.plane.so/api-reference/v2/work-item-activities/get-activity.md): Read an activity with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Worklogs - [Work item worklogs overview](https://developers.plane.so/api-reference/v2/work-item-worklogs/overview.md): The Plane API v2 worklog object. Attributes, endpoints, OAuth scopes and behavior. - [List worklogs](https://developers.plane.so/api-reference/v2/work-item-worklogs/list-worklogs.md): List worklogs with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get the project worklog summary](https://developers.plane.so/api-reference/v2/work-item-worklogs/get-project-worklog-summary.md): Get the project worklog summary with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a worklog](https://developers.plane.so/api-reference/v2/work-item-worklogs/get-worklog.md): Read a worklog with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a worklog](https://developers.plane.so/api-reference/v2/work-item-worklogs/create-worklog.md): Create a worklog with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a worklog](https://developers.plane.so/api-reference/v2/work-item-worklogs/update-worklog.md): Update a worklog with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a worklog](https://developers.plane.so/api-reference/v2/work-item-worklogs/delete-worklog.md): Delete a worklog with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Votes - [Work item votes overview](https://developers.plane.so/api-reference/v2/work-item-votes/overview.md): The Plane API v2 work item vote object. Upvotes and downvotes, one vote per user per work item, idempotent cast and retract keyed by the caller, permissions, and how the API differs from v1. - [List work item votes](https://developers.plane.so/api-reference/v2/work-item-votes/list-work-item-votes.md): List the upvotes and downvotes on a Plane work item with the v2 REST API. Path parameters, pagination, expand, OAuth scopes, error codes, and code examples. - [Cast a vote on a work item](https://developers.plane.so/api-reference/v2/work-item-votes/cast-work-item-vote.md): Upvote or downvote a Plane work item with the v2 REST API. The vote body, change-in-place behavior, permissions, OAuth scopes, error codes, and code examples. - [Retract your vote on a work item](https://developers.plane.so/api-reference/v2/work-item-votes/retract-work-item-vote.md): Remove your upvote or downvote from a Plane work item with the v2 REST API. Idempotent 204 behavior, permissions, OAuth scopes, error codes, and code examples. #### Recurring Work Items - [Recurring work items overview](https://developers.plane.so/api-reference/v2/recurring-work-items/overview.md): The Plane API v2 recurring work item object. A project schedule plus the blueprint it copies on every run, the schedule fields and their validation, run timing, pausing, the plan gate, and behavior under workspace governance. - [List recurring work items](https://developers.plane.so/api-reference/v2/recurring-work-items/list-recurring-work-items.md): List the recurring work item schedules in a Plane project with the v2 REST API. Filters by interval, dates, and status, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a recurring work item](https://developers.plane.so/api-reference/v2/recurring-work-items/get-recurring-work-item.md): Retrieve one recurring work item schedule and its blueprint from a Plane project with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a recurring work item](https://developers.plane.so/api-reference/v2/recurring-work-items/create-recurring-work-item.md): Create a recurring work item schedule in a Plane project with the v2 REST API. The flat blueprint fields, the schedule fields and their validation, run timing, OAuth scopes, error codes, and code examples. - [Update a recurring work item](https://developers.plane.so/api-reference/v2/recurring-work-items/update-recurring-work-item.md): Update a recurring work item schedule or its blueprint in a Plane project with the v2 REST API. Partial PATCH semantics, rescheduling, why enabled can't be changed, OAuth scopes, error codes, and code examples. - [Delete a recurring work item](https://developers.plane.so/api-reference/v2/recurring-work-items/delete-recurring-work-item.md): Delete a recurring work item schedule and its blueprint from a Plane project with the v2 REST API. What is removed and what stays, OAuth scopes, error codes, and code examples. ### Work Item Types (Project) - [Work item type modes](https://developers.plane.so/api-reference/v2/work-item-type-modes.md): A Plane workspace manages work item types at either the project level or the workspace level. How to detect the mode, which endpoints each mode uses, and why the wrong surface returns 409. #### Work Item Types - [Work item types overview](https://developers.plane.so/api-reference/v2/work-item-types/overview.md): The Plane API v2 project work item type object. Attributes, the project-mode lifecycle from enable to schema, endpoints, and the mode conflict rules. - [List work item types](https://developers.plane.so/api-reference/v2/work-item-types/list-work-item-types.md): List a Plane project's work item types with the v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a work item type](https://developers.plane.so/api-reference/v2/work-item-types/get-work-item-type.md): Retrieve a single project work item type from Plane with the v2 REST API. Path parameters, response attributes, OAuth scopes, error codes, and code examples. - [Get a work item type schema](https://developers.plane.so/api-reference/v2/work-item-types/get-work-item-type-schema.md): Discover the fields and custom properties a Plane work item type accepts with the v2 REST API. The include parameter, fields and custom_fields shapes, OAuth scopes, error codes, and code examples. - [Create a work item type](https://developers.plane.so/api-reference/v2/work-item-types/create-work-item-type.md): Create a project-level work item type in Plane with the v2 REST API. Body parameters, project mode requirements, OAuth scopes, error codes, and code examples. - [Update a work item type](https://developers.plane.so/api-reference/v2/work-item-types/update-work-item-type.md): Update a project work item type in Plane with the v2 REST API. Partial PATCH semantics, body parameters, project mode requirements, OAuth scopes, error codes, and code examples. - [Delete a work item type](https://developers.plane.so/api-reference/v2/work-item-types/delete-work-item-type.md): Delete a project work item type in Plane with the v2 REST API. Protected deletes, project mode requirements, OAuth scopes, error codes, and code examples. - [Enable work item types](https://developers.plane.so/api-reference/v2/work-item-types/enable-work-item-types.md): Turn work item types on for a Plane project with the v2 REST API. The first call in the project-mode lifecycle, the provisioned default type, OAuth scopes, error codes, and code examples. - [Import work item types](https://developers.plane.so/api-reference/v2/work-item-types/import-work-item-types.md): Import workspace-level work item types into a Plane project with the v2 REST API. Body parameters, mode requirements, OAuth scopes, error codes, and code examples. - [Mark a work item type as default](https://developers.plane.so/api-reference/v2/work-item-types/mark-default-work-item-type.md): Promote a Plane project work item type to the project default with the v2 REST API. Single-request promotion in either mode, OAuth scopes, error codes, and code examples. #### Properties - [Work item properties overview](https://developers.plane.so/api-reference/v2/work-item-properties/overview.md): The Plane API v2 project work item property object. Attributes, the property_type and relation_type reference, default values, inline options, and the endpoints that manage custom fields. - [List work item properties](https://developers.plane.so/api-reference/v2/work-item-properties/list-work-item-properties.md): List the custom work item properties defined in a Plane project with the v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a work item property](https://developers.plane.so/api-reference/v2/work-item-properties/get-work-item-property.md): Retrieve a single custom work item property from a Plane project with the v2 REST API. Path parameters, the resolved options array, OAuth scopes, error codes, and code examples. - [Create a work item property](https://developers.plane.so/api-reference/v2/work-item-properties/create-work-item-property.md): Define a custom work item property in a Plane project with the v2 REST API. property_type and relation_type enums, inline options, default values, OAuth scopes, error codes, and code examples. - [Update a work item property](https://developers.plane.so/api-reference/v2/work-item-properties/update-work-item-property.md): Update a custom work item property in a Plane project with the v2 REST API. Partial PATCH semantics, default values, inline options, is_active, OAuth scopes, error codes, and code examples. - [Delete a work item property](https://developers.plane.so/api-reference/v2/work-item-properties/delete-work-item-property.md): Delete a custom work item property from a Plane project with the v2 REST API. Path parameters, the deactivate alternative, OAuth scopes, error codes, and code examples. #### Property Options - [Property options overview](https://developers.plane.so/api-reference/v2/work-item-property-options/overview.md): The Plane API v2 work item property option object. Attributes, the default option, sort order, how options relate to OPTION-typed properties, and project-mode write rules. - [List property options](https://developers.plane.so/api-reference/v2/work-item-property-options/list-property-options.md): List the selectable options of an OPTION-typed work item property in a Plane project with the v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a property option](https://developers.plane.so/api-reference/v2/work-item-property-options/get-property-option.md): Retrieve a single option of an OPTION-typed work item property in a Plane project with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a property option](https://developers.plane.so/api-reference/v2/work-item-property-options/create-property-option.md): Add a selectable option to an OPTION-typed work item property in a Plane project with the v2 REST API. Body parameters, the default option, project-mode 409s, OAuth scopes, and code examples. - [Update a property option](https://developers.plane.so/api-reference/v2/work-item-property-options/update-property-option.md): Update an option of an OPTION-typed work item property in a Plane project with the v2 REST API. Partial PATCH semantics, body parameters, the default option, project-mode 409s, and code examples. - [Delete a property option](https://developers.plane.so/api-reference/v2/work-item-property-options/delete-property-option.md): Delete an option from an OPTION-typed work item property in a Plane project with the v2 REST API. Path parameters, the 204 response, project-mode 409s, OAuth scopes, and code examples. #### Type Properties - [Type properties overview](https://developers.plane.so/api-reference/v2/work-item-type-properties/overview.md): How a Plane work item type exposes custom properties in API v2 — the attach/detach link, the property object reads return, and mode conflicts. - [List type properties](https://developers.plane.so/api-reference/v2/work-item-type-properties/list-type-properties.md): List the custom properties attached to a Plane work item type with the v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a type property](https://developers.plane.so/api-reference/v2/work-item-type-properties/get-type-property.md): Retrieve one custom property through a Plane work item type with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Attach a property to a type](https://developers.plane.so/api-reference/v2/work-item-type-properties/attach-type-property.md): Attach existing custom properties to a Plane work item type with the v2 REST API. Body parameters, OAuth scopes, mode conflicts, error codes, and code examples. - [Detach a property from a type](https://developers.plane.so/api-reference/v2/work-item-type-properties/detach-type-property.md): Detach a custom property from a Plane work item type with the v2 REST API. Path parameters, OAuth scopes, mode conflicts, error codes, and code examples. ### Work Item Types (Workspace) #### Work Item Types - [Workspace work item types overview](https://developers.plane.so/api-reference/v2/workspace-work-item-types/overview.md): The Plane API v2 workspace work item type object. Attributes, workspace mode versus project mode, defaults, and how projects pick up workspace-level types. - [List workspace work item types](https://developers.plane.so/api-reference/v2/workspace-work-item-types/list-workspace-work-item-types.md): List the workspace-level work item types in a Plane workspace with the v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workspace work item type](https://developers.plane.so/api-reference/v2/workspace-work-item-types/get-workspace-work-item-type.md): Retrieve a single workspace-level work item type from Plane with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a workspace work item type](https://developers.plane.so/api-reference/v2/workspace-work-item-types/create-workspace-work-item-type.md): Create a workspace-level work item type in Plane with the v2 REST API. Body parameters, workspace mode requirement, OAuth scopes, error codes, and code examples. - [Update a workspace work item type](https://developers.plane.so/api-reference/v2/workspace-work-item-types/update-workspace-work-item-type.md): Update a workspace-level work item type in Plane with the v2 REST API. Partial PATCH body, workspace mode requirement, OAuth scopes, error codes, and code examples. - [Delete a workspace work item type](https://developers.plane.so/api-reference/v2/workspace-work-item-types/delete-workspace-work-item-type.md): Delete a workspace-level work item type in Plane with the v2 REST API. Workspace mode requirement, 204 response, OAuth scopes, error codes, and code examples. - [Mark a workspace work item type as default](https://developers.plane.so/api-reference/v2/workspace-work-item-types/mark-default-workspace-work-item-type.md): Promote a workspace-level work item type to the workspace default in Plane with the v2 REST API. Workspace mode requirement, OAuth scopes, error codes, and code examples. #### Properties - [Workspace work item properties overview](https://developers.plane.so/api-reference/v2/workspace-work-item-properties/overview.md): The Plane API v2 workspace work item property object. Property types, relation types, options, and how contexts decide where a workspace property applies. - [List workspace work item properties](https://developers.plane.so/api-reference/v2/workspace-work-item-properties/list-workspace-work-item-properties.md): List the custom properties defined at the workspace level with the Plane v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workspace work item property](https://developers.plane.so/api-reference/v2/workspace-work-item-properties/get-workspace-work-item-property.md): Retrieve one workspace-level custom property with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a workspace work item property](https://developers.plane.so/api-reference/v2/workspace-work-item-properties/create-workspace-work-item-property.md): Define a workspace-level custom property with the Plane v2 REST API. Property types, relation types, options, contexts, OAuth scopes, error codes, and code examples. - [Update a workspace work item property](https://developers.plane.so/api-reference/v2/workspace-work-item-properties/update-workspace-work-item-property.md): Partially update a workspace-level custom property with the Plane v2 REST API. PATCH semantics, body parameters, mode conflicts, OAuth scopes, error codes, and code examples. - [Delete a workspace work item property](https://developers.plane.so/api-reference/v2/workspace-work-item-properties/delete-workspace-work-item-property.md): Delete a workspace-level custom property with the Plane v2 REST API. What deletion takes with it, mode conflicts, OAuth scopes, error codes, and code examples. #### Property Options - [Workspace property options overview](https://developers.plane.so/api-reference/v2/workspace-work-item-property-options/overview.md): The Plane API v2 workspace-level work item property option object. Attributes, the single default option, server-assigned sort order, and the mode rule that governs writes. - [List workspace property options](https://developers.plane.so/api-reference/v2/workspace-work-item-property-options/list-workspace-property-options.md): List the selectable options on a workspace-level OPTION property with the Plane v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workspace property option](https://developers.plane.so/api-reference/v2/workspace-work-item-property-options/get-workspace-property-option.md): Retrieve a single selectable option on a workspace-level OPTION property with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a workspace property option](https://developers.plane.so/api-reference/v2/workspace-work-item-property-options/create-workspace-property-option.md): Add a selectable choice to a workspace-level OPTION property with the Plane v2 REST API. Body parameters, the single-default rule, OAuth scopes, error codes, and code examples. - [Update a workspace property option](https://developers.plane.so/api-reference/v2/workspace-work-item-property-options/update-workspace-property-option.md): Rename a workspace-level property option or move the default with the Plane v2 REST API. PATCH body parameters, the single-default rule, OAuth scopes, error codes, and code examples. - [Delete a workspace property option](https://developers.plane.so/api-reference/v2/workspace-work-item-property-options/delete-workspace-property-option.md): Remove a selectable choice from a workspace-level OPTION property with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. #### Type Properties - [Workspace type properties overview](https://developers.plane.so/api-reference/v2/workspace-work-item-type-properties/overview.md): The Plane API v2 workspace type-property resource. Which properties a workspace-level work item type shows, the attach/detach model, and the work-item-type mode rule. - [List properties on a workspace type](https://developers.plane.so/api-reference/v2/workspace-work-item-type-properties/list-workspace-type-properties.md): List the custom properties attached to a workspace-level work item type with the Plane v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a property on a workspace type](https://developers.plane.so/api-reference/v2/workspace-work-item-type-properties/get-workspace-type-property.md): Retrieve one custom property attached to a workspace-level work item type with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Attach properties to a workspace type](https://developers.plane.so/api-reference/v2/workspace-work-item-type-properties/attach-workspace-type-property.md): Attach existing workspace custom properties to a workspace-level work item type with the Plane v2 REST API. Body parameters, mode conflicts, OAuth scopes, error codes, and code examples. - [Detach a property from a workspace type](https://developers.plane.so/api-reference/v2/workspace-work-item-type-properties/detach-workspace-type-property.md): Detach a custom property from a workspace-level work item type with the Plane v2 REST API. Why detaching never deletes, mode conflicts, OAuth scopes, error codes, and code examples. #### Property Contexts - [Property contexts overview](https://developers.plane.so/api-reference/v2/work-item-property-contexts/overview.md): The Plane API v2 work item property context object. How a workspace-level property is scoped to projects and work item types, how the applies_to_all wildcards interact with explicit id lists, and how a context overrides the property it belongs to. - [List property contexts](https://developers.plane.so/api-reference/v2/work-item-property-contexts/list-property-contexts.md): List the contexts of a workspace-level work item property with the Plane v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a property context](https://developers.plane.so/api-reference/v2/work-item-property-contexts/get-property-context.md): Retrieve a single context of a workspace-level work item property with the Plane v2 REST API. Scope flags, overrides, options, OAuth scopes, error codes, and code examples. - [Create a property context](https://developers.plane.so/api-reference/v2/work-item-property-contexts/create-property-context.md): Create a context that scopes a workspace-level work item property to specific projects and work item types with the Plane v2 REST API. Wildcard flags, id lists, overrides, OAuth scopes, error codes, and code examples. - [Update a property context](https://developers.plane.so/api-reference/v2/work-item-property-contexts/update-property-context.md): Update the scope or the overrides of a work item property context with the Plane v2 REST API. Partial PATCH semantics, set-replacement for project and type lists, option replacement, OAuth scopes, error codes, and code examples. - [Delete a property context](https://developers.plane.so/api-reference/v2/work-item-property-contexts/delete-property-context.md): Delete a context from a workspace-level work item property with the Plane v2 REST API. What happens to the context's options and recorded values, mode conflicts, OAuth scopes, error codes, and code examples. ### Projects & Planning #### Projects - [Projects overview](https://developers.plane.so/api-reference/v2/projects/overview.md): The Plane API v2 project object. Attributes, endpoints, OAuth scopes and behavior. - [List projects](https://developers.plane.so/api-reference/v2/projects/list-projects.md): List projects with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a project](https://developers.plane.so/api-reference/v2/projects/get-project.md): Read a project with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a project summary](https://developers.plane.so/api-reference/v2/projects/get-project-summary.md): Get a project summary with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a project](https://developers.plane.so/api-reference/v2/projects/create-project.md): Create a project with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a project](https://developers.plane.so/api-reference/v2/projects/update-project.md): Update a project with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a project](https://developers.plane.so/api-reference/v2/projects/delete-project.md): Delete a project with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Upsert a project](https://developers.plane.so/api-reference/v2/projects/upsert-project.md): Upsert a project with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk create projects](https://developers.plane.so/api-reference/v2/projects/bulk-create-projects.md): Bulk create up to 50 projects in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Bulk update projects](https://developers.plane.so/api-reference/v2/projects/bulk-update-projects.md): Bulk update up to 50 projects in one call with the Plane v2 REST API. Per-row results, atomic all_or_none mode, OAuth scopes, error codes, and code examples. - [Archive a project](https://developers.plane.so/api-reference/v2/projects/archive-project.md): Archive a project with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Unarchive a project](https://developers.plane.so/api-reference/v2/projects/unarchive-project.md): Unarchive a project with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Project States - [Project states overview](https://developers.plane.so/api-reference/v2/project-states/overview.md): The Plane API v2 project state object. The workspace's catalog of lifecycle stages that projects move through, the six groups, the default state, the two feature gates, and the endpoints. - [List project states](https://developers.plane.so/api-reference/v2/project-states/list-project-states.md): List the lifecycle stages projects move through in a Plane workspace with the v2 REST API. Filters, ordering, pagination, feature gates, OAuth scopes, error codes, and code examples. - [Get a project state](https://developers.plane.so/api-reference/v2/project-states/get-project-state.md): Retrieve one project lifecycle stage from a Plane workspace with the v2 REST API. Path parameters, feature gates, OAuth scopes, error codes, and code examples. - [Create a project state](https://developers.plane.so/api-reference/v2/project-states/create-project-state.md): Add a lifecycle stage for projects to a Plane workspace with the v2 REST API. Body parameters, lifecycle groups, feature gates, OAuth scopes, error codes, and code examples. - [Update a project state](https://developers.plane.so/api-reference/v2/project-states/update-project-state.md): Update a project lifecycle stage in a Plane workspace with the v2 REST API. Partial PATCH semantics, body parameters, feature gates, OAuth scopes, error codes, and code examples. - [Delete a project state](https://developers.plane.so/api-reference/v2/project-states/delete-project-state.md): Delete a project lifecycle stage from a Plane workspace with the v2 REST API. The default state and states with projects in them, feature gates, OAuth scopes, error codes, and code examples. - [Mark a project state as default](https://developers.plane.so/api-reference/v2/project-states/mark-default-project-state.md): Make a project state the workspace's default with the Plane v2 REST API. Bodyless POST, the exclusive default flag, feature gates, OAuth scopes, error codes, and code examples. #### Project Labels - [Project labels overview](https://developers.plane.so/api-reference/v2/project-labels/overview.md): The Plane API v2 project label object. The workspace catalog of labels that tag projects, case-insensitive name uniqueness, deletes that detach a label from its projects, and the endpoints. - [List project labels](https://developers.plane.so/api-reference/v2/project-labels/list-project-labels.md): List the labels that tag projects in a Plane workspace with the v2 REST API. Filters, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a project label](https://developers.plane.so/api-reference/v2/project-labels/get-project-label.md): Retrieve one label from a Plane workspace's project label catalog with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a project label](https://developers.plane.so/api-reference/v2/project-labels/create-project-label.md): Add a label to a Plane workspace's project label catalog with the v2 REST API. Body parameters, case-insensitive name uniqueness, OAuth scopes, error codes, and code examples. - [Update a project label](https://developers.plane.so/api-reference/v2/project-labels/update-project-label.md): Rename, recolor, or reorder a label in a Plane workspace's project label catalog with the v2 REST API. Partial PATCH semantics, body parameters, OAuth scopes, error codes, and code examples. - [Delete a project label](https://developers.plane.so/api-reference/v2/project-labels/delete-project-label.md): Delete a label from a Plane workspace's project label catalog with the v2 REST API. Labels in use, OAuth scopes, error codes, and code examples. #### Project Features - [Project features overview](https://developers.plane.so/api-reference/v2/project-features/overview.md): The Plane API v2 project feature object. Attributes, endpoints, OAuth scopes and behavior. - [Get project features](https://developers.plane.so/api-reference/v2/project-features/get-project-features.md): Read a project feature with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update project features](https://developers.plane.so/api-reference/v2/project-features/update-project-features.md): Update project features with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Views (Project) - [Project views overview](https://developers.plane.so/api-reference/v2/project-views/overview.md): The Plane API v2 project view object. Attributes, endpoints, OAuth scopes and behavior. - [List project views](https://developers.plane.so/api-reference/v2/project-views/list-project-views.md): List project views with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a project view](https://developers.plane.so/api-reference/v2/project-views/get-project-view.md): Read a project view with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a project view](https://developers.plane.so/api-reference/v2/project-views/create-project-view.md): Create a project view with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a project view](https://developers.plane.so/api-reference/v2/project-views/update-project-view.md): Update a project view with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a project view](https://developers.plane.so/api-reference/v2/project-views/delete-project-view.md): Delete a project view with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Views (Workspace) - [Workspace views overview](https://developers.plane.so/api-reference/v2/workspace-views/overview.md): The Plane API v2 workspace view object. Attributes, endpoints, OAuth scopes and behavior. - [List workspace views](https://developers.plane.so/api-reference/v2/workspace-views/list-workspace-views.md): List workspace views with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a workspace view](https://developers.plane.so/api-reference/v2/workspace-views/get-workspace-view.md): Read a workspace view with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workspace view](https://developers.plane.so/api-reference/v2/workspace-views/create-workspace-view.md): Create a workspace view with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a workspace view](https://developers.plane.so/api-reference/v2/workspace-views/update-workspace-view.md): Update a workspace view with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a workspace view](https://developers.plane.so/api-reference/v2/workspace-views/delete-workspace-view.md): Delete a workspace view with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Initiatives - [Initiatives overview](https://developers.plane.so/api-reference/v2/initiatives/overview.md): The Plane API v2 initiative object. Attributes, endpoints, OAuth scopes and behavior. - [List initiatives](https://developers.plane.so/api-reference/v2/initiatives/list-initiatives.md): List initiatives with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an initiative](https://developers.plane.so/api-reference/v2/initiatives/get-initiative.md): Read an initiative with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an initiative](https://developers.plane.so/api-reference/v2/initiatives/create-initiative.md): Create an initiative with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an initiative](https://developers.plane.so/api-reference/v2/initiatives/update-initiative.md): Update an initiative with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an initiative](https://developers.plane.so/api-reference/v2/initiatives/delete-initiative.md): Delete an initiative with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List an initiative's labels](https://developers.plane.so/api-reference/v2/initiatives/list-initiative-labels.md): List the labels applied to a Plane initiative with the v2 REST API. Full label rows, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [List an initiative's projects](https://developers.plane.so/api-reference/v2/initiatives/list-initiative-projects.md): List the projects on a Plane initiative with the v2 REST API. Full project rows, pagination, sparse fields, expandable relations, OAuth scopes, error codes, and code examples. - [List an initiative's work items](https://developers.plane.so/api-reference/v2/initiatives/list-initiative-work-items.md): List the work items on a Plane initiative with the v2 REST API. Full work item rows, pagination, sparse fields, expandable relations, OAuth scopes, error codes, and code examples. - [Add or remove initiative labels](https://developers.plane.so/api-reference/v2/initiatives/manage-initiative-labels.md): Add or remove initiative labels with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Add or remove initiative projects](https://developers.plane.so/api-reference/v2/initiatives/manage-initiative-projects.md): Add or remove initiative projects with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Add or remove initiative work items](https://developers.plane.so/api-reference/v2/initiatives/manage-initiative-work-items.md): Add or remove initiative work items with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Initiative Labels - [Initiative labels overview](https://developers.plane.so/api-reference/v2/initiative-labels/overview.md): The Plane API v2 initiative label object. Attributes, endpoints, OAuth scopes and behavior. - [List initiative labels](https://developers.plane.so/api-reference/v2/initiative-labels/list-initiative-labels.md): List initiative labels with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an initiative label](https://developers.plane.so/api-reference/v2/initiative-labels/get-initiative-label.md): Read an initiative label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an initiative label](https://developers.plane.so/api-reference/v2/initiative-labels/create-initiative-label.md): Create an initiative label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an initiative label](https://developers.plane.so/api-reference/v2/initiative-labels/update-initiative-label.md): Update an initiative label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an initiative label](https://developers.plane.so/api-reference/v2/initiative-labels/delete-initiative-label.md): Delete an initiative label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Teamspaces - [Teamspaces overview](https://developers.plane.so/api-reference/v2/teamspaces/overview.md): The Plane API v2 teamspace object. Attributes, endpoints, OAuth scopes and behavior. - [List teamspaces](https://developers.plane.so/api-reference/v2/teamspaces/list-teamspaces.md): List teamspaces with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a teamspace](https://developers.plane.so/api-reference/v2/teamspaces/get-teamspace.md): Read a teamspace with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a teamspace](https://developers.plane.so/api-reference/v2/teamspaces/create-teamspace.md): Create a teamspace with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a teamspace](https://developers.plane.so/api-reference/v2/teamspaces/update-teamspace.md): Update a teamspace with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a teamspace](https://developers.plane.so/api-reference/v2/teamspaces/delete-teamspace.md): Delete a teamspace with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List a teamspace's members](https://developers.plane.so/api-reference/v2/teamspaces/list-teamspace-members.md): List the members of a Plane teamspace with the v2 REST API. Workspace roster rows, expanding the user, pagination, OAuth scopes, error codes, and code examples. - [List a teamspace's projects](https://developers.plane.so/api-reference/v2/teamspaces/list-teamspace-projects.md): List the projects in a Plane teamspace with the v2 REST API. Full project rows, pagination, sparse fields, expandable relations, OAuth scopes, error codes, and code examples. #### Work Item Templates (Project) - [Project work item templates overview](https://developers.plane.so/api-reference/v2/project-work-item-templates/overview.md): The Plane API v2 project work item template object. Attributes, endpoints, OAuth scopes and behavior. - [List project work item templates](https://developers.plane.so/api-reference/v2/project-work-item-templates/list-project-work-item-templates.md): List project work item templates with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a project work item template](https://developers.plane.so/api-reference/v2/project-work-item-templates/get-project-work-item-template.md): Read a project work item template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a project work item template](https://developers.plane.so/api-reference/v2/project-work-item-templates/create-project-work-item-template.md): Create a project work item template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a project work item template](https://developers.plane.so/api-reference/v2/project-work-item-templates/update-project-work-item-template.md): Update a project work item template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a project work item template](https://developers.plane.so/api-reference/v2/project-work-item-templates/delete-project-work-item-template.md): Delete a project work item template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a work item from a template](https://developers.plane.so/api-reference/v2/project-work-item-templates/use-work-item-template.md): Create a work item from a template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Work Item Templates (Workspace) - [Workspace work item templates overview](https://developers.plane.so/api-reference/v2/workspace-work-item-templates/overview.md): The Plane API v2 workspace work item template object. Attributes, endpoints, OAuth scopes and behavior. - [List workspace work item templates](https://developers.plane.so/api-reference/v2/workspace-work-item-templates/list-workspace-work-item-templates.md): List workspace work item templates with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a workspace work item template](https://developers.plane.so/api-reference/v2/workspace-work-item-templates/get-workspace-work-item-template.md): Read a workspace work item template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workspace work item template](https://developers.plane.so/api-reference/v2/workspace-work-item-templates/create-workspace-work-item-template.md): Create a workspace work item template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a workspace work item template](https://developers.plane.so/api-reference/v2/workspace-work-item-templates/update-workspace-work-item-template.md): Update a workspace work item template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a workspace work item template](https://developers.plane.so/api-reference/v2/workspace-work-item-templates/delete-workspace-work-item-template.md): Delete a workspace work item template with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Page Templates (Project) - [Project page templates overview](https://developers.plane.so/api-reference/v2/project-page-templates/overview.md): The Plane API v2 project page template object. Attributes, the template_data page seed, the 409 templates_managed_at_workspace rule under workspace governance, endpoints, and changes from v1. - [List project page templates](https://developers.plane.so/api-reference/v2/project-page-templates/list-project-page-templates.md): List the page templates that belong to a Plane project with the v2 REST API. Filters, search, ordering, pagination, deferred fields, OAuth scopes, error codes, and code examples. - [Get a project page template](https://developers.plane.so/api-reference/v2/project-page-templates/get-project-page-template.md): Retrieve a single page template that belongs to a Plane project with the v2 REST API, including its template_data page seed. Path parameters, OAuth scopes, error codes, and code examples. - [Create a project page template](https://developers.plane.so/api-reference/v2/project-page-templates/create-project-page-template.md): Create a page template that belongs to a Plane project with the v2 REST API. Body parameters, the template_data page seed, the 409 templates_managed_at_workspace rule, OAuth scopes, error codes, and code examples. - [Update a project page template](https://developers.plane.so/api-reference/v2/project-page-templates/update-project-page-template.md): Update a page template that belongs to a Plane project with the v2 REST API. Partial PATCH of the top-level fields, whole replacement of template_data, the 409 templates_managed_at_workspace rule, OAuth scopes, error codes, and code examples. - [Delete a project page template](https://developers.plane.so/api-reference/v2/project-page-templates/delete-project-page-template.md): Delete a page template that belongs to a Plane project with the v2 REST API. The 409 templates_managed_at_workspace rule, path parameters, OAuth scopes, error codes, and code examples. #### Page Templates (Workspace) - [Workspace page templates overview](https://developers.plane.so/api-reference/v2/workspace-page-templates/overview.md): The Plane API v2 workspace page template object. Attributes, the template_data page seed, parent validation, feature gating, endpoints, and changes from v1. - [List workspace page templates](https://developers.plane.so/api-reference/v2/workspace-page-templates/list-workspace-page-templates.md): List the workspace-level page templates in Plane with the v2 REST API. Filters, search, ordering, pagination, deferred fields, OAuth scopes, error codes, and code examples. - [Get a workspace page template](https://developers.plane.so/api-reference/v2/workspace-page-templates/get-workspace-page-template.md): Retrieve a single workspace-level page template from Plane with the v2 REST API, including its template_data page seed. Path parameters, OAuth scopes, error codes, and code examples. - [Create a workspace page template](https://developers.plane.so/api-reference/v2/workspace-page-templates/create-workspace-page-template.md): Create a workspace-level page template in Plane with the v2 REST API. Body parameters, the template_data page seed, parent validation, OAuth scopes, error codes, and code examples. - [Update a workspace page template](https://developers.plane.so/api-reference/v2/workspace-page-templates/update-workspace-page-template.md): Update a workspace-level page template in Plane with the v2 REST API. Partial PATCH of the top-level fields, whole replacement of template_data, OAuth scopes, error codes, and code examples. - [Delete a workspace page template](https://developers.plane.so/api-reference/v2/workspace-page-templates/delete-workspace-page-template.md): Delete a workspace-level page template from Plane with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. #### Project Templates - [Project templates overview](https://developers.plane.so/api-reference/v2/project-templates/overview.md): The Plane API v2 project template object. Attributes, the template_data project seed with its bundled work items, how updates replace workitems, copy and use, feature gating, endpoints, and changes from v1. - [List project templates](https://developers.plane.so/api-reference/v2/project-templates/list-project-templates.md): List a Plane workspace's project templates with the v2 REST API. Category, publication, and verification filters, search, ordering, pagination, deferred fields, OAuth scopes, error codes, and code examples. - [Get a project template](https://developers.plane.so/api-reference/v2/project-templates/get-project-template.md): Retrieve a single Plane project template with the v2 REST API, including its template_data project seed and bundled work items. Path parameters, OAuth scopes, error codes, and code examples. - [Create a project template](https://developers.plane.so/api-reference/v2/project-templates/create-project-template.md): Create a Plane project template with the v2 REST API. Body parameters, the template_data project seed, bundled work items, shape checks, OAuth scopes, error codes, and code examples. - [Update a project template](https://developers.plane.so/api-reference/v2/project-templates/update-project-template.md): Update a Plane project template with the v2 REST API. Partial PATCH of the top-level fields, merge rules for template_data, wholesale replacement of bundled workitems, OAuth scopes, error codes, and code examples. - [Delete a project template](https://developers.plane.so/api-reference/v2/project-templates/delete-project-template.md): Delete a Plane project template with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Copy a project template](https://developers.plane.so/api-reference/v2/project-templates/copy-project-template.md): Copy a published Plane project template, from any workspace, into your workspace with the v2 REST API. The template_id body, what the copy keeps and drops, naming, OAuth scopes, error codes, and code examples. - [Create a project from a template](https://developers.plane.so/api-reference/v2/project-templates/use-project-template.md): Create a real Plane project from a project template with the v2 REST API. The request body, what the template applies right away and in the background, OAuth scopes, error codes, and code examples. #### Template Categories - [Template categories overview](https://developers.plane.so/api-reference/v2/template-categories/overview.md): The Plane API v2 template category object. A global, read-only catalog of categories that project templates are tagged with. Attributes, the is_active default, endpoints, and changes from v1. - [List template categories](https://developers.plane.so/api-reference/v2/template-categories/list-template-categories.md): List Plane's global template category catalog with the v2 REST API. The is_active default, filters, search, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a template category](https://developers.plane.so/api-reference/v2/template-categories/get-template-category.md): Retrieve a single category from Plane's global template category catalog with the v2 REST API. Path parameters, inactive categories, OAuth scopes, error codes, and code examples. ### Wiki & Notes #### Collections - [Collections overview](https://developers.plane.so/api-reference/v2/collections/overview.md): The Plane API v2 collection object. Attributes, endpoints, OAuth scopes and behavior. - [List collection members](https://developers.plane.so/api-reference/v2/collections/list-collection-members.md): List collection members with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List collections](https://developers.plane.so/api-reference/v2/collections/list-collections.md): List collections with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a collection](https://developers.plane.so/api-reference/v2/collections/get-collection.md): Read a collection with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a collection](https://developers.plane.so/api-reference/v2/collections/create-collection.md): Create a collection with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a collection](https://developers.plane.so/api-reference/v2/collections/update-collection.md): Update a collection with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a collection](https://developers.plane.so/api-reference/v2/collections/delete-collection.md): Delete a collection with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Add or remove collection members](https://developers.plane.so/api-reference/v2/collections/manage-collection-members.md): Add or remove collection members with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Add or remove pages in a collection](https://developers.plane.so/api-reference/v2/collections/manage-collection-pages.md): Add or remove pages in a collection with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List collection pages](https://developers.plane.so/api-reference/v2/collections/list-collection-pages.md): List the wiki pages in a Plane collection as full page objects with the v2 REST API. Visibility, ordering, pagination, sparse fields, expand, OAuth scopes, error codes, and code examples. - [Move or reorder a collection page](https://developers.plane.so/api-reference/v2/collections/move-collection-page.md): Move a wiki page to another Plane collection or change its position in one with the v2 REST API. collection_id, sort_order, placement, private collection rules, OAuth scopes, error codes, and code examples. - [Search pages for a collection](https://developers.plane.so/api-reference/v2/collections/search-collection-pages.md): Search pages for a collection with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Pages (Project) - [Project pages overview](https://developers.plane.so/api-reference/v2/project-pages/overview.md): The Plane API v2 project page object. Attributes, endpoints, OAuth scopes and behavior. - [List project pages](https://developers.plane.so/api-reference/v2/project-pages/list-project-pages.md): List project pages with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a project page](https://developers.plane.so/api-reference/v2/project-pages/get-project-page.md): Read a project page with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a project page](https://developers.plane.so/api-reference/v2/project-pages/create-project-page.md): Create a project page with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a project page](https://developers.plane.so/api-reference/v2/project-pages/update-project-page.md): Update a project page with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a project page](https://developers.plane.so/api-reference/v2/project-pages/delete-project-page.md): Delete a project page with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Archive a project page](https://developers.plane.so/api-reference/v2/project-pages/archive-project-page.md): Archive a Plane project page and its nested pages with the v2 REST API. Bodyless POST, what archiving changes, idempotency, OAuth scopes, error codes, and code examples. - [Unarchive a project page](https://developers.plane.so/api-reference/v2/project-pages/unarchive-project-page.md): Restore an archived Plane project page and its nested pages with the v2 REST API. Bodyless POST, the archived parent rule, idempotency, OAuth scopes, error codes, and code examples. #### Pages (Workspace) - [Workspace pages overview](https://developers.plane.so/api-reference/v2/workspace-pages/overview.md): The Plane API v2 workspace page object. Attributes, endpoints, OAuth scopes and behavior. - [List workspace pages](https://developers.plane.so/api-reference/v2/workspace-pages/list-workspace-pages.md): List workspace pages with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a workspace page](https://developers.plane.so/api-reference/v2/workspace-pages/get-workspace-page.md): Read a workspace page with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workspace page](https://developers.plane.so/api-reference/v2/workspace-pages/create-workspace-page.md): Create a workspace page with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a workspace page](https://developers.plane.so/api-reference/v2/workspace-pages/update-workspace-page.md): Update a workspace page with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a workspace page](https://developers.plane.so/api-reference/v2/workspace-pages/delete-workspace-page.md): Delete a workspace page with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Archive a workspace page](https://developers.plane.so/api-reference/v2/workspace-pages/archive-workspace-page.md): Archive a Plane wiki page and its nested pages with the v2 REST API. Bodyless POST, what archiving changes, idempotency, OAuth scopes, error codes, and code examples. - [Unarchive a workspace page](https://developers.plane.so/api-reference/v2/workspace-pages/unarchive-workspace-page.md): Restore an archived Plane wiki page and its nested pages with the v2 REST API. Bodyless POST, the archived parent rule, idempotency, OAuth scopes, error codes, and code examples. #### Page Attachments (Workspace) - [Workspace page attachments overview](https://developers.plane.so/api-reference/v2/workspace-page-attachments/overview.md): The Plane API v2 workspace page attachment object. Attributes, the three-step upload flow, the download redirect, endpoints, and response shaping. - [List workspace page attachments](https://developers.plane.so/api-reference/v2/workspace-page-attachments/list-workspace-page-attachments.md): List the uploaded attachments on a Plane wiki page with the v2 REST API. Upload filter, ordering, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [Get a workspace page attachment](https://developers.plane.so/api-reference/v2/workspace-page-attachments/get-workspace-page-attachment.md): Retrieve one attachment on a Plane wiki page with the v2 REST API. Path parameters, sparse fields, OAuth scopes, error codes, and code examples. - [Create a workspace page attachment upload](https://developers.plane.so/api-reference/v2/workspace-page-attachments/create-workspace-page-attachment.md): Request an upload credential for a file on a Plane wiki page with the v2 REST API. Body parameters, the presigned upload_data, size and type limits, OAuth scopes, error codes, and code examples. - [Confirm a workspace page attachment upload](https://developers.plane.so/api-reference/v2/workspace-page-attachments/update-workspace-page-attachment.md): Confirm that a file for a Plane wiki page reached storage with the v2 REST API. The is_uploaded flag, idempotent confirms, OAuth scopes, error codes, and code examples. - [Delete a workspace page attachment](https://developers.plane.so/api-reference/v2/workspace-page-attachments/delete-workspace-page-attachment.md): Delete an attachment from a Plane wiki page with the v2 REST API. Locked and archived pages, OAuth scopes, error codes, and code examples. - [Download a workspace page attachment](https://developers.plane.so/api-reference/v2/workspace-page-attachments/download-workspace-page-attachment.md): Download a file attached to a Plane wiki page with the v2 REST API. The 302 redirect to a signed storage URL, unconfirmed uploads, OAuth scopes, error codes, and code examples. #### Published Pages - [Published pages overview](https://developers.plane.so/api-reference/v2/published-pages/overview.md): Read a published Plane page by its public anchor with the API v2. Who can read one, what returns 404, the page object, and differences from v1. - [Get a published page](https://developers.plane.so/api-reference/v2/published-pages/get-published-page.md): Read a published Plane page by its public anchor with the v2 REST API. Who can read it, what returns 404, sparse fields, expand, OAuth scopes, error codes, and code examples. #### Stickies - [Stickies overview](https://developers.plane.so/api-reference/v2/stickies/overview.md): The Plane API v2 sticky object. Attributes, endpoints, OAuth scopes and behavior. - [List stickies](https://developers.plane.so/api-reference/v2/stickies/list-stickies.md): List stickies with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a sticky](https://developers.plane.so/api-reference/v2/stickies/get-sticky.md): Read a sticky with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a sticky](https://developers.plane.so/api-reference/v2/stickies/create-sticky.md): Create a sticky with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a sticky](https://developers.plane.so/api-reference/v2/stickies/update-sticky.md): Update a sticky with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a sticky](https://developers.plane.so/api-reference/v2/stickies/delete-sticky.md): Delete a sticky with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. ### Customers #### Customers - [Customers overview](https://developers.plane.so/api-reference/v2/customers/overview.md): The Plane API v2 customer object. Attributes, endpoints, OAuth scopes and behavior. - [List customers](https://developers.plane.so/api-reference/v2/customers/list-customers.md): List customers with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a customer](https://developers.plane.so/api-reference/v2/customers/get-customer.md): Read a customer with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a customer](https://developers.plane.so/api-reference/v2/customers/create-customer.md): Create a customer with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a customer](https://developers.plane.so/api-reference/v2/customers/update-customer.md): Update a customer with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a customer](https://developers.plane.so/api-reference/v2/customers/delete-customer.md): Delete a customer with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Upsert a customer](https://developers.plane.so/api-reference/v2/customers/upsert-customer.md): Upsert a customer with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List a customer's work items](https://developers.plane.so/api-reference/v2/customers/list-customer-work-items.md): List the work items linked to a Plane customer with the v2 REST API. Direct and request links, the customer_request_id narrowing, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [Link or unlink customer work items](https://developers.plane.so/api-reference/v2/customers/manage-customer-work-items.md): Link or unlink customer work items with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Customer Requests - [Customer requests overview](https://developers.plane.so/api-reference/v2/customer-requests/overview.md): The Plane API v2 customer request object. Attributes, endpoints, OAuth scopes and behavior. - [List customer requests](https://developers.plane.so/api-reference/v2/customer-requests/list-customer-requests.md): List customer requests with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a customer request](https://developers.plane.so/api-reference/v2/customer-requests/get-customer-request.md): Read a customer request with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a customer request](https://developers.plane.so/api-reference/v2/customer-requests/create-customer-request.md): Create a customer request with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a customer request](https://developers.plane.so/api-reference/v2/customer-requests/update-customer-request.md): Update a customer request with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a customer request](https://developers.plane.so/api-reference/v2/customer-requests/delete-customer-request.md): Delete a customer request with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Customer Properties - [Customer properties overview](https://developers.plane.so/api-reference/v2/customer-properties/overview.md): The Plane API v2 customer property object. Attributes, endpoints, OAuth scopes and behavior. - [List customer properties](https://developers.plane.so/api-reference/v2/customer-properties/list-customer-properties.md): List customer properties with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a customer property](https://developers.plane.so/api-reference/v2/customer-properties/get-customer-property.md): Read a customer property with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a customer property](https://developers.plane.so/api-reference/v2/customer-properties/create-customer-property.md): Create a customer property with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a customer property](https://developers.plane.so/api-reference/v2/customer-properties/update-customer-property.md): Update a customer property with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a customer property](https://developers.plane.so/api-reference/v2/customer-properties/delete-customer-property.md): Delete a customer property with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Customer Property Values - [Customer property values overview](https://developers.plane.so/api-reference/v2/customer-property-values/overview.md): The Plane API v2 customer property value object. Attributes, endpoints, OAuth scopes and behavior. - [List customer property values](https://developers.plane.so/api-reference/v2/customer-property-values/list-customer-property-values.md): List customer property values with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Set customer property values](https://developers.plane.so/api-reference/v2/customer-property-values/set-customer-property-values.md): Create a customer property value with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. ### Releases #### Releases - [Releases overview](https://developers.plane.so/api-reference/v2/releases/overview.md): The Plane API v2 release object. Attributes, endpoints, OAuth scopes and behavior. - [List releases](https://developers.plane.so/api-reference/v2/releases/list-releases.md): List releases with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a release](https://developers.plane.so/api-reference/v2/releases/get-release.md): Read a release with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a release changelog](https://developers.plane.so/api-reference/v2/releases/get-release-changelog.md): Read a release changelog with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a release](https://developers.plane.so/api-reference/v2/releases/create-release.md): Create a release with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a release](https://developers.plane.so/api-reference/v2/releases/update-release.md): Update a release with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a release changelog](https://developers.plane.so/api-reference/v2/releases/update-release-changelog.md): Update a release changelog with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a release](https://developers.plane.so/api-reference/v2/releases/delete-release.md): Delete a release with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List a release's labels](https://developers.plane.so/api-reference/v2/releases/list-release-labels.md): List the release labels applied to a workspace release with the Plane v2 REST API. Full label objects, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [Add or remove release labels](https://developers.plane.so/api-reference/v2/releases/manage-release-labels.md): Add or remove release labels with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List a release's work items](https://developers.plane.so/api-reference/v2/releases/list-release-work-items.md): List the work items in a workspace release with the Plane v2 REST API. Full work item objects, pagination, sparse fields, expansion, OAuth scopes, error codes, and code examples. - [Add or remove release work items](https://developers.plane.so/api-reference/v2/releases/manage-release-work-items.md): Add or remove release work items with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Release Tags - [Release tags overview](https://developers.plane.so/api-reference/v2/release-tags/overview.md): The Plane API v2 release tag object. Attributes, endpoints, OAuth scopes and behavior. - [List release tags](https://developers.plane.so/api-reference/v2/release-tags/list-release-tags.md): List release tags with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a release tag](https://developers.plane.so/api-reference/v2/release-tags/get-release-tag.md): Read a release tag with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a release tag](https://developers.plane.so/api-reference/v2/release-tags/create-release-tag.md): Create a release tag with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a release tag](https://developers.plane.so/api-reference/v2/release-tags/update-release-tag.md): Update a release tag with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a release tag](https://developers.plane.so/api-reference/v2/release-tags/delete-release-tag.md): Delete a release tag with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Release Labels - [Release labels overview](https://developers.plane.so/api-reference/v2/release-labels/overview.md): The Plane API v2 release label object. Attributes, endpoints, OAuth scopes and behavior. - [List release labels](https://developers.plane.so/api-reference/v2/release-labels/list-release-labels.md): List release labels with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a release label](https://developers.plane.so/api-reference/v2/release-labels/get-release-label.md): Read a release label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a release label](https://developers.plane.so/api-reference/v2/release-labels/create-release-label.md): Create a release label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a release label](https://developers.plane.so/api-reference/v2/release-labels/update-release-label.md): Update a release label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a release label](https://developers.plane.so/api-reference/v2/release-labels/delete-release-label.md): Delete a release label with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Release Comments - [Release comments overview](https://developers.plane.so/api-reference/v2/release-comments/overview.md): The Plane API v2 release comment object. Attributes, endpoints, OAuth scopes and behavior. - [List release comments](https://developers.plane.so/api-reference/v2/release-comments/list-release-comments.md): List release comments with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a release comment](https://developers.plane.so/api-reference/v2/release-comments/get-release-comment.md): Read a release comment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a release comment](https://developers.plane.so/api-reference/v2/release-comments/create-release-comment.md): Create a release comment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a release comment](https://developers.plane.so/api-reference/v2/release-comments/update-release-comment.md): Update a release comment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a release comment](https://developers.plane.so/api-reference/v2/release-comments/delete-release-comment.md): Delete a release comment with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Release Links - [Release links overview](https://developers.plane.so/api-reference/v2/release-links/overview.md): The Plane API v2 release link object. Attributes, endpoints, OAuth scopes and behavior. - [List release links](https://developers.plane.so/api-reference/v2/release-links/list-release-links.md): List release links with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a release link](https://developers.plane.so/api-reference/v2/release-links/get-release-link.md): Read a release link with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a release link](https://developers.plane.so/api-reference/v2/release-links/create-release-link.md): Create a release link with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a release link](https://developers.plane.so/api-reference/v2/release-links/update-release-link.md): Update a release link with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a release link](https://developers.plane.so/api-reference/v2/release-links/delete-release-link.md): Delete a release link with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Project Releases - [Project releases overview](https://developers.plane.so/api-reference/v2/project-releases/overview.md): The Plane API v2 project release object. How project releases relate to workspace releases, plan gating, permissions, attributes, and endpoints. - [List project releases](https://developers.plane.so/api-reference/v2/project-releases/list-project-releases.md): List the releases that belong to one Plane project with the v2 REST API. Filters, search, ordering, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [Get a project release](https://developers.plane.so/api-reference/v2/project-releases/get-project-release.md): Retrieve a single release from a Plane project with the v2 REST API. Path parameters, sparse fields, expansion, OAuth scopes, error codes, and code examples. - [Create a project release](https://developers.plane.so/api-reference/v2/project-releases/create-project-release.md): Create a release in a Plane project with the v2 REST API. Body parameters, workspace-wide name uniqueness, plan gating, OAuth scopes, error codes, and code examples. - [Update a project release](https://developers.plane.so/api-reference/v2/project-releases/update-project-release.md): Update a release in a Plane project with the v2 REST API. Partial PATCH semantics, body parameters, name uniqueness, OAuth scopes, error codes, and code examples. - [Delete a project release](https://developers.plane.so/api-reference/v2/project-releases/delete-project-release.md): Delete a release from a Plane project with the v2 REST API. Path parameters, permissions, OAuth scopes, error codes, and code examples. - [Get a project release changelog](https://developers.plane.so/api-reference/v2/project-releases/get-project-release-changelog.md): Read the changelog of a release in a Plane project with the v2 REST API. Singleton read that creates an empty changelog on first access, OAuth scopes, error codes, and code examples. - [Update a project release changelog](https://developers.plane.so/api-reference/v2/project-releases/update-project-release-changelog.md): Write the changelog of a release in a Plane project with the v2 REST API. Partial PATCH of the HTML and JSON bodies, OAuth scopes, error codes, and code examples. - [List a project release's labels](https://developers.plane.so/api-reference/v2/project-releases/list-project-release-labels.md): List the release labels applied to a release in a Plane project with the v2 REST API. Full label objects, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [Add or remove project release labels](https://developers.plane.so/api-reference/v2/project-releases/manage-project-release-labels.md): Add and remove release labels on a release in a Plane project with the v2 REST API. One add/remove request body, the added and removed response, OAuth scopes, error codes, and code examples. - [List a project release's work items](https://developers.plane.so/api-reference/v2/project-releases/list-project-release-work-items.md): List the work items in a release of a Plane project with the v2 REST API. Full work item objects, pagination, sparse fields, expansion, OAuth scopes, error codes, and code examples. - [Add or remove project release work items](https://developers.plane.so/api-reference/v2/project-releases/manage-project-release-work-items.md): Add and remove work items on a release in a Plane project with the v2 REST API. One add/remove request body, the added and removed response, OAuth scopes, error codes, and code examples. #### Project Release Comments - [Project release comments overview](https://developers.plane.so/api-reference/v2/project-release-comments/overview.md): The Plane API v2 comment object for project releases. Attributes, threading, resolve state, the view and edit checks, and endpoints. - [List project release comments](https://developers.plane.so/api-reference/v2/project-release-comments/list-project-release-comments.md): List the comments on a release in a Plane project with the v2 REST API. Filters, ordering, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [Get a project release comment](https://developers.plane.so/api-reference/v2/project-release-comments/get-project-release-comment.md): Retrieve a single comment on a release in a Plane project with the v2 REST API. The view check on the parent release, sparse fields, OAuth scopes, error codes, and code examples. - [Create a project release comment](https://developers.plane.so/api-reference/v2/project-release-comments/create-project-release-comment.md): Add a comment or a reply to a release in a Plane project with the v2 REST API. Body parameters, the view and edit checks, OAuth scopes, error codes, and code examples. - [Update a project release comment](https://developers.plane.so/api-reference/v2/project-release-comments/update-project-release-comment.md): Edit, resolve, or re-parent a comment on a release in a Plane project with the v2 REST API. Partial PATCH semantics, the edit check, OAuth scopes, error codes, and code examples. - [Delete a project release comment](https://developers.plane.so/api-reference/v2/project-release-comments/delete-project-release-comment.md): Delete a comment from a release in a Plane project with the v2 REST API. The edit check on the parent release, OAuth scopes, error codes, and code examples. #### Project Release Links - [Project release links overview](https://developers.plane.so/api-reference/v2/project-release-links/overview.md): The Plane API v2 link object for project releases. Attributes, URL uniqueness, the view and edit checks, and endpoints. - [List project release links](https://developers.plane.so/api-reference/v2/project-release-links/list-project-release-links.md): List the links on a release in a Plane project with the v2 REST API. Search, ordering, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [Get a project release link](https://developers.plane.so/api-reference/v2/project-release-links/get-project-release-link.md): Retrieve a single link on a release in a Plane project with the v2 REST API. The view check on the parent release, sparse fields, OAuth scopes, error codes, and code examples. - [Create a project release link](https://developers.plane.so/api-reference/v2/project-release-links/create-project-release-link.md): Attach a URL to a release in a Plane project with the v2 REST API. Body parameters, per-release URL uniqueness, the view and edit checks, OAuth scopes, error codes, and code examples. - [Update a project release link](https://developers.plane.so/api-reference/v2/project-release-links/update-project-release-link.md): Update a link on a release in a Plane project with the v2 REST API. Partial PATCH semantics, per-release URL uniqueness, the edit check, OAuth scopes, error codes, and code examples. - [Delete a project release link](https://developers.plane.so/api-reference/v2/project-release-links/delete-project-release-link.md): Remove a link from a release in a Plane project with the v2 REST API. The edit check on the parent release, OAuth scopes, error codes, and code examples. ### Automation & Workflows #### Automations (Project) - [Project automations overview](https://developers.plane.so/api-reference/v2/project-automations/overview.md): The Plane API v2 project automation object. Attributes, endpoints, OAuth scopes and behavior. - [List automation activities](https://developers.plane.so/api-reference/v2/project-automations/list-automation-activities.md): List automation activities with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List automation edges](https://developers.plane.so/api-reference/v2/project-automations/list-automation-edges.md): List automation edges with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List automation nodes](https://developers.plane.so/api-reference/v2/project-automations/list-automation-nodes.md): List automation nodes with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List project automations](https://developers.plane.so/api-reference/v2/project-automations/list-project-automations.md): List project automations with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an automation activity](https://developers.plane.so/api-reference/v2/project-automations/get-automation-activity.md): Read an automation activity with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an automation edge](https://developers.plane.so/api-reference/v2/project-automations/get-automation-edge.md): Read an automation edge with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an automation node](https://developers.plane.so/api-reference/v2/project-automations/get-automation-node.md): Read an automation node with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a project automation](https://developers.plane.so/api-reference/v2/project-automations/get-project-automation.md): Read a project automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an automation edge](https://developers.plane.so/api-reference/v2/project-automations/create-automation-edge.md): Create an automation edge with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an automation node](https://developers.plane.so/api-reference/v2/project-automations/create-automation-node.md): Create an automation node with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a project automation](https://developers.plane.so/api-reference/v2/project-automations/create-project-automation.md): Create a project automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an automation edge](https://developers.plane.so/api-reference/v2/project-automations/update-automation-edge.md): Update an automation edge with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an automation node](https://developers.plane.so/api-reference/v2/project-automations/update-automation-node.md): Update an automation node with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a project automation](https://developers.plane.so/api-reference/v2/project-automations/update-project-automation.md): Update a project automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an automation edge](https://developers.plane.so/api-reference/v2/project-automations/delete-automation-edge.md): Delete an automation edge with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an automation node](https://developers.plane.so/api-reference/v2/project-automations/delete-automation-node.md): Delete an automation node with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a project automation](https://developers.plane.so/api-reference/v2/project-automations/delete-project-automation.md): Delete a project automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Regenerate an automation node webhook secret](https://developers.plane.so/api-reference/v2/project-automations/regenerate-node-webhook-secret.md): Regenerate an automation node webhook secret with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Enable or disable a project automation](https://developers.plane.so/api-reference/v2/project-automations/set-project-automation-status.md): Enable or disable a project automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Automations (Workspace) - [Workspace automations overview](https://developers.plane.so/api-reference/v2/workspace-automations/overview.md): The Plane API v2 workspace automation object. Attributes, endpoints, OAuth scopes and behavior. - [List automation activities](https://developers.plane.so/api-reference/v2/workspace-automations/list-automation-activities.md): List automation activities with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List automation edges](https://developers.plane.so/api-reference/v2/workspace-automations/list-automation-edges.md): List automation edges with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List automation nodes](https://developers.plane.so/api-reference/v2/workspace-automations/list-automation-nodes.md): List automation nodes with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List workspace automations](https://developers.plane.so/api-reference/v2/workspace-automations/list-workspace-automations.md): List workspace automations with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an automation activity](https://developers.plane.so/api-reference/v2/workspace-automations/get-automation-activity.md): Read an automation activity with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an automation edge](https://developers.plane.so/api-reference/v2/workspace-automations/get-automation-edge.md): Read an automation edge with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an automation node](https://developers.plane.so/api-reference/v2/workspace-automations/get-automation-node.md): Read an automation node with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a workspace automation](https://developers.plane.so/api-reference/v2/workspace-automations/get-workspace-automation.md): Read a workspace automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an automation edge](https://developers.plane.so/api-reference/v2/workspace-automations/create-automation-edge.md): Create an automation edge with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an automation node](https://developers.plane.so/api-reference/v2/workspace-automations/create-automation-node.md): Create an automation node with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workspace automation](https://developers.plane.so/api-reference/v2/workspace-automations/create-workspace-automation.md): Create a workspace automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an automation edge](https://developers.plane.so/api-reference/v2/workspace-automations/update-automation-edge.md): Update an automation edge with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update an automation node](https://developers.plane.so/api-reference/v2/workspace-automations/update-automation-node.md): Update an automation node with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a workspace automation](https://developers.plane.so/api-reference/v2/workspace-automations/update-workspace-automation.md): Update a workspace automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an automation edge](https://developers.plane.so/api-reference/v2/workspace-automations/delete-automation-edge.md): Delete an automation edge with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an automation node](https://developers.plane.so/api-reference/v2/workspace-automations/delete-automation-node.md): Delete an automation node with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a workspace automation](https://developers.plane.so/api-reference/v2/workspace-automations/delete-workspace-automation.md): Delete a workspace automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Regenerate an automation node webhook secret](https://developers.plane.so/api-reference/v2/workspace-automations/regenerate-node-webhook-secret.md): Regenerate an automation node webhook secret with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Enable or disable a workspace automation](https://developers.plane.so/api-reference/v2/workspace-automations/set-workspace-automation-status.md): Enable or disable a workspace automation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Workflows (Project) - [Workflows overview](https://developers.plane.so/api-reference/v2/workflows/overview.md): The Plane API v2 workflow object. Attributes, endpoints, OAuth scopes and behavior. - [List workflows](https://developers.plane.so/api-reference/v2/workflows/list-workflows.md): List workflows with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a workflow](https://developers.plane.so/api-reference/v2/workflows/get-workflow.md): Read a workflow with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workflow](https://developers.plane.so/api-reference/v2/workflows/create-workflow.md): Create a workflow with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a workflow](https://developers.plane.so/api-reference/v2/workflows/update-workflow.md): Update a workflow with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a workflow](https://developers.plane.so/api-reference/v2/workflows/delete-workflow.md): Delete a workflow with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Preview a workflow fallback](https://developers.plane.so/api-reference/v2/workflows/preview-workflow-fallback.md): Count the work items a re-type or a workflow switch would move in a project of a governed Plane workspace with the v2 REST API. Body parameters, how the target workflow is chosen, OAuth scopes, error codes, and code examples. #### Workflow States (Project) - [Workflow states overview](https://developers.plane.so/api-reference/v2/workflow-states/overview.md): The Plane API v2 workflow state object. Attributes, endpoints, OAuth scopes and behavior. - [List workflow states](https://developers.plane.so/api-reference/v2/workflow-states/list-workflow-states.md): List workflow states with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a workflow state](https://developers.plane.so/api-reference/v2/workflow-states/get-workflow-state.md): Read a workflow state with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workflow state](https://developers.plane.so/api-reference/v2/workflow-states/create-workflow-state.md): Create a workflow state with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a workflow state](https://developers.plane.so/api-reference/v2/workflow-states/update-workflow-state.md): Update a workflow state with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a workflow state](https://developers.plane.so/api-reference/v2/workflow-states/delete-workflow-state.md): Delete a workflow state with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Workflow Transitions (Project) - [Workflow transitions overview](https://developers.plane.so/api-reference/v2/workflow-transitions/overview.md): The Plane API v2 workflow transition object. Attributes, endpoints, OAuth scopes and behavior. - [List workflow transitions](https://developers.plane.so/api-reference/v2/workflow-transitions/list-workflow-transitions.md): List workflow transitions with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a workflow transition](https://developers.plane.so/api-reference/v2/workflow-transitions/get-workflow-transition.md): Read a workflow transition with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workflow transition](https://developers.plane.so/api-reference/v2/workflow-transitions/create-workflow-transition.md): Create a workflow transition with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a workflow transition](https://developers.plane.so/api-reference/v2/workflow-transitions/update-workflow-transition.md): Update a workflow transition with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a workflow transition](https://developers.plane.so/api-reference/v2/workflow-transitions/delete-workflow-transition.md): Delete a workflow transition with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Workflow Activities (Project) - [Workflow activities overview](https://developers.plane.so/api-reference/v2/workflow-activities/overview.md): The Plane API v2 workflow activity object. The audit trail of one project workflow, its attributes, the incremental-poll filter, endpoints, and behavior in a governed workspace. - [List workflow activities](https://developers.plane.so/api-reference/v2/workflow-activities/list-workflow-activities.md): List the audit trail of a Plane project workflow with the v2 REST API. Incremental polling with created_at__gt, filters, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workflow activity](https://developers.plane.so/api-reference/v2/workflow-activities/get-workflow-activity.md): Retrieve one entry from the audit trail of a Plane project workflow with the v2 REST API. Path parameters, sparse fields, OAuth scopes, error codes, and code examples. #### Workflow Hooks (Project) - [Workflow hooks overview](https://developers.plane.so/api-reference/v2/workflow-hooks/overview.md): The Plane API v2 workflow hook object. Scripts and signed webhooks that run before or after a workflow transition, the one-time webhook secret, execution history, and behavior in a governed workspace. - [List workflow hooks](https://developers.plane.so/api-reference/v2/workflow-hooks/list-workflow-hooks.md): List the hooks attached to a workflow transition in a Plane project with the v2 REST API. Filters, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workflow hook](https://developers.plane.so/api-reference/v2/workflow-hooks/get-workflow-hook.md): Retrieve one hook on a workflow transition in a Plane project with the v2 REST API. Path parameters, sparse fields, OAuth scopes, error codes, and code examples. - [Create a workflow hook](https://developers.plane.so/api-reference/v2/workflow-hooks/create-workflow-hook.md): Attach a hook to a workflow transition in a Plane project with the v2 REST API. send_webhook and run_script config, the one-time webhook secret, entitlements, OAuth scopes, error codes, and code examples. - [Update a workflow hook](https://developers.plane.so/api-reference/v2/workflow-hooks/update-workflow-hook.md): Update a hook on a workflow transition in a Plane project with the v2 REST API. Immutable phase and handler, config merge rules, preserved secrets, entitlements, OAuth scopes, error codes, and code examples. - [Delete a workflow hook](https://developers.plane.so/api-reference/v2/workflow-hooks/delete-workflow-hook.md): Delete a hook from a workflow transition in a Plane project with the v2 REST API. Soft delete, preserved execution history, OAuth scopes, error codes, and code examples. - [List workflow hook executions](https://developers.plane.so/api-reference/v2/workflow-hooks/list-workflow-hook-executions.md): List the run history of a workflow hook in a Plane project with the v2 REST API. Status, input and output per run, history kept after delete, pagination, OAuth scopes, error codes, and code examples. - [Regenerate a workflow hook secret](https://developers.plane.so/api-reference/v2/workflow-hooks/regenerate-workflow-hook-secret.md): Rotate the signing secret of a send_webhook workflow hook in a Plane project with the v2 REST API. Bodyless POST, the one-time secret, OAuth scopes, error codes, and code examples. #### Workflows (Workspace) - [Workspace workflows overview](https://developers.plane.so/api-reference/v2/workspace-workflows/overview.md): The Plane API v2 workspace workflow object. Catalog workflows in a governed workspace, how projects and work item types resolve to them, plan requirements, and the guards on removing states and deleting workflows. - [List workspace workflows](https://developers.plane.so/api-reference/v2/workspace-workflows/list-workspace-workflows.md): List the catalog workflows in a governed Plane workspace with the v2 REST API. Filters, search, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workspace workflow](https://developers.plane.so/api-reference/v2/workspace-workflows/get-workspace-workflow.md): Retrieve one catalog workflow with its chain, transitions, hooks, and the states and approvers it references, with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a workspace workflow](https://developers.plane.so/api-reference/v2/workspace-workflows/create-workspace-workflow.md): Create a catalog workflow in a governed Plane workspace with the v2 REST API. Draft state, the plan limit on a second workflow, OAuth scopes, error codes, and code examples. - [Update a workspace workflow](https://developers.plane.so/api-reference/v2/workspace-workflows/update-workspace-workflow.md): Rename, describe, or activate a catalog workflow, or replace its whole chain in one request, with the Plane v2 REST API. The orphan gate, state_mapping, OAuth scopes, error codes, and code examples. - [Delete a workspace workflow](https://developers.plane.so/api-reference/v2/workspace-workflows/delete-workspace-workflow.md): Delete a catalog workflow from a governed Plane workspace with the v2 REST API. The workflow_in_use guard, the plan requirement, OAuth scopes, error codes, and code examples. - [Get workspace workflow usage](https://developers.plane.so/api-reference/v2/workspace-workflows/get-workspace-workflow-usage.md): See which projects and work item types resolve to a catalog workflow, and which types allow or mandate it, with the Plane v2 REST API. Response fields, OAuth scopes, error codes, and code examples. #### Workflow States (Workspace) - [Workspace workflow states overview](https://developers.plane.so/api-reference/v2/workspace-workflow-states/overview.md): The Plane API v2 workspace workflow state object. A catalog state's place and settings in a catalog workflow's chain, approval states, the default state, and the rules for removing a state. - [List workspace workflow states](https://developers.plane.so/api-reference/v2/workspace-workflow-states/list-workspace-workflow-states.md): List the states in a catalog workflow's chain with the Plane v2 REST API. Ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workspace workflow state](https://developers.plane.so/api-reference/v2/workspace-workflow-states/get-workspace-workflow-state.md): Retrieve one state in a catalog workflow's chain by its catalog state id with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Add states to a workspace workflow](https://developers.plane.so/api-reference/v2/workspace-workflow-states/add-workspace-workflow-states.md): Attach catalog states to a catalog workflow's chain in one call with the Plane v2 REST API. Idempotent bulk attach, defaults for new entries, OAuth scopes, error codes, and code examples. - [Update a workspace workflow state](https://developers.plane.so/api-reference/v2/workspace-workflow-states/update-workspace-workflow-state.md): Change a chain state's type or work item creation setting in a catalog workflow with the Plane v2 REST API. Approval states, OAuth scopes, error codes, and code examples. - [Remove a state from a workspace workflow](https://developers.plane.so/api-reference/v2/workspace-workflow-states/remove-workspace-workflow-state.md): Remove a catalog state from a catalog workflow's chain with the Plane v2 REST API. The orphan gate, state_mapping, transition dependencies, the default state, OAuth scopes, and error codes. - [Mark a workspace workflow state as default](https://developers.plane.so/api-reference/v2/workspace-workflow-states/mark-default-workspace-workflow-state.md): Make a chain state the default state of a catalog workflow with the Plane v2 REST API. Bodyless POST, OAuth scopes, error codes, and code examples. #### Workflow Transitions (Workspace) - [Workspace workflow transitions overview](https://developers.plane.so/api-reference/v2/workspace-workflow-transitions/overview.md): The Plane API v2 workspace workflow transition object. Allowed moves between chain states in a catalog workflow, approval flows, approvers, and how states are identified in requests and responses. - [List workspace workflow transitions](https://developers.plane.so/api-reference/v2/workspace-workflow-transitions/list-workspace-workflow-transitions.md): List the transitions of a catalog workflow with the Plane v2 REST API. Approvers, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workspace workflow transition](https://developers.plane.so/api-reference/v2/workspace-workflow-transitions/get-workspace-workflow-transition.md): Retrieve one transition of a catalog workflow with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a workspace workflow transition](https://developers.plane.so/api-reference/v2/workspace-workflow-transitions/create-workspace-workflow-transition.md): Allow a move between two chain states of a catalog workflow, with optional approvers, with the Plane v2 REST API. Body parameters, OAuth scopes, error codes, and code examples. - [Update a workspace workflow transition](https://developers.plane.so/api-reference/v2/workspace-workflow-transitions/update-workspace-workflow-transition.md): Retarget a catalog workflow transition or change its approvers with the Plane v2 REST API. Partial PATCH semantics, approver replacement, OAuth scopes, error codes, and code examples. - [Delete a workspace workflow transition](https://developers.plane.so/api-reference/v2/workspace-workflow-transitions/delete-workspace-workflow-transition.md): Delete a transition from a catalog workflow with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. #### Workflow Activities (Workspace) - [Workspace workflow activities overview](https://developers.plane.so/api-reference/v2/workspace-workflow-activities/overview.md): The Plane API v2 workspace workflow activity object. The change history of a catalog workflow, the field and verb values it records, and how to poll it for new entries. - [List workspace workflow activities](https://developers.plane.so/api-reference/v2/workspace-workflow-activities/list-workspace-workflow-activities.md): List the change history of a catalog workflow with the Plane v2 REST API. Incremental polling with created_at__gt, filters, ordering, pagination, OAuth scopes, and error codes. - [Get a workspace workflow activity](https://developers.plane.so/api-reference/v2/workspace-workflow-activities/get-workspace-workflow-activity.md): Retrieve one entry from a catalog workflow's change history with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. #### Workflow Hooks (Workspace) - [Workspace workflow hooks overview](https://developers.plane.so/api-reference/v2/workspace-workflow-hooks/overview.md): The Plane API v2 workspace workflow hook object. Scripts and webhooks that run before or after a move through a catalog workflow transition, config by handler, the one-time signing secret, and run history. - [List workspace workflow hooks](https://developers.plane.so/api-reference/v2/workspace-workflow-hooks/list-workspace-workflow-hooks.md): List the hooks on a catalog workflow transition with the Plane v2 REST API. Phase and handler filters, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a workspace workflow hook](https://developers.plane.so/api-reference/v2/workspace-workflow-hooks/get-workspace-workflow-hook.md): Retrieve one hook on a catalog workflow transition with the Plane v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create a workspace workflow hook](https://developers.plane.so/api-reference/v2/workspace-workflow-hooks/create-workspace-workflow-hook.md): Add a run_script or send_webhook hook to a catalog workflow transition with the Plane v2 REST API. Phases, config shapes, the one-time signing secret, OAuth scopes, and error codes. - [Update a workspace workflow hook](https://developers.plane.so/api-reference/v2/workspace-workflow-hooks/update-workspace-workflow-hook.md): Enable, disable, or reconfigure a hook on a catalog workflow transition with the Plane v2 REST API. Immutable fields, config merge rules, OAuth scopes, error codes, and code examples. - [Delete a workspace workflow hook](https://developers.plane.so/api-reference/v2/workspace-workflow-hooks/delete-workspace-workflow-hook.md): Delete a hook from a catalog workflow transition with the Plane v2 REST API. Soft delete, retained run history, OAuth scopes, error codes, and code examples. - [List workspace workflow hook executions](https://developers.plane.so/api-reference/v2/workspace-workflow-hooks/list-workspace-workflow-hook-executions.md): List the run history of a hook on a catalog workflow transition with the Plane v2 REST API. Run status, inputs, outputs, errors, pagination, OAuth scopes, and error codes. - [Regenerate a workspace workflow hook secret](https://developers.plane.so/api-reference/v2/workspace-workflow-hooks/regenerate-workspace-workflow-hook-secret.md): Rotate the signing secret of a send_webhook hook on a catalog workflow transition with the Plane v2 REST API. One-time secret, OAuth scopes, error codes, and code examples. #### Work Item Type Workflows - [Work item type workflows overview](https://developers.plane.so/api-reference/v2/work-item-type-workflows/overview.md): The Plane API v2 work item type workflow object. Which catalog workflow each work item type uses in a project of a governed workspace, where that answer came from, how a project changes its pick, and the endpoints. - [List work item type workflows](https://developers.plane.so/api-reference/v2/work-item-type-workflows/list-work-item-type-workflows.md): List the catalog workflow each active work item type uses in a project of a governed Plane workspace with the v2 REST API. Governance, source, pickable options, OAuth scopes, error codes, and code examples. - [Get a work item type workflow](https://developers.plane.so/api-reference/v2/work-item-type-workflows/get-work-item-type-workflow.md): Read which catalog workflow one work item type uses in a project of a governed Plane workspace with the v2 REST API. Governance, source, pickable options, OAuth scopes, error codes, and code examples. - [Update a work item type workflow](https://developers.plane.so/api-reference/v2/work-item-type-workflows/update-work-item-type-workflow.md): Set the catalog workflow a project uses for one work item type in a governed Plane workspace with the v2 REST API. PATCH semantics, the dry_run preview, state_mapping, the workflow_mandated and workflow_assigned_by_workspace refusals, OAuth scopes, error codes, and code examples. #### Work Item Type Governance - [Work item type governance overview](https://developers.plane.so/api-reference/v2/work-item-type-governance/overview.md): How a governed Plane workspace decides which workflow each work item type uses in each project. The three governance modes, the allowlist and its in-use lock, pins, acknowledge, the orphan gate, previews, and the v2 endpoints. - [Get work item type governance](https://developers.plane.so/api-reference/v2/work-item-type-governance/get-work-item-type-governance.md): Read a work item type's workflow governance in a governed Plane workspace with the v2 REST API. The mode, the mandated workflow, the allowlist with its in-use lock, OAuth scopes, error codes, and code examples. - [Update work item type governance](https://developers.plane.so/api-reference/v2/work-item-type-governance/update-work-item-type-governance.md): Change a work item type's workflow governance mode in a governed Plane workspace with the v2 REST API. The any, constrained, and required transitions, the in-use lock, acknowledge, state_mapping and the orphan gate, OAuth scopes, error codes, and code examples. - [Preview a governance change](https://developers.plane.so/api-reference/v2/work-item-type-governance/preview-work-item-type-governance.md): Dry-run a work item type governance mode change in a governed Plane workspace with the v2 REST API. How many work items would move and from which states, body parameters, OAuth scopes, error codes, and code examples. - [List workflow pins](https://developers.plane.so/api-reference/v2/work-item-type-governance/list-work-item-type-workflow-pins.md): List the workflow pins on a work item type in a governed Plane workspace with the v2 REST API. Ordering, pagination, sparse fields, OAuth scopes, error codes, and code examples. - [Get a workflow pin](https://developers.plane.so/api-reference/v2/work-item-type-governance/get-work-item-type-workflow-pin.md): Retrieve one workflow pin on a work item type in a governed Plane workspace with the v2 REST API. Path parameters, sparse fields, OAuth scopes, error codes, and code examples. - [Create workflow pins](https://developers.plane.so/api-reference/v2/work-item-type-governance/create-work-item-type-workflow-pin.md): Pin one catalog workflow to a work item type in several projects at once in a governed Plane workspace with the v2 REST API. Body parameters, the allowlist and required-mode rules, OAuth scopes, error codes, and code examples. - [Delete a workflow pin](https://developers.plane.so/api-reference/v2/work-item-type-governance/delete-work-item-type-workflow-pin.md): Remove a workflow pin from a work item type in a governed Plane workspace with the v2 REST API. What unpinning keeps, OAuth scopes, error codes, and code examples. ### Workspace & Admin #### Members - [Members overview](https://developers.plane.so/api-reference/v2/members/overview.md): The Plane API v2 member object. Workspace and project rosters, the role slug, membership ids versus user ids, and expanding the user with ?expand=member. - [List project members](https://developers.plane.so/api-reference/v2/members/list-project-members.md): List the members of a Plane project with the v2 REST API. Role and member filters, search, ordering, pagination, ?expand=member, OAuth scopes, and code examples. - [List workspace members](https://developers.plane.so/api-reference/v2/members/list-workspace-members.md): List the members of a Plane workspace with the v2 REST API. Role and member filters, search, ordering, pagination, ?expand=member, OAuth scopes, and code examples. - [Get a project member](https://developers.plane.so/api-reference/v2/members/get-project-member.md): Read a project member with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get project role distribution](https://developers.plane.so/api-reference/v2/members/get-project-role-distribution.md): Get project role distribution with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a project member](https://developers.plane.so/api-reference/v2/members/create-project-member.md): Create a project member with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a project member](https://developers.plane.so/api-reference/v2/members/update-project-member.md): Update a project member with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a project member](https://developers.plane.so/api-reference/v2/members/delete-project-member.md): Delete a project member with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Remove a workspace member](https://developers.plane.so/api-reference/v2/members/remove-workspace-member.md): Remove a workspace member with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Invitations - [Invitations overview](https://developers.plane.so/api-reference/v2/invitations/overview.md): The Plane API v2 invitation object. Attributes, endpoints, OAuth scopes and behavior. - [List invitations](https://developers.plane.so/api-reference/v2/invitations/list-invitations.md): List invitations with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an invitation](https://developers.plane.so/api-reference/v2/invitations/get-invitation.md): Read an invitation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create an invitation](https://developers.plane.so/api-reference/v2/invitations/create-invitation.md): Create an invitation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an invitation](https://developers.plane.so/api-reference/v2/invitations/delete-invitation.md): Delete an invitation with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Bulk invite members](https://developers.plane.so/api-reference/v2/invitations/bulk-invitations.md): Invite up to 100 people to a Plane workspace in one call with the v2 REST API. Body parameters, roles, skip-existing behavior, OAuth scopes, error codes, and code examples. #### Roles - [Roles overview](https://developers.plane.so/api-reference/v2/roles/overview.md): The Plane API v2 role object. System and custom roles, the permission schemes a role is built from, the permissions it grants, expanding schemes, and the endpoints. - [List roles](https://developers.plane.so/api-reference/v2/roles/list-roles.md): List roles with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a role](https://developers.plane.so/api-reference/v2/roles/get-role.md): Read a role with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Permissions - [Permissions overview](https://developers.plane.so/api-reference/v2/permissions/overview.md): The Plane API v2 permission reads. Your effective permissions in a workspace or project, the permission engine reads that answer one question about one resource, their response objects, and the endpoints. - [Get your effective project permissions](https://developers.plane.so/api-reference/v2/permissions/get-project-permissions.md): Read your relation and every permission you hold in a project with the Plane v2 REST API. The response object, OAuth scopes, error codes, and code examples. - [Get your effective workspace permissions](https://developers.plane.so/api-reference/v2/permissions/get-workspace-permissions.md): Read your relation and every permission you hold in a workspace with the Plane v2 REST API. The response object, OAuth scopes, error codes, and code examples. - [Check a permission](https://developers.plane.so/api-reference/v2/permissions/check-permission.md): Ask whether you can perform one action on one resource with the Plane v2 REST API. Query parameters, the allowed boolean, OAuth scopes, error codes, and code examples. - [List your permissions on a resource](https://developers.plane.so/api-reference/v2/permissions/list-resource-permissions.md): List the actions for one resource with the Plane v2 REST API. Query parameters, the permissions array, OAuth scopes, error codes, and code examples. - [List resources you can access](https://developers.plane.so/api-reference/v2/permissions/list-accessible-resources.md): List the ids of one resource type you can act on with the Plane v2 REST API. Query parameters, the resource_ids array, what counts as access, OAuth scopes, error codes, and code examples. - [Get your relation to a resource](https://developers.plane.so/api-reference/v2/permissions/get-resource-relation.md): Read the role you hold directly on one resource with the Plane v2 REST API. Query parameters, the relation field, why it can be null, OAuth scopes, error codes, and code examples. #### Permission Grants - [Permission grants overview](https://developers.plane.so/api-reference/v2/permission-grants/overview.md): The Plane API v2 permission grant object. Who or what holds which relation on which resource, extra and denied permissions, expiry, who can manage grants, and the endpoints. - [List permission grants](https://developers.plane.so/api-reference/v2/permission-grants/list-permission-grants.md): List the permission grants on one resource with the Plane v2 REST API. The required resource_type and resource_id pair, the manage permission, ordering, pagination, OAuth scopes, error codes, and code examples. - [Get a permission grant](https://developers.plane.so/api-reference/v2/permission-grants/get-permission-grant.md): Retrieve one permission grant with the Plane v2 REST API. Path parameters, the manage permission, expired grants, OAuth scopes, error codes, and code examples. - [Create a permission grant](https://developers.plane.so/api-reference/v2/permission-grants/create-permission-grant.md): Give a user or teamspace a relation on a resource with the Plane v2 REST API. Body parameters, replace-on-repeat behavior, the manage permission, OAuth scopes, error codes, and code examples. - [Update a permission grant](https://developers.plane.so/api-reference/v2/permission-grants/update-permission-grant.md): Change the relation, extra or denied permissions, or expiry of a permission grant with the Plane v2 REST API. Partial PATCH semantics, the manage permission, OAuth scopes, error codes, and code examples. - [Delete a permission grant](https://developers.plane.so/api-reference/v2/permission-grants/delete-permission-grant.md): Revoke a permission grant with the Plane v2 REST API. What revoking removes, the manage permission, OAuth scopes, error codes, and code examples. #### Permission Schemes - [Permission schemes overview](https://developers.plane.so/api-reference/v2/permission-schemes/overview.md): The Plane API v2 permission scheme object. Attributes, endpoints, OAuth scopes and behavior. - [List permission schemes](https://developers.plane.so/api-reference/v2/permission-schemes/list-permission-schemes.md): List permission schemes with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a permission scheme](https://developers.plane.so/api-reference/v2/permission-schemes/get-permission-scheme.md): Read a permission scheme with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Workspace Features - [Workspace features overview](https://developers.plane.so/api-reference/v2/workspace-features/overview.md): The Plane API v2 workspace feature object. Every feature flag explained, how is_work_item_types_enabled selects the work item type mode, and how to read and toggle features. - [Get workspace features](https://developers.plane.so/api-reference/v2/workspace-features/get-workspace-features.md): Read a Plane workspace's feature flags with the v2 REST API, including is_work_item_types_enabled — the work item type mode discriminator. Scopes, errors, and code examples. - [Update workspace features](https://developers.plane.so/api-reference/v2/workspace-features/update-workspace-features.md): Toggle a Plane workspace's feature flags with the v2 REST API, including switching the work item type mode. Body parameters, scopes, error codes, and code examples. #### Audit Logs - [Audit logs overview](https://developers.plane.so/api-reference/v2/audit-logs/overview.md): The Plane API v2 audit log object. Actor, target, category, outcome and source enums, old and new values, and how to query the workspace audit trail for compliance and security investigations. - [List audit logs](https://developers.plane.so/api-reference/v2/audit-logs/list-audit-logs.md): Query a Plane workspace's audit trail with the v2 REST API. Date-range, actor, category, outcome and target filters, cursor pagination for exports, scopes, errors, and code examples. - [Get an audit log](https://developers.plane.so/api-reference/v2/audit-logs/get-audit-log.md): Retrieve a single Plane audit log entry by id with the v2 REST API. Path parameters, the full entry payload, OAuth scopes, error codes, and code examples. #### Group Sync - [Group sync overview](https://developers.plane.so/api-reference/v2/group-sync/overview.md): The Plane API v2 group mapping object. Attributes, endpoints, OAuth scopes and behavior. - [List project mappings](https://developers.plane.so/api-reference/v2/group-sync/list-project-mappings.md): List project mappings with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [List workspace mappings](https://developers.plane.so/api-reference/v2/group-sync/list-workspace-mappings.md): List workspace mappings with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get the group sync configuration](https://developers.plane.so/api-reference/v2/group-sync/get-group-sync-config.md): Read a group sync config with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a project mapping](https://developers.plane.so/api-reference/v2/group-sync/get-project-mapping.md): Read a project mapping with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a workspace mapping](https://developers.plane.so/api-reference/v2/group-sync/get-workspace-mapping.md): Read a workspace mapping with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a project mapping](https://developers.plane.so/api-reference/v2/group-sync/create-project-mapping.md): Create a project mapping with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workspace mapping](https://developers.plane.so/api-reference/v2/group-sync/create-workspace-mapping.md): Create a workspace mapping with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update the group sync configuration](https://developers.plane.so/api-reference/v2/group-sync/update-group-sync-config.md): Update the group sync configuration with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a project mapping](https://developers.plane.so/api-reference/v2/group-sync/update-project-mapping.md): Update a project mapping with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Update a workspace mapping](https://developers.plane.so/api-reference/v2/group-sync/update-workspace-mapping.md): Update a workspace mapping with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a project mapping](https://developers.plane.so/api-reference/v2/group-sync/delete-project-mapping.md): Delete a project mapping with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a workspace mapping](https://developers.plane.so/api-reference/v2/group-sync/delete-workspace-mapping.md): Delete a workspace mapping with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Webhooks - [Webhooks overview](https://developers.plane.so/api-reference/v2/webhooks/overview.md): The Plane API v2 webhook object. Attributes, event scopes, rich and PQL delivery filters, the signing secret, and the endpoints. - [List webhooks](https://developers.plane.so/api-reference/v2/webhooks/list-webhooks.md): List webhooks with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a webhook](https://developers.plane.so/api-reference/v2/webhooks/get-webhook.md): Read a webhook with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a webhook](https://developers.plane.so/api-reference/v2/webhooks/create-webhook.md): Create a webhook with the Plane v2 REST API. Body parameters, event scopes, rich and PQL delivery filters, the one-time signing secret, OAuth scopes, error codes, and code examples. - [Update a webhook](https://developers.plane.so/api-reference/v2/webhooks/update-webhook.md): Update a webhook with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a webhook](https://developers.plane.so/api-reference/v2/webhooks/delete-webhook.md): Delete a webhook with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Regenerate a webhook secret](https://developers.plane.so/api-reference/v2/webhooks/regenerate-webhook-secret.md): Regenerate a webhook secret with the Plane v2 REST API. Parameters, OAuth scopes, error codes, and code examples. #### Webhook Logs - [Webhook logs overview](https://developers.plane.so/api-reference/v2/webhook-logs/overview.md): The Plane API v2 webhook log object. Attributes, endpoints, OAuth scopes and behavior. - [List webhook logs](https://developers.plane.so/api-reference/v2/webhook-logs/list-webhook-logs.md): List webhook logs with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a webhook log](https://developers.plane.so/api-reference/v2/webhook-logs/get-webhook-log.md): Read a webhook log with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Workspace Assets - [Workspace assets overview](https://developers.plane.so/api-reference/v2/workspace-assets/overview.md): The Plane API v2 workspace asset object. Attributes, endpoints, OAuth scopes and behavior. - [List workspace assets](https://developers.plane.so/api-reference/v2/workspace-assets/list-workspace-assets.md): List workspace assets with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get an asset](https://developers.plane.so/api-reference/v2/workspace-assets/get-asset.md): Read an asset with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a workspace asset upload](https://developers.plane.so/api-reference/v2/workspace-assets/create-workspace-asset.md): Create an asset with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete an asset](https://developers.plane.so/api-reference/v2/workspace-assets/delete-asset.md): Delete an asset with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Confirm a workspace asset upload](https://developers.plane.so/api-reference/v2/workspace-assets/confirm-workspace-asset.md): Update an asset with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### User Assets - [User assets overview](https://developers.plane.so/api-reference/v2/user-assets/overview.md): The Plane API v2 user asset object. Attributes, endpoints, OAuth scopes and behavior. - [List user assets](https://developers.plane.so/api-reference/v2/user-assets/list-user-assets.md): List user assets with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Get a user asset](https://developers.plane.so/api-reference/v2/user-assets/get-user-asset.md): Read a user asset with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Create a user asset upload](https://developers.plane.so/api-reference/v2/user-assets/create-user-asset.md): Create a user asset with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Delete a user asset](https://developers.plane.so/api-reference/v2/user-assets/delete-user-asset.md): Delete a user asset with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. - [Confirm a user asset upload](https://developers.plane.so/api-reference/v2/user-assets/confirm-user-asset.md): Update a user asset with the Plane v2 REST API. Parameters, sparse `?fields=` responses, OAuth scopes, error codes, and code examples. #### Users - [Users overview](https://developers.plane.so/api-reference/v2/users/overview.md): The Plane API v2 users resource. GET /api/v2/users/me/ echoes the calling principal — its kind, identity, and granted OAuth scopes — and is the first call to make when verifying credentials. - [Get current user](https://developers.plane.so/api-reference/v2/users/get-current-user.md): Verify Plane API v2 credentials with GET /api/v2/users/me/. Returns the calling principal — id, display name, email, principal_kind, and granted OAuth scopes. Errors and code examples. #### Notifications - [Notifications overview](https://developers.plane.so/api-reference/v2/notifications/overview.md): The Plane API v2 notification object. Your own read-only inbox, every entity type, archived and read state, the data payload, and how the API differs from v1. - [List notifications](https://developers.plane.so/api-reference/v2/notifications/list-notifications.md): List your own notifications in a Plane workspace with the v2 REST API. Read, archived, mention, and entity filters, ordering, pagination, expand, OAuth scopes, error codes, and code examples. - [Get a notification](https://developers.plane.so/api-reference/v2/notifications/get-notification.md): Retrieve one of your notifications with the Plane v2 REST API. Path parameters, archived notifications, expand, OAuth scopes, error codes, and code examples. #### Artifacts - [Artifacts overview](https://developers.plane.so/api-reference/v2/artifacts/overview.md): The Plane API v2 artifact object. Versioned HTML dashboards generated by Plane Intelligence, their data modes, publish anchors, and endpoints. - [Get an artifact](https://developers.plane.so/api-reference/v2/artifacts/get-artifact.md): Read a Plane artifact's metadata and current HTML with the v2 REST API. Path parameters, OAuth scopes, error codes, and code examples. - [Create an artifact](https://developers.plane.so/api-reference/v2/artifacts/create-artifact.md): Create a versioned HTML artifact in a Plane workspace with the v2 REST API. Body parameters, data modes, OAuth scopes, error codes, and code examples. - [Append a new version](https://developers.plane.so/api-reference/v2/artifacts/update-artifact.md): Append a new HTML version to a Plane artifact with the v2 REST API. Append-only versioning, body parameters, OAuth scopes, error codes, and code examples. - [Publish an artifact](https://developers.plane.so/api-reference/v2/artifacts/publish-artifact.md): Publish a Plane artifact to a shareable anchor with the v2 REST API. Bodyless POST, idempotent behavior, OAuth scopes, error codes, and code examples. ### 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. - [Page content HTML](https://developers.plane.so/api-reference/page/page-content-html.md): Format page body HTML, use Plane editor components, and attach files through the Workspace Page 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. - [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. - [Update a workspace page](https://developers.plane.so/api-reference/page/update-workspace-page.md): Update the title or content of a workspace page via the Plane API. - [Archive a workspace page](https://developers.plane.so/api-reference/page/archive-workspace-page.md): Archive a workspace page via the Plane API before deleting it. - [Restore a workspace page](https://developers.plane.so/api-reference/page/restore-workspace-page.md): Restore an archived workspace page via the Plane API. - [Delete a workspace page](https://developers.plane.so/api-reference/page/delete-workspace-page.md): Delete an archived workspace page via the Plane API. - [Retrieve workspace page attachment metadata](https://developers.plane.so/api-reference/page/get-workspace-page-attachment.md): Retrieve metadata for an attachment linked to a workspace page. - [Confirm a workspace page attachment upload](https://developers.plane.so/api-reference/page/confirm-workspace-page-attachment-upload.md): Confirm the upload status of an attachment linked to a workspace page. - [Download a workspace page attachment](https://developers.plane.so/api-reference/page/download-workspace-page-attachment.md): Download an uploaded workspace page attachment through a presigned redirect. - [Delete a workspace page attachment](https://developers.plane.so/api-reference/page/delete-workspace-page-attachment.md): Delete an attachment linked to a workspace page via the Plane API. - [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 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. - [Update a project page](https://developers.plane.so/api-reference/page/update-project-page.md): Update the title or content of a project page via the Plane API. - [Archive a project page](https://developers.plane.so/api-reference/page/archive-project-page.md): Archive a project page via the Plane API before deleting it. - [Restore a project page](https://developers.plane.so/api-reference/page/restore-project-page.md): Restore an archived project page via the Plane API. - [Delete a project page](https://developers.plane.so/api-reference/page/delete-project-page.md): Delete an archived project page via the Plane API. #### Collections - [Collection API overview](https://developers.plane.so/api-reference/collection/overview.md): Organize Plane workspace pages into public or private collections and manage collection membership. - [List collections](https://developers.plane.so/api-reference/collection/list-collections.md): List the collections visible to the authenticated user in a Plane workspace. - [Create a collection](https://developers.plane.so/api-reference/collection/create-collection.md): Create a public or private collection in a Plane workspace. - [Retrieve a collection](https://developers.plane.so/api-reference/collection/retrieve-collection.md): Retrieve a visible Plane workspace collection by ID. - [Update a collection](https://developers.plane.so/api-reference/collection/update-collection.md): Update a Plane collection's name, logo, or sort order. - [Delete a collection](https://developers.plane.so/api-reference/collection/delete-collection.md): Delete a non-default Plane collection and optionally preserve its pages. - [List collection members](https://developers.plane.so/api-reference/collection/list-collection-members.md): List users who have explicit access to a Plane collection. - [Add a collection member](https://developers.plane.so/api-reference/collection/add-collection-member.md): Grant a workspace user access to a private Plane collection. - [Update a collection member](https://developers.plane.so/api-reference/collection/update-collection-member.md): Change a Plane collection member's access level. - [Remove a collection member](https://developers.plane.so/api-reference/collection/remove-collection-member.md): Revoke a user's explicit access to a private Plane collection. - [List collection pages](https://developers.plane.so/api-reference/collection/list-collection-pages.md): List and filter a branch of pages in a Plane collection. - [Search addable collection pages](https://developers.plane.so/api-reference/collection/search-collection-pages.md): Search for workspace pages that can be added to a Plane collection. - [Add pages to a collection](https://developers.plane.so/api-reference/collection/add-collection-pages.md): Add one or more Plane workspace page trees to a collection. - [Move or reorder a collection page](https://developers.plane.so/api-reference/collection/move-or-reorder-collection-page.md): Move a Plane page tree to another collection or change its collection order. - [Remove a page from a collection](https://developers.plane.so/api-reference/collection/remove-collection-page.md): Remove a Plane page tree from its collection. #### 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. #### Releases - [Overview](https://developers.plane.so/api-reference/release/overview.md): Plane Release API overview. Learn about endpoints, request/response format, and how to work with releases via REST API. - [Create a release](https://developers.plane.so/api-reference/release/add-release.md): Create a release via Plane API. HTTP POST request format, required fields, and example responses. - [List all releases](https://developers.plane.so/api-reference/release/list-releases.md): List all releases via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [Retrieve a release](https://developers.plane.so/api-reference/release/get-release-detail.md): Get retrieve a release details via Plane API. Retrieve complete information for a specific resource. - [Update a release](https://developers.plane.so/api-reference/release/update-release-detail.md): Update a release via Plane API. HTTP PATCH request format, editable fields, and example responses. - [Delete a release](https://developers.plane.so/api-reference/release/delete-release.md): Permanently delete a release via Plane API. Removes the release. Returns 204 on success. #### Project Releases - [Create a project release](https://developers.plane.so/api-reference/release/add-project-release.md): Create a release for a project via Plane API. HTTP POST request format, required fields, and example responses. - [List all project releases](https://developers.plane.so/api-reference/release/list-project-releases.md): List all releases for a project via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [Retrieve a project release](https://developers.plane.so/api-reference/release/get-project-release-detail.md): Get retrieve a project release details via Plane API. Retrieve complete information for a specific resource. - [Update a project release](https://developers.plane.so/api-reference/release/update-project-release-detail.md): Update a project release via Plane API. HTTP PATCH request format, editable fields, and example responses. - [Delete a project release](https://developers.plane.so/api-reference/release/delete-project-release.md): Permanently delete a project release via Plane API. Removes the release. Returns 204 on success. #### Release Work Items - [Add work items to release](https://developers.plane.so/api-reference/release/add-release-work-items.md): Add work items to release via Plane API. HTTP POST request format, required fields, and example responses. - [List all work items in a release](https://developers.plane.so/api-reference/release/list-release-work-items.md): List all work items in a release via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [Remove work items from release](https://developers.plane.so/api-reference/release/remove-release-work-items.md): Remove work items from release via Plane API. HTTP DELETE request for removing resources. #### Release Labels - [Create a release label](https://developers.plane.so/api-reference/release/add-release-label.md): Create a release label via Plane API. HTTP POST request format, required fields, and example responses. - [List all release labels](https://developers.plane.so/api-reference/release/list-release-labels.md): List all release labels via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [Retrieve a release label](https://developers.plane.so/api-reference/release/get-release-label-detail.md): Get retrieve a release label details via Plane API. Retrieve complete information for a specific resource. - [Update a release label](https://developers.plane.so/api-reference/release/update-release-label-detail.md): Update a release label via Plane API. HTTP PATCH request format, editable fields, and example responses. - [Delete a release label](https://developers.plane.so/api-reference/release/delete-release-label.md): Permanently delete a release label via Plane API. Removes the label from the workspace catalog. Returns 204 on success. - [Add labels to release](https://developers.plane.so/api-reference/release/add-labels-to-release.md): Create labels to release via Plane API. HTTP POST request format, required fields, and example responses. - [List labels for a release](https://developers.plane.so/api-reference/release/list-labels-for-release.md): List labels for a release via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [Remove labels from release](https://developers.plane.so/api-reference/release/remove-labels-from-release.md): Delete labels from release via Plane API. HTTP DELETE request for removing resources. #### Release Tags - [Create a release tag](https://developers.plane.so/api-reference/release/add-release-tag.md): Create a release tag via Plane API. HTTP POST request format, required fields, and example responses. - [List all release tags](https://developers.plane.so/api-reference/release/list-release-tags.md): List all release tags via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [Retrieve a release tag](https://developers.plane.so/api-reference/release/get-release-tag-detail.md): Get retrieve a release tag details via Plane API. Retrieve complete information for a specific resource. - [Update a release tag](https://developers.plane.so/api-reference/release/update-release-tag-detail.md): Update a release tag via Plane API. HTTP PATCH request format, editable fields, and example responses. - [Delete a release tag](https://developers.plane.so/api-reference/release/delete-release-tag.md): Permanently delete a release tag via Plane API. Removes the release tag. Returns 204 on success. #### Release Comments - [Create a release comment](https://developers.plane.so/api-reference/release/add-release-comment.md): Create a release comment via Plane API. HTTP POST request format, required fields, and example responses. - [List all release comments](https://developers.plane.so/api-reference/release/list-release-comments.md): List all release comments via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [Retrieve a release comment](https://developers.plane.so/api-reference/release/get-release-comment-detail.md): Get retrieve a release comment details via Plane API. Retrieve complete information for a specific resource. - [Update a release comment](https://developers.plane.so/api-reference/release/update-release-comment-detail.md): Update a release comment via Plane API. HTTP PATCH request format, editable fields, and example responses. - [Delete a release comment](https://developers.plane.so/api-reference/release/delete-release-comment.md): Permanently delete a release comment via Plane API. Removes the comment. Returns 204 on success. #### Release Links - [Create a release link](https://developers.plane.so/api-reference/release/add-release-link.md): Create a release link via Plane API. HTTP POST request format, required fields, and example responses. - [List all release links](https://developers.plane.so/api-reference/release/list-release-links.md): List all release links via Plane API. HTTP GET request with pagination, filtering, and query parameters. - [Retrieve a release link](https://developers.plane.so/api-reference/release/get-release-link-detail.md): Get retrieve a release link details via Plane API. Retrieve complete information for a specific resource. - [Update a release link](https://developers.plane.so/api-reference/release/update-release-link-detail.md): Update a release link via Plane API. HTTP PATCH request format, editable fields, and example responses. - [Delete a release link](https://developers.plane.so/api-reference/release/delete-release-link.md): Permanently delete a release link via Plane API. Removes the link. Returns 204 on success. #### Release Changelog - [Retrieve a release changelog](https://developers.plane.so/api-reference/release/get-release-changelog.md): Get retrieve a release changelog details via Plane API. Retrieve complete information for a specific resource. - [Update a release changelog](https://developers.plane.so/api-reference/release/update-release-changelog.md): Update a release changelog via Plane API. HTTP PATCH request format, editable fields, and example responses. #### 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. - [Update project group mapping by key](https://developers.plane.so/api-reference/idp-group-sync/update-project-mapping-by-key.md): Update a project group mapping by project identifier and IdP group name via Plane API. HTTP request format, parameters, scopes, and example responses. - [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 Claude, ChatGPT, Codex, Cursor, VS Code, Windsurf, Zed, and Antigravity to Plane over MCP. Endpoints, OAuth and access-token auth, per-client setup, security, and troubleshooting. - [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 the MCP server](https://developers.plane.so/dev-tools/mcp-server-self-host.md): Deploy the Plane MCP server with Docker Compose, the standalone Helm chart, or inside the Plane Commercial Edition Helm chart; register OAuth callbacks, configure storage and security, and connect AI clients. - [MCP server tool reference](https://developers.plane.so/dev-tools/mcp-server-tools.md): Reference for the 30 tools and 207 actions exposed by the Plane MCP server — work items, cycles, modules, releases, customers, pages, collections, templates, 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. ## Related documentation - [Plane product documentation](https://docs.plane.so/llms.txt): Index of docs.plane.so — how to use Plane: workspaces, projects, work items, cycles, modules, pages, integrations, importers, automations, and Plane AI. - [Core concepts](https://docs.plane.so/introduction/core-concepts.md): The building blocks the API exposes — workspaces, projects, work items, cycles, modules, views, and pages. - [Quickstart](https://docs.plane.so/introduction/quickstart.md): Set up a workspace and a first project. - [Roles and permissions](https://docs.plane.so/roles-and-permissions/overview.md): What each workspace and project role is allowed to do. ## Optional - [Complete documentation in one file](https://developers.plane.so/llms-full.txt): Every page of developers.plane.so concatenated as Markdown (about 1.6 MB). - [Sitemap](https://developers.plane.so/sitemap.xml): Every page URL on developers.plane.so. - [Plane on GitHub](https://github.com/makeplane/plane): Source code, issues, and releases. - [plane.so](https://plane.so): Product website, pricing, and sign-up.