The Plane REST API

These details have not been verified by PyPI

Project description

plane-sdk

The Plane REST API

Visit our quick start guide and full API documentation at developers.plane.so.

API version: 0.0.1
Package version: 0.1.4
Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen For more information, please visit https://plane.so

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install plane-sdk

(you may need to run pip with root permission: sudo pip install plane-sdk)

Then import the package:

import plane

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import plane

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

from plane.configuration import Configuration
from plane.api_client import ApiClient
from plane.api.users_api import UsersApi
from plane.api.projects_api import ProjectsApi
from plane.exceptions import ApiException

def test_api():

    # Configure API Key authentication
    configuration = Configuration(
        api_key={'ApiKeyAuthentication': <API_KEY>}
    )

    # Configure Access Token authentication
    # configuration = Configuration(
    #    access_token='<PLANE_ACCESS_TOKEN>'
    # )

    # Create API client instance
    api_client = ApiClient(configuration)

    # Create Users API instance
    users_api = UsersApi(api_client)

    # Call get_current_user endpoint
    print("Fetching current user information...")
    user = users_api.get_current_user()
    print(user.email)

    projects_api = ProjectsApi(api_client)
    projects_response = projects_api.list_projects(slug="<workspace_slug>")
    for project in projects_response.results:
        print(f"{project.id} - {project.name}")

Documentation for API Endpoints

All URIs are relative to https://api.plane.so

