# plane-sdk
The Plane REST API

Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.1
- Package version: 0.1.0
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
For more information, please visit [https://plane.so](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:

```sh
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:
```python
import plane
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import plane
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
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**](docs/AssetsApi.md#create_generic_asset_upload) | **POST** /api/v1/workspaces/{slug}/assets/ | Generate presigned URL for generic asset upload
*AssetsApi* | [**create_user_asset_upload**](docs/AssetsApi.md#create_user_asset_upload) | **POST** /api/v1/assets/user-assets/ | Generate presigned URL for user asset upload
*AssetsApi* | [**delete_user_asset**](docs/AssetsApi.md#delete_user_asset) | **DELETE** /api/v1/assets/user-assets/{asset_id}/ | Delete user asset
*AssetsApi* | [**get_generic_asset**](docs/AssetsApi.md#get_generic_asset) | **GET** /api/v1/workspaces/{slug}/assets/{asset_id}/ | Get presigned URL for asset download
*AssetsApi* | [**update_generic_asset**](docs/AssetsApi.md#update_generic_asset) | **PATCH** /api/v1/workspaces/{slug}/assets/{asset_id}/ | Update generic asset after upload completion
*AssetsApi* | [**update_user_asset**](docs/AssetsApi.md#update_user_asset) | **PATCH** /api/v1/assets/user-assets/{asset_id}/ | Mark user asset as uploaded
*CyclesApi* | [**add_cycle_work_items**](docs/CyclesApi.md#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**](docs/CyclesApi.md#archive_cycle) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/archive/ | Archive cycle
*CyclesApi* | [**create_cycle**](docs/CyclesApi.md#create_cycle) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | Create cycle
*CyclesApi* | [**delete_cycle**](docs/CyclesApi.md#delete_cycle) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Delete cycle
*CyclesApi* | [**delete_cycle_work_item**](docs/CyclesApi.md#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**](docs/CyclesApi.md#list_archived_cycles) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/ | List archived cycles
*CyclesApi* | [**list_cycle_work_items**](docs/CyclesApi.md#list_cycle_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | List cycle work items
*CyclesApi* | [**list_cycles**](docs/CyclesApi.md#list_cycles) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | List cycles
*CyclesApi* | [**retrieve_cycle**](docs/CyclesApi.md#retrieve_cycle) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Retrieve cycle
*CyclesApi* | [**retrieve_cycle_work_item**](docs/CyclesApi.md#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**](docs/CyclesApi.md#transfer_cycle_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ | Transfer cycle work items
*CyclesApi* | [**unarchive_cycle**](docs/CyclesApi.md#unarchive_cycle) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/{pk}/unarchive/ | Unarchive cycle
*CyclesApi* | [**update_cycle**](docs/CyclesApi.md#update_cycle) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Update cycle
*IntakeApi* | [**create_intake_work_item**](docs/IntakeApi.md#create_intake_work_item) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/ | Create intake work item
*IntakeApi* | [**delete_intake_work_item**](docs/IntakeApi.md#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**](docs/IntakeApi.md#get_intake_work_items_list) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/ | List intake work items
*IntakeApi* | [**retrieve_intake_work_item**](docs/IntakeApi.md#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**](docs/IntakeApi.md#update_intake_work_item) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/ | Update intake work item
*LabelsApi* | [**create_label**](docs/LabelsApi.md#create_label) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/labels/ | Endpoints for label create/update/delete and fetch label details
*LabelsApi* | [**delete_label**](docs/LabelsApi.md#delete_label) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ | Delete a label
*LabelsApi* | [**get_labels**](docs/LabelsApi.md#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**](docs/LabelsApi.md#list_labels) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/labels/ | Endpoints for label create/update/delete and fetch label details
*LabelsApi* | [**update_label**](docs/LabelsApi.md#update_label) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ | Update a label
*MembersApi* | [**get_project_members**](docs/MembersApi.md#get_project_members) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/members/ | List project members
*MembersApi* | [**get_workspace_members**](docs/MembersApi.md#get_workspace_members) | **GET** /api/v1/workspaces/{slug}/members/ | List workspace members
*ModulesApi* | [**add_module_work_items**](docs/ModulesApi.md#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**](docs/ModulesApi.md#archive_module) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/archive/ | Archive module
*ModulesApi* | [**create_module**](docs/ModulesApi.md#create_module) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/modules/ | Create module
*ModulesApi* | [**delete_module**](docs/ModulesApi.md#delete_module) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Delete module
*ModulesApi* | [**delete_module_work_item**](docs/ModulesApi.md#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**](docs/ModulesApi.md#list_archived_modules) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/ | List archived modules
*ModulesApi* | [**list_module_work_items**](docs/ModulesApi.md#list_module_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/ | List module work items
*ModulesApi* | [**list_modules**](docs/ModulesApi.md#list_modules) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/ | List modules
*ModulesApi* | [**retrieve_module**](docs/ModulesApi.md#retrieve_module) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Retrieve module
*ModulesApi* | [**unarchive_module**](docs/ModulesApi.md#unarchive_module) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/{pk}/unarchive/ | Unarchive module
*ModulesApi* | [**update_module**](docs/ModulesApi.md#update_module) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ | Update module
*ProjectsApi* | [**archive_project**](docs/ProjectsApi.md#archive_project) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/archive/ | Archive project
*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /api/v1/workspaces/{slug}/projects/ | Create project
*ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /api/v1/workspaces/{slug}/projects/{pk}/ | Delete project
*ProjectsApi* | [**list_projects**](docs/ProjectsApi.md#list_projects) | **GET** /api/v1/workspaces/{slug}/projects/ | List or retrieve projects
*ProjectsApi* | [**retrieve_project**](docs/ProjectsApi.md#retrieve_project) | **GET** /api/v1/workspaces/{slug}/projects/{pk}/ | Retrieve project
*ProjectsApi* | [**unarchive_project**](docs/ProjectsApi.md#unarchive_project) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archive/ | Unarchive project
*ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PATCH** /api/v1/workspaces/{slug}/projects/{pk}/ | Update project
*StatesApi* | [**create_state**](docs/StatesApi.md#create_state) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/states/ | Create state
*StatesApi* | [**delete_state**](docs/StatesApi.md#delete_state) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Delete state
*StatesApi* | [**list_states**](docs/StatesApi.md#list_states) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/states/ | List states
*StatesApi* | [**retrieve_state**](docs/StatesApi.md#retrieve_state) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Retrieve state
*StatesApi* | [**update_state**](docs/StatesApi.md#update_state) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ | Update state
*UsersApi* | [**get_current_user**](docs/UsersApi.md#get_current_user) | **GET** /api/v1/users/me/ | Get current user
*WorkItemActivityApi* | [**list_work_item_activities**](docs/WorkItemActivityApi.md#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**](docs/WorkItemActivityApi.md#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**](docs/WorkItemAttachmentsApi.md#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**](docs/WorkItemAttachmentsApi.md#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**](docs/WorkItemAttachmentsApi.md#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**](docs/WorkItemAttachmentsApi.md#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**](docs/WorkItemCommentsApi.md#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**](docs/WorkItemCommentsApi.md#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**](docs/WorkItemCommentsApi.md#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**](docs/WorkItemCommentsApi.md#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**](docs/WorkItemCommentsApi.md#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**](docs/WorkItemLinksApi.md#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**](docs/WorkItemLinksApi.md#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**](docs/WorkItemLinksApi.md#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**](docs/WorkItemLinksApi.md#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**](docs/WorkItemLinksApi.md#update_issue_link) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/links/{pk}/ | Update an issue link
*WorkItemPropertiesApi* | [**create_issue_property**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemPropertiesApi.md#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**](docs/WorkItemTypesApi.md#create_issue_type) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/ | Create a new issue type
*WorkItemTypesApi* | [**delete_issue_type**](docs/WorkItemTypesApi.md#delete_issue_type) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/ | Delete an issue type
*WorkItemTypesApi* | [**list_issue_types**](docs/WorkItemTypesApi.md#list_issue_types) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/ | List issue types
*WorkItemTypesApi* | [**retrieve_issue_type**](docs/WorkItemTypesApi.md#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**](docs/WorkItemTypesApi.md#update_issue_type) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issue-types/{type_id}/ | Update an issue type
*WorkItemWorklogsApi* | [**create_issue_worklog**](docs/WorkItemWorklogsApi.md#create_issue_worklog) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/ | Create a new worklog entry
*WorkItemWorklogsApi* | [**delete_issue_worklog**](docs/WorkItemWorklogsApi.md#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**](docs/WorkItemWorklogsApi.md#get_project_worklog_summary) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/total-worklogs/ | Get project worklog summary
*WorkItemWorklogsApi* | [**list_issue_worklogs**](docs/WorkItemWorklogsApi.md#list_issue_worklogs) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/ | List worklog entries
*WorkItemWorklogsApi* | [**update_issue_worklog**](docs/WorkItemWorklogsApi.md#update_issue_worklog) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{issue_id}/worklogs/{pk}/ | Update a worklog entry
*WorkItemsApi* | [**create_work_item**](docs/WorkItemsApi.md#create_work_item) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/issues/ | Create work item
*WorkItemsApi* | [**delete_work_item**](docs/WorkItemsApi.md#delete_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Delete work item
*WorkItemsApi* | [**get_workspace_work_item**](docs/WorkItemsApi.md#get_workspace_work_item) | **GET** /api/v1/workspaces/{slug}/issues/{project_identifier}-{issue_identifier}/ | Retrieve work item by identifiers
*WorkItemsApi* | [**list_work_items**](docs/WorkItemsApi.md#list_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/ | List work items
*WorkItemsApi* | [**retrieve_work_item**](docs/WorkItemsApi.md#retrieve_work_item) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Retrieve work item
*WorkItemsApi* | [**search_work_items**](docs/WorkItemsApi.md#search_work_items) | **GET** /api/v1/workspaces/{slug}/issues/search/ | 
*WorkItemsApi* | [**update_work_item**](docs/WorkItemsApi.md#update_work_item) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/issues/{pk}/ | Partially update work item


## Documentation For Models

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


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuthentication"></a>
### ApiKeyAuthentication

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

<a id="OAuth2Authentication"></a>
### OAuth2Authentication

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

<a id="OAuth2Authentication"></a>
### 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


