# Plane ## Docs - [Self-host Plane](https://developers.plane.so/self-hosting/overview.md): Self-hosting allows you to have full control over your applications and data. It’s a great way to ensure privacy, control, and customization. - [Understanding Plane's editions](https://developers.plane.so/self-hosting/editions-and-versions.md) - [Plane self-hosted architecture](https://developers.plane.so/self-hosting/plane-architecture.md) - [Docker Compose](https://developers.plane.so/self-hosting/methods/docker-compose.md) - [Docker AIO (All-in-One) • Commercial Edition](https://developers.plane.so/self-hosting/methods/docker-aio.md) - [Deploy Plane with Docker Swarm • Commercial Edition](https://developers.plane.so/self-hosting/methods/docker-swarm.md) - [Kubernetes](https://developers.plane.so/self-hosting/methods/kubernetes.md) - [Deploy Plane with Podman Quadlets • Commercial Edition](https://developers.plane.so/self-hosting/methods/podman-quadlets.md) - [Airgapped deployment architecture](https://developers.plane.so/self-hosting/methods/airgapped-requirements.md) - [Deploy Plane Commercial in an Airgapped Docker Environment](https://developers.plane.so/self-hosting/methods/airgapped-edition.md) - [Deploy Plane Commercial in an Airgapped Kubernetes Environment](https://developers.plane.so/self-hosting/methods/airgapped-edition-kubernetes.md) - [Clone Docker images to your private registry](https://developers.plane.so/self-hosting/methods/clone-docker-images.md): Transfer Plane Enterprise Docker images from the artifact registry to your private registry for airgapped deployments using the crane tool. - [Deploy Plane with Coolify • Commercial Edition](https://developers.plane.so/self-hosting/methods/coolify.md) - [Deploy Plane with Portainer • Commercial Edition](https://developers.plane.so/self-hosting/methods/portainer.md) - [Instance admin and God mode](https://developers.plane.so/self-hosting/govern/instance-admin.md): Starting 0.14, we are introducing a new role for self-managed instances called `Instance admin`. - [Overview](https://developers.plane.so/self-hosting/govern/authentication.md): Plane offers several methods you can choose from to let your users log in to your Plane instance. Configure these methods in `Authentication` on `/god-mode` of your instance. - [Google OAuth](https://developers.plane.so/self-hosting/govern/google-oauth.md) - [Github OAuth](https://developers.plane.so/self-hosting/govern/github-oauth.md) - [OIDC SSO](https://developers.plane.so/self-hosting/govern/oidc-sso.md) - [SAML SSO](https://developers.plane.so/self-hosting/govern/saml-sso.md) - [LDAP authentication](https://developers.plane.so/self-hosting/govern/ldap.md) - [Reset password](https://developers.plane.so/self-hosting/govern/reset-password.md): Users can reset their password through the terminal of the Plane application. You need to login to backend docker container and run the below command for resetting a user's password. - [Configure SMTP for email notifications](https://developers.plane.so/self-hosting/govern/communication.md): Either during your set-up or sometime later, you will want to set SMTP settings to let your users get emails to reset passwords, onboard themselves right, and get notifications for changes, and receive exports of your data. - [Configure external PostgreSQL, Redis and S3 storage](https://developers.plane.so/self-hosting/govern/database-and-storage.md) - [Custom domain](https://developers.plane.so/self-hosting/govern/custom-domain.md): Host your Plane instance in your custom domain. - [Set up SSL • Commercial Edition](https://developers.plane.so/self-hosting/govern/configure-ssl.md) - [Switch from public to private buckets • Commercial Edition](https://developers.plane.so/self-hosting/govern/private-bucket.md) - [Configure GitHub App for Plane integration](https://developers.plane.so/self-hosting/govern/integrations/github.md) - [Configure GitLab Application for Plane integration](https://developers.plane.so/self-hosting/govern/integrations/gitlab.md) - [Set up Sentry integration for self-hosted Plane](https://developers.plane.so/self-hosting/govern/integrations/sentry.md): Configure Sentry error tracking and issue creation for your self-hosted Plane instance by creating a custom integration and connecting it to your workspace. - [Configure Slack App for Plane integration](https://developers.plane.so/self-hosting/govern/integrations/slack.md) - [Configure DNS for Intake Email](https://developers.plane.so/self-hosting/govern/configure-dns-email-service.md): Configure DNS records to enable automatic conversion of incoming emails into work items in your project's Intake section. - [Configure OpenSearch for advanced search](https://developers.plane.so/self-hosting/govern/advanced-search.md) - [Configure external secrets for Kubernetes deployments](https://developers.plane.so/self-hosting/govern/external-secrets.md) - [Configure external reverse proxy • Commercial Edition](https://developers.plane.so/self-hosting/govern/reverse-proxy.md) - [Environment variables reference guide](https://developers.plane.so/self-hosting/govern/environment-variables.md) - [Data collection and usage](https://developers.plane.so/self-hosting/telemetry.md) - [Upgrade from Community to Commercial Edition](https://developers.plane.so/self-hosting/upgrade-from-community.md) - [Upgrade from Community to Airgapped Edition](https://developers.plane.so/self-hosting/manage/community-to-airgapped.md) - [Backup and restore data](https://developers.plane.so/self-hosting/manage/backup-restore.md) - [Update Plane version](https://developers.plane.so/self-hosting/manage/upgrade-plane.md) - [Mandatory checkpoint at v0.14.0 • Community Edition](https://developers.plane.so/self-hosting/manage/upgrade-from-0.13.2-0.14.0.md) - [Activate Pro and Business licenses](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-pro-and-business.md) - [Activate Enterprise license](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-enterprise.md) - [Activate Airgapped Edition license](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-airgapped.md) - [View container logs](https://developers.plane.so/self-hosting/manage/view-logs.md) - [Move your Plane instance to a new server • Commercial Edition](https://developers.plane.so/self-hosting/manage/migrate-plane.md) - [Command line tools](https://developers.plane.so/self-hosting/manage/prime-cli.md) - [Installation errors](https://developers.plane.so/self-hosting/troubleshoot/installation-errors.md) - [License errors](https://developers.plane.so/self-hosting/troubleshoot/license-errors.md) - [CLI errors](https://developers.plane.so/self-hosting/troubleshoot/cli-errors.md) - [Storage errors](https://developers.plane.so/self-hosting/troubleshoot/storage-errors.md) - [Plane API Documentation](https://developers.plane.so/api-reference/introduction.md): The Plane API is organized around REST. Our API has predictable resource-oriented URLs, accepts application/json request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs. - [Overview](https://developers.plane.so/api-reference/project/overview.md) - [Create a project](https://developers.plane.so/api-reference/project/add-project.md): Creates a new project in a workspace. - [List all projects](https://developers.plane.so/api-reference/project/list-projects.md): Returns a list of all projects in a workspace. Projects are returned in order of creation, with the most recently created projects appearing first. - [Retrieve a project](https://developers.plane.so/api-reference/project/get-project-detail.md): Retrieves the details of an existing project - [Update a project](https://developers.plane.so/api-reference/project/update-project-detail.md): Updates an existing project by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a project](https://developers.plane.so/api-reference/project/delete-project.md): Permanently deletes a project and all its associated data. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/state/overview.md) - [Create a state](https://developers.plane.so/api-reference/state/add-state.md): Creates a new state in a project. - [List all states](https://developers.plane.so/api-reference/state/list-states.md): Returns a list of all states in a project. States are returned in sequence order within their state groups. - [Retrieve a state](https://developers.plane.so/api-reference/state/get-state-detail.md): Retrieves the details of an existing state by its ID. - [Update a state](https://developers.plane.so/api-reference/state/update-state-detail.md): Updates an existing state by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a state](https://developers.plane.so/api-reference/state/delete-state.md): Permanently deletes a state from a project. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/label/overview.md) - [Create a label](https://developers.plane.so/api-reference/label/add-label.md): Creates a new label in a project. - [List all labels](https://developers.plane.so/api-reference/label/list-labels.md): Returns a list of all labels in a project. Labels are returned in sort order. - [Retrieve a label](https://developers.plane.so/api-reference/label/get-label-detail.md): Retrieves the details of an existing label by its ID. - [Update a label](https://developers.plane.so/api-reference/label/update-label-detail.md): Updates an existing label by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a label](https://developers.plane.so/api-reference/label/delete-label.md): Permanently deletes a label from a project. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/issue/overview.md) - [Create a work item](https://developers.plane.so/api-reference/issue/add-issue.md): Creates a new work item in a project. - [List all work items](https://developers.plane.so/api-reference/issue/list-issues.md): Returns a list of all work items in a project. - [Retrieve a work item by ID](https://developers.plane.so/api-reference/issue/get-issue-detail.md): Retrieves the details of an existing work item by its ID. - [Retrieve a work item by identifier](https://developers.plane.so/api-reference/issue/get-issue-sequence-id.md): Retrieves the details of a work item using its readable identifier (e.g., PROJ-123). - [Search work items](https://developers.plane.so/api-reference/issue/search-issues.md): Searches for work items across a workspace by text query. - [Update a work item](https://developers.plane.so/api-reference/issue/update-issue-detail.md): Updates an existing work item by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a work item](https://developers.plane.so/api-reference/issue/delete-issue.md): Permanently deletes a work item from a project. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/link/overview.md) - [Create a link](https://developers.plane.so/api-reference/link/add-link.md): Creates a new link attached to a work item. - [List all links](https://developers.plane.so/api-reference/link/list-links.md): Returns a list of all links attached to a work item. - [Retrieve a link](https://developers.plane.so/api-reference/link/get-link-detail.md): Retrieves the details of an existing link by its ID. - [Update a link](https://developers.plane.so/api-reference/link/update-link-detail.md): Updates an existing link by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a link](https://developers.plane.so/api-reference/link/delete-link.md): Permanently deletes a link from a work item. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/issue-activity/overview.md) - [List all work item activity](https://developers.plane.so/api-reference/issue-activity/list-issue-activities.md): Returns a list of all activities for a work item, ordered chronologically. - [Retrieve a work item activity](https://developers.plane.so/api-reference/issue-activity/get-issue-activity-detail.md): Retrieves the details of an existing work item activity by its ID. - [Overview](https://developers.plane.so/api-reference/issue-comment/overview.md) - [Create a work item comment](https://developers.plane.so/api-reference/issue-comment/add-issue-comment.md): Creates a new comment on a work item. - [List all work item comments](https://developers.plane.so/api-reference/issue-comment/list-issue-comments.md): Returns a list of all comments on a work item, ordered chronologically. - [Retrieve a work item comment](https://developers.plane.so/api-reference/issue-comment/get-issue-comment-detail.md): Retrieves the details of an existing work item comment by its ID. - [Update a work item comment](https://developers.plane.so/api-reference/issue-comment/update-issue-comment-detail.md): Updates an existing work item comment by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a work item comment](https://developers.plane.so/api-reference/issue-comment/delete-issue-comment.md): Permanently deletes a comment from a work item. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/issue-attachments/overview.md) - [List all attachments](https://developers.plane.so/api-reference/issue-attachments/get-attachments.md): Returns a list of all attachments for a work item. - [Retrieve an attachment](https://developers.plane.so/api-reference/issue-attachments/get-attachment-detail.md): Retrieves the details of an existing attachment by its ID. - [Get upload credentials](https://developers.plane.so/api-reference/issue-attachments/get-upload-credentials.md): Creates a pre-signed POST form data for uploading an attachment directly to S3. This endpoint handles the first step of the two-and-a-half step upload process where you first get the upload credentials and then use them to upload the actual file. - [Upload file](https://developers.plane.so/api-reference/issue-attachments/upload-file.md): Upload the file using the credentials generated by the [Get upload credentials](/api-reference/issue-attachments/get-upload-credentials) endpoint. - [Complete upload](https://developers.plane.so/api-reference/issue-attachments/complete-upload.md): Notifies the server that an attachment has been successfully uploaded to S3. This endpoint should be called after you've [uploaded the file](/api-reference/issue-attachments/upload-file). - [Update an attachment](https://developers.plane.so/api-reference/issue-attachments/update-attachment.md): Updates an existing attachment by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete an attachment](https://developers.plane.so/api-reference/issue-attachments/delete-attachment.md): Permanently deletes an attachment from a work item. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/issue-types/types/overview.md) - [Create a work item type](https://developers.plane.so/api-reference/issue-types/types/add-issue-type.md): Creates a new work item type in a project. - [List all work item types](https://developers.plane.so/api-reference/issue-types/types/list-issue-types.md): Returns a list of all work item types in a project. - [Retrieve a work item type](https://developers.plane.so/api-reference/issue-types/types/get-issue-type-details.md): Retrieves the details of an existing work item type by its ID. - [Update a work item type](https://developers.plane.so/api-reference/issue-types/types/update-issue-types.md): Updates an existing work item type by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a work item type](https://developers.plane.so/api-reference/issue-types/types/delete-issue-type.md): Permanently deletes a work item type from a project. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/issue-types/properties/overview.md) - [Create a custom property](https://developers.plane.so/api-reference/issue-types/properties/add-property.md): Creates a new custom property for a work item type. - [List custom properties](https://developers.plane.so/api-reference/issue-types/properties/list-properties.md): Returns a list of all custom properties for a work item type. - [Retrieve a custom property](https://developers.plane.so/api-reference/issue-types/properties/get-property-details.md): Retrieves the details of an existing custom property by its ID. - [Update a custom property](https://developers.plane.so/api-reference/issue-types/properties/update-property.md): Updates an existing custom property by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a custom property](https://developers.plane.so/api-reference/issue-types/properties/delete-property.md): Permanently deletes a custom property from a work item type. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/issue-types/values/overview.md) - [Add custom property values](https://developers.plane.so/api-reference/issue-types/values/add-property-values.md): Allows you to specify the values for a custom property. - [List all custom property values](https://developers.plane.so/api-reference/issue-types/values/list-property-values.md): Returns a list of all values for a custom property on a work item. - [Overview](https://developers.plane.so/api-reference/issue-types/options/overview.md) - [Add dropdown options](https://developers.plane.so/api-reference/issue-types/options/add-dropdown-options.md): Allows you to define a list of options for the dropdown property type. - [List all dropdown options](https://developers.plane.so/api-reference/issue-types/options/list-dropdown-options.md): Retrieves all available options for a specific dropdown custom property. - [Retrieve option details](https://developers.plane.so/api-reference/issue-types/options/get-option-details.md): Retrieves information about a specific option within a dropdown property. - [Update dropdown options](https://developers.plane.so/api-reference/issue-types/options/update-dropdown-options.md): Lets you modify existing options within a dropdown property. - [Delete dropdown options](https://developers.plane.so/api-reference/issue-types/options/delete-dropdown-options.md): Enables you to remove specific options from a dropdown custom property. - [Overview](https://developers.plane.so/api-reference/cycle/overview.md) - [Create a cycle](https://developers.plane.so/api-reference/cycle/add-cycle.md): Creates a new cycle in a project. - [Add work items to cycle](https://developers.plane.so/api-reference/cycle/add-cycle-work-items.md): Adds work items (issues) to a cycle - [Transfer cycle work items](https://developers.plane.so/api-reference/cycle/transfer-cycle-work-items.md): Transfers all work items from one cycle to another. - [Archive a cycle](https://developers.plane.so/api-reference/cycle/archive-cycle.md): Archives a cycle, while preserving its data. - [List all cycles](https://developers.plane.so/api-reference/cycle/list-cycles.md): Returns a list of all cycles in a project. - [Retrieve a cycle](https://developers.plane.so/api-reference/cycle/get-cycle-detail.md): Retrieves the details of an existing cycle by its ID. - [List all work items in a cycle](https://developers.plane.so/api-reference/cycle/list-cycle-work-items.md): Returns a list of all work items in a cycle. - [List all archived cycles](https://developers.plane.so/api-reference/cycle/list-archived-cycles.md): Returns a list of all archived cycles in a project. - [Update a cycle](https://developers.plane.so/api-reference/cycle/update-cycle-detail.md): Updates an existing cycle by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Restore a cycle](https://developers.plane.so/api-reference/cycle/unarchive-cycle.md): Restores an archived cycle back to the active cycles list. - [Remove work item from cycle](https://developers.plane.so/api-reference/cycle/remove-cycle-work-item.md): Removes a work item from a cycle. - [Delete a cycle](https://developers.plane.so/api-reference/cycle/delete-cycle.md): Permanently deletes a cycle from a project. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/module/overview.md) - [Create a module](https://developers.plane.so/api-reference/module/add-module.md): Creates a new module in a project. - [Add work items to module](https://developers.plane.so/api-reference/module/add-module-work-items.md): Adds one or more work items to a module. - [Archive a module](https://developers.plane.so/api-reference/module/archive-module.md): Archives a module, while preserving its data. - [List all modules](https://developers.plane.so/api-reference/module/list-modules.md): Returns a list of all modules in a project. - [Retrieve a module](https://developers.plane.so/api-reference/module/get-module-detail.md): Retrieves the details of an existing module by its ID. - [List all work items in a module](https://developers.plane.so/api-reference/module/list-module-work-items.md): Returns a list of all work items in a module. - [List all archived modules](https://developers.plane.so/api-reference/module/list-archived-modules.md): Returns a list of all archived modules in a project. - [Update module details](https://developers.plane.so/api-reference/module/update-module-detail.md): Updates the details of a module - [Restore a module](https://developers.plane.so/api-reference/module/unarchive-module.md): Restores an archived module back to the modules list. - [Remove work item from module](https://developers.plane.so/api-reference/module/remove-module-work-item.md): Removes a work item from a module. - [Delete a module](https://developers.plane.so/api-reference/module/delete-module.md): Permanently deletes a module from a project. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/page/overview.md) - [Create a wiki page](https://developers.plane.so/api-reference/page/add-workspace-page.md): Creates a new page at the workspace level. - [Create a project page](https://developers.plane.so/api-reference/page/add-project-page.md): Creates a new page at the project level, specific to a single project. - [Retrieve a wiki page](https://developers.plane.so/api-reference/page/get-workspace-page.md): Retrieves the details of an existing workspace page by its ID. - [Retrieve a project page](https://developers.plane.so/api-reference/page/get-project-page.md): Retrieves the details of an existing project page by its ID. - [Overview](https://developers.plane.so/api-reference/intake-issue/overview.md) - [Create an intake work item](https://developers.plane.so/api-reference/intake-issue/add-intake-issue.md): Creates a new intake work item in a project. - [List all intake work items](https://developers.plane.so/api-reference/intake-issue/list-intake-issues.md): Returns a list of all intake work items in a project. - [Retrieve an intake work item](https://developers.plane.so/api-reference/intake-issue/get-intake-issue-detail.md): Retrieves the details of an existing intake work item by its ID. - [Update an intake work item](https://developers.plane.so/api-reference/intake-issue/update-intake-issue-detail.md): Updates an existing intake work item by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete an intake work item](https://developers.plane.so/api-reference/intake-issue/delete-intake-issue.md): Permanently deletes an intake work item from a project. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/worklogs/overview.md) - [Create a worklog](https://developers.plane.so/api-reference/worklogs/create-worklog.md): Creates a new worklog entry for a work item. - [List all worklogs for a work item](https://developers.plane.so/api-reference/worklogs/get-worklogs-for-issue.md): Returns a list of all worklogs for a specific work item. - [Get total time for each work item](https://developers.plane.so/api-reference/worklogs/get-total-time.md): Aggregates the worklogs and provides the total time spent on each issue in the project. - [Update a worklog](https://developers.plane.so/api-reference/worklogs/update-worklog.md): Update an existing worklog entry. You can change the description or duration of the worklog. - [Delete a worklog](https://developers.plane.so/api-reference/worklogs/delete-worklog.md): Delete a specific worklog entry from an issue. - [Overview](https://developers.plane.so/api-reference/epics/overview.md) - [List all epics](https://developers.plane.so/api-reference/epics/list-epics.md): Returns a list of all epics in a project. - [Retrieve an epic](https://developers.plane.so/api-reference/epics/get-epic-detail.md): Retrieves the details of an existing epic by its ID. - [Overview](https://developers.plane.so/api-reference/initiative/overview.md) - [Create an initiative](https://developers.plane.so/api-reference/initiative/add-initiative.md): Creates a new initiative in a workspace. - [List all initiatives](https://developers.plane.so/api-reference/initiative/list-initiatives.md): Returns a list of all initiatives in a workspace. - [Retrieve an initiative](https://developers.plane.so/api-reference/initiative/get-initiative-detail.md): Retrieves the details of an existing initiative by its ID. - [Update an initiative](https://developers.plane.so/api-reference/initiative/update-initiative-detail.md): Updates an existing initiative by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete an initiative](https://developers.plane.so/api-reference/initiative/delete-initiative.md): Permanently deletes an initiative from a workspace. This action cannot be undone. - [Create an initiative label](https://developers.plane.so/api-reference/initiative/add-initiative-label.md): Creates a new label for categorizing initiatives in a workspace. - [Add labels to initiative](https://developers.plane.so/api-reference/initiative/add-labels-to-initiative.md): Adds one or more labels to an initiative. - [List all initiative labels](https://developers.plane.so/api-reference/initiative/list-initiative-labels.md): Returns a list of all initiative labels in a workspace. - [Retrieve an initiative label](https://developers.plane.so/api-reference/initiative/get-initiative-label-detail.md): Retrieves the details of an existing initiative label by its ID. - [List all labels for an initiative](https://developers.plane.so/api-reference/initiative/list-initiative-labels-for-initiative.md): Returns a list of all labels associated with an initiative. - [Update an initiative label](https://developers.plane.so/api-reference/initiative/update-initiative-label-detail.md): Updates an existing initiative label by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Remove labels from initiative](https://developers.plane.so/api-reference/initiative/remove-labels-from-initiative.md): Removes one or more labels from an initiative. - [Delete an initiative label](https://developers.plane.so/api-reference/initiative/delete-initiative-label.md): Permanently deletes an initiative label from a workspace. This action cannot be undone. - [Add projects to initiative](https://developers.plane.so/api-reference/initiative/add-projects-to-initiative.md): Adds one or more projects to an initiative. - [List all projects in an initiative](https://developers.plane.so/api-reference/initiative/list-initiative-projects.md): Returns a list of all projects associated with an initiative. - [Remove projects from initiative](https://developers.plane.so/api-reference/initiative/remove-projects-from-initiative.md): Removes one or more projects from an initiative. - [Add epics to initiative](https://developers.plane.so/api-reference/initiative/add-epics-to-initiative.md): Adds one or more epics to an initiative. - [List all epics for an initiative](https://developers.plane.so/api-reference/initiative/list-initiative-epics.md): Returns a list of all epics associated with an initiative. - [Remove epics from initiative](https://developers.plane.so/api-reference/initiative/remove-epics-from-initiative.md): Removes one or more epics from an initiative. - [Overview](https://developers.plane.so/api-reference/customer/overview.md) - [Create a customer](https://developers.plane.so/api-reference/customer/add-customer.md): Creates a new customer in a workspace. - [Link work items to customer](https://developers.plane.so/api-reference/customer/link-work-items-to-customer.md): Links one or more work items to a customer. - [List all customers](https://developers.plane.so/api-reference/customer/list-customers.md): Gets all the customers in a workspace - [Retrieve a customer](https://developers.plane.so/api-reference/customer/get-customer-detail.md): Retrieves the details of an existing customer by its ID. - [List all customer work items](https://developers.plane.so/api-reference/customer/list-customer-work-items.md): Returns a list of all work items associated with a customer. - [Update a customer](https://developers.plane.so/api-reference/customer/update-customer-detail.md): Updates an existing customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Unlink work item from customer](https://developers.plane.so/api-reference/customer/unlink-work-item-from-customer.md): Removes the association between a work item and a customer. - [Delete a customer](https://developers.plane.so/api-reference/customer/delete-customer.md): Permanently deletes a customer from a workspace. This action cannot be undone. - [Create a customer property](https://developers.plane.so/api-reference/customer/add-customer-property.md): Creates a new customer property definition in a workspace. - [List all customer properties](https://developers.plane.so/api-reference/customer/list-customer-properties.md): Returns a list of all customer property definitions in a workspace. - [Retrieve a customer property](https://developers.plane.so/api-reference/customer/get-customer-property-detail.md): Retrieves the details of an existing customer property definition by its ID. - [List all customer property values](https://developers.plane.so/api-reference/customer/list-customer-property-values.md): Returns a list of all property values for a customer. - [Retrieve a customer property value](https://developers.plane.so/api-reference/customer/get-customer-property-value.md): Retrieves a specific property value for a customer by property ID. - [Update a customer property](https://developers.plane.so/api-reference/customer/update-customer-property-detail.md): Updates an existing customer property definition by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Update a customer property value](https://developers.plane.so/api-reference/customer/update-customer-property-value.md): Updates a property value for a customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a customer property](https://developers.plane.so/api-reference/customer/delete-customer-property.md): Permanently deletes a customer property definition from a workspace. This action cannot be undone. - [Create a customer request](https://developers.plane.so/api-reference/customer/add-customer-request.md): Creates a new request for a customer. - [List all customer requests](https://developers.plane.so/api-reference/customer/list-customer-requests.md): Returns a list of all requests for a customer. - [Retrieve a customer request](https://developers.plane.so/api-reference/customer/get-customer-request-detail.md): Retrieves the details of an existing customer request by its ID. - [Update a customer request](https://developers.plane.so/api-reference/customer/update-customer-request-detail.md): Updates an existing customer request by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a customer request](https://developers.plane.so/api-reference/customer/delete-customer-request.md): Permanently deletes a customer request. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/teamspace/overview.md) - [Create a teamspace](https://developers.plane.so/api-reference/teamspace/add-teamspace.md): Creates a new teamspace in a workspace. - [List all teamspaces](https://developers.plane.so/api-reference/teamspace/list-teamspaces.md): Returns a list of all teamspaces in a workspace. - [Retrieve a teamspace](https://developers.plane.so/api-reference/teamspace/get-teamspace-detail.md): Retrieves the details of an existing teamspace by its ID. - [Update a teamspace](https://developers.plane.so/api-reference/teamspace/update-teamspace-detail.md): Updates an existing teamspace by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a teamspace](https://developers.plane.so/api-reference/teamspace/delete-teamspace.md): Deletes a teamspace - [List all teamspace members](https://developers.plane.so/api-reference/teamspace/list-teamspace-members.md): Returns a list of all members associated with a teamspace. - [Add members to teamspace](https://developers.plane.so/api-reference/teamspace/add-teamspace-members.md): Adds members to a teamspace - [Remove members from teamspace](https://developers.plane.so/api-reference/teamspace/remove-teamspace-members.md): Removes members from a teamspace - [List teamspace projects](https://developers.plane.so/api-reference/teamspace/list-teamspace-projects.md): Gets all the projects associated with a teamspace - [Add projects to teamspace](https://developers.plane.so/api-reference/teamspace/add-projects-to-teamspace.md): Adds projects to a teamspace - [Remove projects from teamspace](https://developers.plane.so/api-reference/teamspace/remove-projects-from-teamspace.md): Removes one or more projects from a teamspace. - [Overview](https://developers.plane.so/api-reference/sticky/overview.md) - [Create a sticky](https://developers.plane.so/api-reference/sticky/add-sticky.md): Creates a new sticky note in a workspace. - [List all stickies](https://developers.plane.so/api-reference/sticky/list-stickies.md): Returns a list of all stickies in a workspace. - [Retrieve a sticky](https://developers.plane.so/api-reference/sticky/get-sticky-detail.md): Retrieves the details of an existing sticky by its ID. - [Update a sticky](https://developers.plane.so/api-reference/sticky/update-sticky-detail.md): Updates an existing sticky by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a sticky](https://developers.plane.so/api-reference/sticky/delete-sticky.md): Permanently deletes a sticky from a workspace. This action cannot be undone. - [Overview](https://developers.plane.so/api-reference/members/overview.md) - [Get all workspace members](https://developers.plane.so/api-reference/members/get-workspace-members.md): Returns a list of all members in a workspace. - [List all project members](https://developers.plane.so/api-reference/members/get-project-members.md): Returns a list of all members in a project. - [Overview](https://developers.plane.so/api-reference/user/overview.md) - [Retrieve current user](https://developers.plane.so/api-reference/user/get-current-user.md): Retrieves information about the currently authenticated user. - [Build a Plane app (Beta)](https://developers.plane.so/dev-tools/build-plane-app.md): Step-by-step development guide to build and integrate an app with Plane using OAuth-based authentication and authorization workflow. - [Webhooks](https://developers.plane.so/dev-tools/intro-webhooks.md): A webhook triggers a HTTP POST request on the specified url, whenever there is a change in an event. Like a new project is created, updated or deleted then a webhook can be triggered to receive the required payload. - [MCP server](https://developers.plane.so/dev-tools/mcp-server.md): Use the Plane MCP server to integrate with Plane ## OpenAPI Specs - [openapi](https://developers.plane.so/api-reference/openapi.json) ## Optional - [Plane Documentation](https://docs.plane.so/) - [Discord](https://discord.com/invite/A92xrEGCge) - [GitHub](https://github.com/makeplane/plane)