Class	Method	HTTP request	Description
AssetsApi	create_generic_asset_upload	POST /api/v1/workspaces/{slug}/assets/	Generate presigned URL for generic asset upload
AssetsApi	create_user_asset_upload	POST /api/v1/assets/user-assets/	Generate presigned URL for user asset upload
AssetsApi	delete_user_asset	DELETE /api/v1/assets/user-assets/{asset_id}/	Delete user asset
AssetsApi	get_generic_asset	GET /api/v1/workspaces/{slug}/assets/{asset_id}/	Get presigned URL for asset download
AssetsApi	update_generic_asset	PATCH /api/v1/workspaces/{slug}/assets/{asset_id}/	Update generic asset after upload completion
AssetsApi	update_user_asset	PATCH /api/v1/assets/user-assets/{asset_id}/	Mark user asset as uploaded
CyclesApi	add_cycle_work_items	POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/	Add Work Items to Cycle
CyclesApi	archive_cycle	POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/archive/	Archive cycle
CyclesApi	create_cycle	POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/	Create cycle
CyclesApi	delete_cycle	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/	Delete cycle
CyclesApi	delete_cycle_work_item	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/	Delete cycle work item
CyclesApi	list_archived_cycles	GET /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/	List archived cycles
CyclesApi	list_cycle_work_items	GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/	List cycle work items
CyclesApi	list_cycles	GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/	List cycles
CyclesApi	retrieve_cycle	GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/	Retrieve cycle
CyclesApi	retrieve_cycle_work_item	GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/	Retrieve cycle work item
CyclesApi	transfer_cycle_work_items	POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/	Transfer cycle work items
CyclesApi	unarchive_cycle	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/{pk}/unarchive/	Unarchive cycle
CyclesApi	update_cycle	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/	Update cycle
IntakeApi	create_intake_work_item	POST /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/	Create intake work item
IntakeApi	delete_intake_work_item	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/	Delete intake work item
IntakeApi	get_intake_work_items_list	GET /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/	List intake work items
IntakeApi	retrieve_intake_work_item	GET /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/	Retrieve intake work item
IntakeApi	update_intake_work_item	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/	Update intake work item
LabelsApi	create_label	POST /api/v1/workspaces/{slug}/projects/{project_id}/labels/	Endpoints for label create/update/delete and fetch label details
LabelsApi	delete_label	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/	Delete a label
LabelsApi	get_labels	GET /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/	Endpoints for label create/update/delete and fetch label details
LabelsApi	list_labels	GET /api/v1/workspaces/{slug}/projects/{project_id}/labels/	Endpoints for label create/update/delete and fetch label details
LabelsApi	update_label	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/	Update a label
MembersApi	get_project_members	GET /api/v1/workspaces/{slug}/projects/{project_id}/members/	List project members
MembersApi	get_workspace_members	GET /api/v1/workspaces/{slug}/members/	List workspace members
ModulesApi	add_module_work_items	POST /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/	Add Work Items to Module
ModulesApi	archive_module	POST /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/archive/	Archive module
ModulesApi	create_module	POST /api/v1/workspaces/{slug}/projects/{project_id}/modules/	Create module
ModulesApi	delete_module	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/	Delete module
ModulesApi	delete_module_work_item	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/{issue_id}/	Delete module work item
ModulesApi	list_archived_modules	GET /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/	List archived modules
ModulesApi	list_module_work_items	GET /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/	List module work items
ModulesApi	list_modules	GET /api/v1/workspaces/{slug}/projects/{project_id}/modules/	List modules
ModulesApi	retrieve_module	GET /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/	Retrieve module
ModulesApi	unarchive_module	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/{pk}/unarchive/	Unarchive module
ModulesApi	update_module	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/	Update module
ProjectsApi	archive_project	POST /api/v1/workspaces/{slug}/projects/{project_id}/archive/	Archive project
ProjectsApi	create_project	POST /api/v1/workspaces/{slug}/projects/	Create project
ProjectsApi	delete_project	DELETE /api/v1/workspaces/{slug}/projects/{pk}/	Delete project
ProjectsApi	list_projects	GET /api/v1/workspaces/{slug}/projects/	List or retrieve projects
ProjectsApi	retrieve_project	GET /api/v1/workspaces/{slug}/projects/{pk}/	Retrieve project
ProjectsApi	unarchive_project	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/archive/	Unarchive project
ProjectsApi	update_project	PATCH /api/v1/workspaces/{slug}/projects/{pk}/	Update project
StatesApi	create_state	POST /api/v1/workspaces/{slug}/projects/{project_id}/states/	Create state
StatesApi	delete_state	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/	Delete state
StatesApi	list_states	GET /api/v1/workspaces/{slug}/projects/{project_id}/states/	List states
StatesApi	retrieve_state	GET /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/	Retrieve state
StatesApi	update_state	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/	Update state
UsersApi	get_current_user	GET /api/v1/users/me/	Get current user
WorkItemActivityApi	list_work_item_activities	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/activities/	Endpoints for issue activity/search and fetch issue activity details
WorkItemActivityApi	retrieve_work_item_activity	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/activities/{pk}/	Endpoints for issue activity/search and fetch issue activity details
WorkItemAttachmentsApi	create_work_item_attachment	POST /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/	Endpoints for issue attachment create/update/delete and fetch issue attachment details
WorkItemAttachmentsApi	delete_work_item_attachment	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{pk}/	Endpoints for issue attachment create/update/delete and fetch issue attachment details
WorkItemAttachmentsApi	list_work_item_attachments	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/	Endpoints for issue attachment create/update/delete and fetch issue attachment details
WorkItemAttachmentsApi	retrieve_work_item_attachment	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{pk}/	Endpoints for issue attachment create/update/delete and fetch issue attachment details
WorkItemCommentsApi	create_work_item_comment	POST /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/	Endpoints for issue comment create/update/delete and fetch issue comment details
WorkItemCommentsApi	delete_work_item_comment	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/	Endpoints for issue comment create/update/delete and fetch issue comment details
WorkItemCommentsApi	list_work_item_comments	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/	Endpoints for issue comment create/update/delete and fetch issue comment details
WorkItemCommentsApi	retrieve_work_item_comment	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/	Endpoints for issue comment create/update/delete and fetch issue comment details
WorkItemCommentsApi	update_work_item_comment	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/comments/{pk}/	Endpoints for issue comment create/update/delete and fetch issue comment details
WorkItemLinksApi	create_work_item_link	POST /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/	Endpoints for issue link create/update/delete and fetch issue link details
WorkItemLinksApi	delete_work_item_link	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/	Endpoints for issue link create/update/delete and fetch issue link details
WorkItemLinksApi	list_work_item_links	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/	Endpoints for issue link create/update/delete and fetch issue link details
WorkItemLinksApi	retrieve_work_item_link	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/	Endpoints for issue link create/update/delete and fetch issue link details
WorkItemLinksApi	update_issue_link	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/	Update an issue link
WorkItemPropertiesApi	create_issue_property	POST /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/	Create a new issue property
WorkItemPropertiesApi	create_issue_property_option	POST /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/	Create a new issue property option
WorkItemPropertiesApi	create_issue_property_value	POST /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-properties/{property_id}/values/	Create/update an issue property value
WorkItemPropertiesApi	delete_issue_property	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/	Delete an issue property
WorkItemPropertiesApi	delete_issue_property_option	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/	Delete an issue property option
WorkItemPropertiesApi	list_issue_properties	GET /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/	List issue properties
WorkItemPropertiesApi	list_issue_property_options	GET /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/	List issue property options
WorkItemPropertiesApi	list_issue_property_values	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/issue-properties/{property_id}/values/	List issue property values
WorkItemPropertiesApi	retrieve_issue_property	GET /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/	Get issue property by id
WorkItemPropertiesApi	retrieve_issue_property_option	GET /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/	Get issue property option by id
WorkItemPropertiesApi	update_issue_property	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/	Update an issue property
WorkItemPropertiesApi	update_issue_property_option	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/	Update an issue property option
WorkItemTypesApi	create_issue_type	POST /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/	Create a new issue type
WorkItemTypesApi	delete_issue_type	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/	Delete an issue type
WorkItemTypesApi	list_issue_types	GET /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/	List issue types
WorkItemTypesApi	retrieve_issue_type	GET /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/	Retrieve an issue type by id
WorkItemTypesApi	update_issue_type	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/	Update an issue type
WorkItemWorklogsApi	create_issue_worklog	POST /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/	Create a new worklog entry
WorkItemWorklogsApi	delete_issue_worklog	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/{pk}/	Delete a worklog entry
WorkItemWorklogsApi	get_project_worklog_summary	GET /api/v1/workspaces/{slug}/projects/{project_id}/total-worklogs/	Get project worklog summary
WorkItemWorklogsApi	list_issue_worklogs	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/	List worklog entries
WorkItemWorklogsApi	update_issue_worklog	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/{pk}/	Update a worklog entry
WorkItemsApi	create_work_item	POST /api/v1/workspaces/{slug}/projects/{project_id}/issues/	Create work item
WorkItemsApi	delete_work_item	DELETE /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/	Delete work item
WorkItemsApi	get_workspace_work_item	GET /api/v1/workspaces/{slug}/issues/{project_identifier}-{issue_identifier}/	Retrieve work item by identifiers
WorkItemsApi	list_work_items	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/	List work items
WorkItemsApi	retrieve_work_item	GET /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/	Retrieve work item
WorkItemsApi	search_work_items	GET /api/v1/workspaces/{slug}/issues/search/
WorkItemsApi	update_work_item	PATCH /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/	Partially update work item

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuthentication

