The Plane REST API

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

This Python package is automatically generated by the OpenAPI Generator project:

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

Python 3.7+

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

pip install git+https://github.com/makeplane/plane-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/makeplane/plane-python-sdk.git)

Then import the package:

import plane

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

Execute pytest to run the tests.

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}")

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

• AccessEnum
• Cycle
• CycleCreateRequest
• CycleIssue
• CycleIssueRequestRequest
• CycleLite
• EntityTypeEnum
• GenericAssetUploadRequest
• GetWorkspaceMembers200ResponseInner
• GroupEnum
• IntakeIssue
• IntakeIssueCreateRequest
• IntakeWorkItemStatusEnum
• Issue
• IssueActivity
• IssueAttachment
• IssueAttachmentUploadRequest
• IssueComment
• IssueCommentCreateRequest
• IssueExpand
• IssueForIntakeRequest
• IssueLink
• IssueLinkCreateRequest
• IssuePropertyAPI
• IssuePropertyAPIRequest
• IssuePropertyOptionAPI
• IssuePropertyOptionAPIRequest
• IssuePropertyValueAPI
• IssuePropertyValueAPIRequest
• IssueRequest
• IssueSearch
• IssueTypeAPI
• IssueTypeAPIRequest
• IssueWorkLogAPI
• IssueWorkLogAPIRequest
• Label
• LabelCreateUpdateRequest
• LabelLite
• Module
• ModuleCreateRequest
• ModuleIssue
• ModuleIssueRequestRequest
• ModuleLite
• ModuleStatusEnum
• NetworkEnum
• PaginatedArchivedCycleResponse
• PaginatedArchivedModuleResponse
• PaginatedCycleIssueResponse
• PaginatedCycleResponse
• PaginatedIntakeIssueResponse
• PaginatedIssueActivityDetailResponse
• PaginatedIssueActivityResponse
• PaginatedIssueCommentResponse
• PaginatedIssueLinkDetailResponse
• PaginatedIssueLinkResponse
• PaginatedLabelResponse
• PaginatedModuleIssueResponse
• PaginatedModuleResponse
• PaginatedProjectResponse
• PaginatedStateResponse
• PaginatedWorkItemResponse
• PatchedAssetUpdateRequest
• PatchedCycleUpdateRequest
• PatchedGenericAssetUpdateRequest
• PatchedIntakeIssueUpdateRequest
• PatchedIssueCommentCreateRequest
• PatchedIssueLinkUpdateRequest
• PatchedIssuePropertyAPIRequest
• PatchedIssuePropertyOptionAPIRequest
• PatchedIssueRequest
• PatchedIssueTypeAPIRequest
• PatchedIssueWorkLogAPIRequest
• PatchedLabelCreateUpdateRequest
• PatchedModuleUpdateRequest
• PatchedProjectUpdateRequest
• PatchedStateRequest
• PriorityEnum
• Project
• ProjectCreateRequest
• ProjectWorklogSummary
• PropertyTypeEnum
• RelationTypeEnum
• RetrieveWorkItemAttachment400Response
• State
• StateLite
• StateRequest
• TimezoneEnum
• TransferCycleIssueRequestRequest
• TransferCycleWorkItems200Response
• TransferCycleWorkItems400Response
• TypeEnum
• UserAssetUploadRequest
• UserLite

Authentication schemes defined for the API:

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

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

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

support@plane.so