Type: API key
API key parameter name: X-API-Key
Location: HTTP header

OAuth2Authentication

Type: OAuth
Flow: application
Authorization URL:
Scopes:
read: Read access to resources
write: Write access to resources

OAuth2Authentication

Type: OAuth
Flow: accessCode
Authorization URL: /auth/o/authorize-app/
Scopes:
read: Read access to resources
write: Write access to resources

Author

support@plane.so

Project details

These details have not been verified by PyPI

Release history Release notifications | RSS feed

0.2.11

Apr 28, 2026

0.2.10

Apr 22, 2026

0.2.9

Apr 10, 2026

0.2.8

Mar 23, 2026

0.2.7

Mar 18, 2026

0.2.6

Feb 10, 2026

0.2.5

Feb 4, 2026

0.2.4

Dec 30, 2025

0.2.3

Dec 24, 2025

0.2.2

Nov 29, 2025

0.2.1

Nov 25, 2025

0.2.0

Oct 31, 2025

0.1.10

Sep 29, 2025

0.1.9

Aug 30, 2025

0.1.8

Aug 29, 2025

0.1.7

Aug 29, 2025

0.1.6

Aug 5, 2025

0.1.5

Jul 28, 2025

This version

0.1.4

Jul 24, 2025

0.1.3

Jul 8, 2025

0.1.2

Jul 8, 2025

0.1.1

Jun 23, 2025

0.1.0

Jun 20, 2025

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plane_sdk-0.1.4.tar.gz (108.4 kB view details)

Uploaded Jul 24, 2025 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

plane_sdk-0.1.4-py3-none-any.whl (230.6 kB view details)

Uploaded Jul 24, 2025 Python 3

File details

Details for the file plane_sdk-0.1.4.tar.gz.

File metadata

Download URL: plane_sdk-0.1.4.tar.gz
Upload date: Jul 24, 2025
Size: 108.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for plane_sdk-0.1.4.tar.gz
Algorithm	Hash digest
SHA256	`587c3af9931de72acf84b5595eb1b97a0162c09d3feea0540addff3ca5758680`
MD5	`c916ced98846676c0275bdd060dd7529`
BLAKE2b-256	`1ce8e8d5026d14b49647d9a891b9b1a0e14fb2e7d970f742caaccf18f21dd479`

See more details on using hashes here.

File details

Details for the file plane_sdk-0.1.4-py3-none-any.whl.

File metadata

Download URL: plane_sdk-0.1.4-py3-none-any.whl
Upload date: Jul 24, 2025
Size: 230.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for plane_sdk-0.1.4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`60a4a3ff4b13e699539e8d58f67d2a2fa5eb871047ae7d20f8e5336a7b66d74f`
MD5	`91c89098949fa9980593be10814bb060`
BLAKE2b-256	`81b1807846e9f740f8b9351e7063cfc480831d3f786533cbfa1ab89bdfdc75e1`

See more details on using hashes here.

plane-sdk 0.1.4

Navigation

Verified details

Maintainers

Unverified details

Meta

Project description

plane-sdk

Requirements.

Installation & Usage

pip install

Setuptools

Tests

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

ApiKeyAuthentication

OAuth2Authentication

OAuth2Authentication

Author

Project details

Verified details

Maintainers

Unverified details

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes