From 131599dfa5fa690283611b171da649262a0f9bf8 Mon Sep 17 00:00:00 2001 From: Surya Prashanth Date: Mon, 17 Nov 2025 19:56:33 +0530 Subject: [PATCH 1/3] docs: restructure API docs and update Work Item terminology - Add Users and Stickies API documentation - Add Initiatives, Teamspaces and Pages API documentation - Add Customers, Customer Requests and Properties API documentation - Update WorkItemTypes: replace "Issue" with "Work Item", fix endpoints - Reorganize navigation: nest related APIs under parent groups - Ensure consistent "Work Item" terminology across all docs --- .../customer/add-customer-property.mdx | 72 +++++ .../customer/add-customer-request.mdx | 22 ++ api-reference/customer/add-customer.mdx | 20 ++ .../customer/delete-customer-property.mdx | 12 + .../customer/delete-customer-request.mdx | 14 + api-reference/customer/delete-customer.mdx | 12 + .../customer/get-customer-detail.mdx | 12 + .../customer/get-customer-property-detail.mdx | 12 + .../customer/get-customer-property-value.mdx | 14 + .../customer/get-customer-request-detail.mdx | 14 + .../customer/link-work-items-to-customer.mdx | 18 ++ .../customer/list-customer-properties.mdx | 24 ++ .../list-customer-property-values.mdx | 34 ++ .../customer/list-customer-requests.mdx | 30 ++ .../customer/list-customer-work-items.mdx | 12 + api-reference/customer/list-customers.mdx | 24 ++ api-reference/customer/overview.mdx | 98 ++++++ .../unlink-work-item-from-customer.mdx | 14 + .../customer/update-customer-detail.mdx | 22 ++ .../update-customer-property-detail.mdx | 74 +++++ .../update-customer-property-value.mdx | 20 ++ .../update-customer-request-detail.mdx | 24 ++ api-reference/cycle-issue/overview.mdx | 74 ----- .../add-cycle-work-items.mdx} | 6 +- api-reference/cycle/add-cycle.mdx | 36 ++- api-reference/cycle/archive-cycle.mdx | 14 + api-reference/cycle/delete-cycle.mdx | 2 +- api-reference/cycle/get-cycle-detail.mdx | 2 +- api-reference/cycle/list-archived-cycles.mdx | 12 + .../list-cycle-work-items.mdx} | 5 +- api-reference/cycle/overview.mdx | 31 +- .../remove-cycle-work-item.mdx} | 7 +- .../cycle/transfer-cycle-work-items.mdx | 20 ++ api-reference/cycle/unarchive-cycle.mdx | 14 + api-reference/cycle/update-cycle-detail.mdx | 34 +- .../initiative/add-epics-to-initiative.mdx | 18 ++ .../initiative/add-initiative-label.mdx | 28 ++ api-reference/initiative/add-initiative.mdx | 52 +++ .../initiative/add-labels-to-initiative.mdx | 18 ++ .../initiative/add-projects-to-initiative.mdx | 18 ++ .../initiative/delete-initiative-label.mdx | 12 + .../initiative/delete-initiative.mdx | 12 + .../initiative/get-initiative-detail.mdx | 12 + .../get-initiative-label-detail.mdx | 12 + .../initiative/list-initiative-epics.mdx | 22 ++ .../list-initiative-labels-for-initiative.mdx | 22 ++ .../initiative/list-initiative-labels.mdx | 20 ++ .../initiative/list-initiative-projects.mdx | 22 ++ api-reference/initiative/list-initiatives.mdx | 20 ++ api-reference/initiative/overview.mdx | 133 ++++++++ .../remove-epics-from-initiative.mdx | 18 ++ .../remove-labels-from-initiative.mdx | 18 ++ .../remove-projects-from-initiative.mdx | 18 ++ .../initiative/update-initiative-detail.mdx | 54 ++++ .../update-initiative-label-detail.mdx | 30 ++ .../get-issue-activity-detail.mdx | 6 +- .../issue-activity/list-issue-activities.mdx | 4 +- api-reference/issue-activity/overview.mdx | 25 +- .../issue-attachments/complete-upload.mdx | 2 +- .../issue-attachments/delete-attachment.mdx | 18 ++ .../get-attachment-detail.mdx | 18 ++ .../issue-attachments/get-attachments.mdx | 26 +- .../get-upload-credentials.mdx | 16 +- api-reference/issue-attachments/overview.mdx | 39 ++- .../issue-attachments/update-attachment.mdx | 64 ++++ .../issue-comment/add-issue-comment.mdx | 24 +- .../issue-comment/delete-issue-comment.mdx | 6 +- .../get-issue-comment-detail.mdx | 6 +- .../issue-comment/list-issue-comments.mdx | 28 +- api-reference/issue-comment/overview.mdx | 53 +++- .../update-issue-comment-detail.mdx | 26 +- .../issue-types/types/add-issue-type.mdx | 39 ++- .../issue-types/types/delete-issue-type.mdx | 12 +- .../types/get-issue-type-details.mdx | 12 +- .../issue-types/types/list-issue-types.mdx | 23 +- api-reference/issue-types/types/overview.mdx | 117 +++++-- .../issue-types/types/update-issue-types.mdx | 42 ++- api-reference/issue/add-issue.mdx | 52 ++- api-reference/issue/delete-issue.mdx | 6 +- api-reference/issue/get-issue-detail.mdx | 12 +- api-reference/issue/get-issue-sequence-id.mdx | 16 +- api-reference/issue/list-issues.mdx | 32 +- api-reference/issue/overview.mdx | 72 +++-- api-reference/issue/search-issues.mdx | 20 ++ api-reference/issue/update-issue-detail.mdx | 54 +++- api-reference/module-issue/overview.mdx | 70 ----- .../add-module-work-items.mdx} | 7 +- api-reference/module/add-module.mdx | 36 ++- api-reference/module/archive-module.mdx | 14 + api-reference/module/delete-module.mdx | 2 +- api-reference/module/get-module-detail.mdx | 2 +- .../module/list-archived-modules.mdx | 12 + .../list-module-work-items.mdx} | 5 +- api-reference/module/overview.mdx | 29 +- .../remove-module-work-item.mdx} | 7 +- api-reference/module/unarchive-module.mdx | 14 + api-reference/module/update-module-detail.mdx | 38 ++- api-reference/page/add-project-page.mdx | 22 ++ api-reference/page/add-workspace-page.mdx | 20 ++ api-reference/page/get-project-page.mdx | 14 + api-reference/page/get-workspace-page.mdx | 12 + api-reference/page/overview.mdx | 68 ++++ api-reference/sticky/add-sticky.mdx | 32 ++ api-reference/sticky/delete-sticky.mdx | 12 + api-reference/sticky/get-sticky-detail.mdx | 12 + api-reference/sticky/list-stickies.mdx | 20 ++ api-reference/sticky/overview.mdx | 102 ++++++ api-reference/sticky/update-sticky-detail.mdx | 34 ++ .../teamspace/add-projects-to-teamspace.mdx | 18 ++ .../teamspace/add-teamspace-members.mdx | 18 ++ api-reference/teamspace/add-teamspace.mdx | 40 +++ api-reference/teamspace/delete-teamspace.mdx | 12 + .../teamspace/get-teamspace-detail.mdx | 12 + .../teamspace/list-teamspace-members.mdx | 22 ++ .../teamspace/list-teamspace-projects.mdx | 22 ++ api-reference/teamspace/list-teamspaces.mdx | 20 ++ api-reference/teamspace/overview.mdx | 104 ++++++ .../remove-projects-from-teamspace.mdx | 18 ++ .../teamspace/remove-teamspace-members.mdx | 18 ++ .../teamspace/update-teamspace-detail.mdx | 42 +++ api-reference/user/get-current-user.mdx | 10 + api-reference/user/overview.mdx | 58 ++++ mint.json | 297 +++++++++++++----- 123 files changed, 3165 insertions(+), 414 deletions(-) create mode 100644 api-reference/customer/add-customer-property.mdx create mode 100644 api-reference/customer/add-customer-request.mdx create mode 100644 api-reference/customer/add-customer.mdx create mode 100644 api-reference/customer/delete-customer-property.mdx create mode 100644 api-reference/customer/delete-customer-request.mdx create mode 100644 api-reference/customer/delete-customer.mdx create mode 100644 api-reference/customer/get-customer-detail.mdx create mode 100644 api-reference/customer/get-customer-property-detail.mdx create mode 100644 api-reference/customer/get-customer-property-value.mdx create mode 100644 api-reference/customer/get-customer-request-detail.mdx create mode 100644 api-reference/customer/link-work-items-to-customer.mdx create mode 100644 api-reference/customer/list-customer-properties.mdx create mode 100644 api-reference/customer/list-customer-property-values.mdx create mode 100644 api-reference/customer/list-customer-requests.mdx create mode 100644 api-reference/customer/list-customer-work-items.mdx create mode 100644 api-reference/customer/list-customers.mdx create mode 100644 api-reference/customer/overview.mdx create mode 100644 api-reference/customer/unlink-work-item-from-customer.mdx create mode 100644 api-reference/customer/update-customer-detail.mdx create mode 100644 api-reference/customer/update-customer-property-detail.mdx create mode 100644 api-reference/customer/update-customer-property-value.mdx create mode 100644 api-reference/customer/update-customer-request-detail.mdx delete mode 100644 api-reference/cycle-issue/overview.mdx rename api-reference/{cycle-issue/add-cycle-issue.mdx => cycle/add-cycle-work-items.mdx} (76%) create mode 100644 api-reference/cycle/archive-cycle.mdx create mode 100644 api-reference/cycle/list-archived-cycles.mdx rename api-reference/{cycle-issue/list-cycle-issues.mdx => cycle/list-cycle-work-items.mdx} (79%) rename api-reference/{cycle-issue/delete-cycle-issue.mdx => cycle/remove-cycle-work-item.mdx} (73%) create mode 100644 api-reference/cycle/transfer-cycle-work-items.mdx create mode 100644 api-reference/cycle/unarchive-cycle.mdx create mode 100644 api-reference/initiative/add-epics-to-initiative.mdx create mode 100644 api-reference/initiative/add-initiative-label.mdx create mode 100644 api-reference/initiative/add-initiative.mdx create mode 100644 api-reference/initiative/add-labels-to-initiative.mdx create mode 100644 api-reference/initiative/add-projects-to-initiative.mdx create mode 100644 api-reference/initiative/delete-initiative-label.mdx create mode 100644 api-reference/initiative/delete-initiative.mdx create mode 100644 api-reference/initiative/get-initiative-detail.mdx create mode 100644 api-reference/initiative/get-initiative-label-detail.mdx create mode 100644 api-reference/initiative/list-initiative-epics.mdx create mode 100644 api-reference/initiative/list-initiative-labels-for-initiative.mdx create mode 100644 api-reference/initiative/list-initiative-labels.mdx create mode 100644 api-reference/initiative/list-initiative-projects.mdx create mode 100644 api-reference/initiative/list-initiatives.mdx create mode 100644 api-reference/initiative/overview.mdx create mode 100644 api-reference/initiative/remove-epics-from-initiative.mdx create mode 100644 api-reference/initiative/remove-labels-from-initiative.mdx create mode 100644 api-reference/initiative/remove-projects-from-initiative.mdx create mode 100644 api-reference/initiative/update-initiative-detail.mdx create mode 100644 api-reference/initiative/update-initiative-label-detail.mdx create mode 100644 api-reference/issue-attachments/delete-attachment.mdx create mode 100644 api-reference/issue-attachments/get-attachment-detail.mdx create mode 100644 api-reference/issue-attachments/update-attachment.mdx create mode 100644 api-reference/issue/search-issues.mdx delete mode 100644 api-reference/module-issue/overview.mdx rename api-reference/{module-issue/add-module-issue.mdx => module/add-module-work-items.mdx} (76%) create mode 100644 api-reference/module/archive-module.mdx create mode 100644 api-reference/module/list-archived-modules.mdx rename api-reference/{module-issue/list-module-issues.mdx => module/list-module-work-items.mdx} (79%) rename api-reference/{module-issue/delete-module-issue.mdx => module/remove-module-work-item.mdx} (72%) create mode 100644 api-reference/module/unarchive-module.mdx create mode 100644 api-reference/page/add-project-page.mdx create mode 100644 api-reference/page/add-workspace-page.mdx create mode 100644 api-reference/page/get-project-page.mdx create mode 100644 api-reference/page/get-workspace-page.mdx create mode 100644 api-reference/page/overview.mdx create mode 100644 api-reference/sticky/add-sticky.mdx create mode 100644 api-reference/sticky/delete-sticky.mdx create mode 100644 api-reference/sticky/get-sticky-detail.mdx create mode 100644 api-reference/sticky/list-stickies.mdx create mode 100644 api-reference/sticky/overview.mdx create mode 100644 api-reference/sticky/update-sticky-detail.mdx create mode 100644 api-reference/teamspace/add-projects-to-teamspace.mdx create mode 100644 api-reference/teamspace/add-teamspace-members.mdx create mode 100644 api-reference/teamspace/add-teamspace.mdx create mode 100644 api-reference/teamspace/delete-teamspace.mdx create mode 100644 api-reference/teamspace/get-teamspace-detail.mdx create mode 100644 api-reference/teamspace/list-teamspace-members.mdx create mode 100644 api-reference/teamspace/list-teamspace-projects.mdx create mode 100644 api-reference/teamspace/list-teamspaces.mdx create mode 100644 api-reference/teamspace/overview.mdx create mode 100644 api-reference/teamspace/remove-projects-from-teamspace.mdx create mode 100644 api-reference/teamspace/remove-teamspace-members.mdx create mode 100644 api-reference/teamspace/update-teamspace-detail.mdx create mode 100644 api-reference/user/get-current-user.mdx create mode 100644 api-reference/user/overview.mdx diff --git a/api-reference/customer/add-customer-property.mdx b/api-reference/customer/add-customer-property.mdx new file mode 100644 index 0000000..9d32aef --- /dev/null +++ b/api-reference/customer/add-customer-property.mdx @@ -0,0 +1,72 @@ +--- +title: Add customer property +description: Creates a new customer property definition +api: POST /api/v1/workspaces/{workspace-slug}/customer-properties/ +--- + +### Path parameters + + + +### Body + + +Name of the property + + + +Display name of the property + + + +Description of the property + + + +Type of the property + + + +Relation type of the property + + + +Whether the property is required + + + +Whether the property supports multiple values + + + +Whether the property is active + + + +Sort order for the property + + + +Default values for the property + + + +Settings for the property + + + +Validation rules for the property + + + +Logo properties for the property + + + +External source identifier + + + +External ID from the external source + + diff --git a/api-reference/customer/add-customer-request.mdx b/api-reference/customer/add-customer-request.mdx new file mode 100644 index 0000000..92b88bc --- /dev/null +++ b/api-reference/customer/add-customer-request.mdx @@ -0,0 +1,22 @@ +--- +title: Add customer request +description: Creates a new request for a customer +api: POST /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/ +--- + +### Path parameters + + + + + +### Body + + +Title of the request + + + +Description of the request + + diff --git a/api-reference/customer/add-customer.mdx b/api-reference/customer/add-customer.mdx new file mode 100644 index 0000000..155bd3d --- /dev/null +++ b/api-reference/customer/add-customer.mdx @@ -0,0 +1,20 @@ +--- +title: Add customer +description: Creates a new customer in a workspace +api: POST /api/v1/workspaces/{workspace-slug}/customers/ +--- + +### Path parameters + + + +### Body + + +Name of the customer + + + +Email address of the customer + + diff --git a/api-reference/customer/delete-customer-property.mdx b/api-reference/customer/delete-customer-property.mdx new file mode 100644 index 0000000..63c3468 --- /dev/null +++ b/api-reference/customer/delete-customer-property.mdx @@ -0,0 +1,12 @@ +--- +title: Delete customer property +description: Deletes a customer property definition +api: DELETE /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/customer/delete-customer-request.mdx b/api-reference/customer/delete-customer-request.mdx new file mode 100644 index 0000000..90deadd --- /dev/null +++ b/api-reference/customer/delete-customer-request.mdx @@ -0,0 +1,14 @@ +--- +title: Delete customer request +description: Deletes a customer request +api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/{request_id}/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/customer/delete-customer.mdx b/api-reference/customer/delete-customer.mdx new file mode 100644 index 0000000..cb8df4b --- /dev/null +++ b/api-reference/customer/delete-customer.mdx @@ -0,0 +1,12 @@ +--- +title: Delete customer +description: Deletes a customer +api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/customer/get-customer-detail.mdx b/api-reference/customer/get-customer-detail.mdx new file mode 100644 index 0000000..9c6cbcc --- /dev/null +++ b/api-reference/customer/get-customer-detail.mdx @@ -0,0 +1,12 @@ +--- +title: Get customer details +description: Gets the details of a customer +api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/customer/get-customer-property-detail.mdx b/api-reference/customer/get-customer-property-detail.mdx new file mode 100644 index 0000000..e33cff9 --- /dev/null +++ b/api-reference/customer/get-customer-property-detail.mdx @@ -0,0 +1,12 @@ +--- +title: Get customer property details +description: Gets the details of a customer property definition +api: GET /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/customer/get-customer-property-value.mdx b/api-reference/customer/get-customer-property-value.mdx new file mode 100644 index 0000000..b24c6ca --- /dev/null +++ b/api-reference/customer/get-customer-property-value.mdx @@ -0,0 +1,14 @@ +--- +title: Get customer property value +description: Gets a specific property value for a customer +api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/property-values/{property_id}/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/customer/get-customer-request-detail.mdx b/api-reference/customer/get-customer-request-detail.mdx new file mode 100644 index 0000000..28dad78 --- /dev/null +++ b/api-reference/customer/get-customer-request-detail.mdx @@ -0,0 +1,14 @@ +--- +title: Get customer request details +description: Gets the details of a customer request +api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/{request_id}/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/customer/link-work-items-to-customer.mdx b/api-reference/customer/link-work-items-to-customer.mdx new file mode 100644 index 0000000..770b509 --- /dev/null +++ b/api-reference/customer/link-work-items-to-customer.mdx @@ -0,0 +1,18 @@ +--- +title: Link work items to customer +description: Links work items (issues) to a customer +api: POST /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/issues/ +--- + +### Path parameters + + + + + +### Body + + +Array of work item (issue) IDs to link to the customer + + diff --git a/api-reference/customer/list-customer-properties.mdx b/api-reference/customer/list-customer-properties.mdx new file mode 100644 index 0000000..a9bad51 --- /dev/null +++ b/api-reference/customer/list-customer-properties.mdx @@ -0,0 +1,24 @@ +--- +title: List customer properties +description: Gets all the customer property definitions in a workspace +api: GET /api/v1/workspaces/{workspace-slug}/customer-properties/ +--- + +### Path parameters + + + +### Query parameters + + +Filter by workspace UUID + + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/customer/list-customer-property-values.mdx b/api-reference/customer/list-customer-property-values.mdx new file mode 100644 index 0000000..5fd2fd4 --- /dev/null +++ b/api-reference/customer/list-customer-property-values.mdx @@ -0,0 +1,34 @@ +--- +title: List customer property values +description: Gets all the property values for a customer +api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/property-values/ +--- + +### Path parameters + + + + + +### Query parameters + + +Filter by customer UUID + + + +Filter by property UUID + + + +Filter by workspace UUID + + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/customer/list-customer-requests.mdx b/api-reference/customer/list-customer-requests.mdx new file mode 100644 index 0000000..80b0632 --- /dev/null +++ b/api-reference/customer/list-customer-requests.mdx @@ -0,0 +1,30 @@ +--- +title: List customer requests +description: Gets all the requests for a customer +api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/ +--- + +### Path parameters + + + + + +### Query parameters + + +Filter by customer UUID + + + +Filter by workspace UUID + + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/customer/list-customer-work-items.mdx b/api-reference/customer/list-customer-work-items.mdx new file mode 100644 index 0000000..b651dc4 --- /dev/null +++ b/api-reference/customer/list-customer-work-items.mdx @@ -0,0 +1,12 @@ +--- +title: List customer work items +description: Gets all the work items (issues) associated with a customer +api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/issues/ +--- + +### Path parameters + + + + + diff --git a/api-reference/customer/list-customers.mdx b/api-reference/customer/list-customers.mdx new file mode 100644 index 0000000..d0e752f --- /dev/null +++ b/api-reference/customer/list-customers.mdx @@ -0,0 +1,24 @@ +--- +title: List customers +description: Gets all the customers in a workspace +api: GET /api/v1/workspaces/{workspace-slug}/customers/ +--- + +### Path parameters + + + +### Query parameters + + +Filter by workspace UUID + + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/customer/overview.mdx b/api-reference/customer/overview.mdx new file mode 100644 index 0000000..7201e5a --- /dev/null +++ b/api-reference/customer/overview.mdx @@ -0,0 +1,98 @@ +--- +title: Overview +--- + +Customers allow you to manage customer relationships and track customer-related work items, requests, and custom properties within a workspace. + +## APIs + +### Customer Management + +```http +POST /api/v1/workspaces/:workspace-slug/customers/ +GET /api/v1/workspaces/:workspace-slug/customers/ +GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/ +PATCH /api/v1/workspaces/:workspace-slug/customers/:customer_id/ +DELETE /api/v1/workspaces/:workspace-slug/customers/:customer_id/ +``` + +### Customer Work Items + +```http +GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/issues/ +POST /api/v1/workspaces/:workspace-slug/customers/:customer_id/issues/ +DELETE /api/v1/workspaces/:workspace-slug/customers/:customer_id/issues/:issue_id/ +``` + +### Customer Properties + +```http +GET /api/v1/workspaces/:workspace-slug/customer-properties/ +POST /api/v1/workspaces/:workspace-slug/customer-properties/ +GET /api/v1/workspaces/:workspace-slug/customer-properties/:property_id/ +PATCH /api/v1/workspaces/:workspace-slug/customer-properties/:property_id/ +DELETE /api/v1/workspaces/:workspace-slug/customer-properties/:property_id/ +GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/property-values/ +GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/property-values/:property_id/ +PATCH /api/v1/workspaces/:workspace-slug/customers/:customer_id/property-values/:property_id/ +``` + +### Customer Requests + +```http +GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/ +POST /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/ +GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/:request_id/ +PATCH /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/:request_id/ +DELETE /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/:request_id/ +``` + +### Customer Object + +**Attributes** + +- `id` _uuid_ + + Unique identifier for the customer + +- `name` _string_ **(required)** + + Name of the customer + +- `email` _string_ + + Email address of the customer + +- `workspace` _uuid_ + + Workspace UUID which is automatically saved + +- `created_at` _timestamp_ + + The timestamp when the customer was created + +- `updated_at` _timestamp_ + + The timestamp when the customer was last updated + +- `created_by` _uuid_ + + ID of the user who created the customer + +- `updated_by` _uuid_ + + ID of the user who last updated the customer + + +```json JSON +{ + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "created_at": "2023-11-19T11:56:55.176802Z", + "updated_at": "2023-11-19T11:56:55.176809Z", + "name": "Acme Corporation", + "email": "contact@acme.com", + "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4" +} +``` + + diff --git a/api-reference/customer/unlink-work-item-from-customer.mdx b/api-reference/customer/unlink-work-item-from-customer.mdx new file mode 100644 index 0000000..9dfe921 --- /dev/null +++ b/api-reference/customer/unlink-work-item-from-customer.mdx @@ -0,0 +1,14 @@ +--- +title: Unlink work item from customer +description: Unlinks a work item (issue) from a customer +api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/issues/{issue_id}/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/customer/update-customer-detail.mdx b/api-reference/customer/update-customer-detail.mdx new file mode 100644 index 0000000..788efbc --- /dev/null +++ b/api-reference/customer/update-customer-detail.mdx @@ -0,0 +1,22 @@ +--- +title: Update customer details +description: Updates the details of a customer +api: PATCH /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/ +--- + +### Path parameters + + + + + +### Body + + +Name of the customer + + + +Email address of the customer + + diff --git a/api-reference/customer/update-customer-property-detail.mdx b/api-reference/customer/update-customer-property-detail.mdx new file mode 100644 index 0000000..6cca0b4 --- /dev/null +++ b/api-reference/customer/update-customer-property-detail.mdx @@ -0,0 +1,74 @@ +--- +title: Update customer property details +description: Updates the details of a customer property definition +api: PATCH /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/ +--- + +### Path parameters + + + + + +### Body + + +Name of the property + + + +Display name of the property + + + +Description of the property + + + +Type of the property + + + +Relation type of the property + + + +Whether the property is required + + + +Whether the property supports multiple values + + + +Whether the property is active + + + +Sort order for the property + + + +Default values for the property + + + +Settings for the property + + + +Validation rules for the property + + + +Logo properties for the property + + + +External source identifier + + + +External ID from the external source + + diff --git a/api-reference/customer/update-customer-property-value.mdx b/api-reference/customer/update-customer-property-value.mdx new file mode 100644 index 0000000..c1c5be4 --- /dev/null +++ b/api-reference/customer/update-customer-property-value.mdx @@ -0,0 +1,20 @@ +--- +title: Update customer property value +description: Updates a property value for a customer +api: PATCH /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/property-values/{property_id}/ +--- + +### Path parameters + + + + + + + +### Body + + +Array of values for the property + + diff --git a/api-reference/customer/update-customer-request-detail.mdx b/api-reference/customer/update-customer-request-detail.mdx new file mode 100644 index 0000000..77bbef4 --- /dev/null +++ b/api-reference/customer/update-customer-request-detail.mdx @@ -0,0 +1,24 @@ +--- +title: Update customer request details +description: Updates the details of a customer request +api: PATCH /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/{request_id}/ +--- + +### Path parameters + + + + + + + +### Body + + +Title of the request + + + +Description of the request + + diff --git a/api-reference/cycle-issue/overview.mdx b/api-reference/cycle-issue/overview.mdx deleted file mode 100644 index d1e6291..0000000 --- a/api-reference/cycle-issue/overview.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Overview ---- - -It contains all the list of issues which are inside a cycle. - -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/:issue_id/ -``` - -For creating a cycle issue, the payload should be sent in the below format. - -``` -{ - "issues": ["d7a45e13-be2a-4942-aa15-b82c2cf244d0","d23wefadf-dafADfadfadfqeqerqer"] -} -``` - -### Cycle Issue Object - -**Attributes** - -- `sub_issues_count` - - It tells the count of sub issues of the issue - -- `created_at` _timestamp_ - - The timestamp of the time when the project was created - -- `updated_at` _timestamp_ - - The timestamp of the time when the project was last updated - -- `created_by` , `updated_by` _uuid_ - - These values are auto saved and represent the id of the user that created or updated the module - -- `Project` uuid - - It contains projects uuid which is automatically saved. - -- `Workspace` uuid - - It contains workspace uuid which is automatically saved - -- `cycle` uuid - - Cycle id of which the issue belongs to - -- `issue` uuid - - Issue id of the issue - - -```json JSON -[ - { - "id": "81686eba-bd63-4fd1-b628-b08ecdb1db06", - "sub_issues_count": 0, - "created_at": "2023-11-20T05:02:41.238578Z", - "updated_at": "2023-11-20T05:02:41.238601Z", - "created_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c", - "updated_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c", - "project": "6436c4ae-fba7-45dc-ad4a-5440e17cb1b2", - "workspace": "c467e125-59e3-44ec-b5ee-f9c1e138c611", - "cycle": "866f3015-4811-4e8a-9577-e298a56488c5", - "issue": "2f9f16f7-604c-43d3-adb1-5466ade808aa" - } -] -``` - diff --git a/api-reference/cycle-issue/add-cycle-issue.mdx b/api-reference/cycle/add-cycle-work-items.mdx similarity index 76% rename from api-reference/cycle-issue/add-cycle-issue.mdx rename to api-reference/cycle/add-cycle-work-items.mdx index 40afbd7..add6a4b 100644 --- a/api-reference/cycle-issue/add-cycle-issue.mdx +++ b/api-reference/cycle/add-cycle-work-items.mdx @@ -1,6 +1,6 @@ --- -title: Add cycle issue -description: Adds an issue in a cycle +title: Add cycle work items +description: Adds work items (issues) to a cycle api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ --- @@ -15,6 +15,6 @@ api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycl ### Body -It expects a list of issue ids +List of work item (issue) IDs to add to the cycle diff --git a/api-reference/cycle/add-cycle.mdx b/api-reference/cycle/add-cycle.mdx index 1343e5d..520c70d 100644 --- a/api-reference/cycle/add-cycle.mdx +++ b/api-reference/cycle/add-cycle.mdx @@ -12,4 +12,38 @@ api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/ ### Body - + +Name of the cycle + + + +Description of the cycle + + + +Start date of the cycle in YYYY-MM-DD format + + + +End date of the cycle in YYYY-MM-DD format + + + +User ID of the cycle owner + + + +External source identifier + + + +External ID from the external source + + + +Timezone for the cycle + + + +Project ID for the cycle + diff --git a/api-reference/cycle/archive-cycle.mdx b/api-reference/cycle/archive-cycle.mdx new file mode 100644 index 0000000..9003827 --- /dev/null +++ b/api-reference/cycle/archive-cycle.mdx @@ -0,0 +1,14 @@ +--- +title: Archive cycle +description: Archives a cycle +api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/archived-cycles/{cycle_id}/archive/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/cycle/delete-cycle.mdx b/api-reference/cycle/delete-cycle.mdx index 6b6e765..f287b52 100644 --- a/api-reference/cycle/delete-cycle.mdx +++ b/api-reference/cycle/delete-cycle.mdx @@ -1,7 +1,7 @@ --- title: Delete cycle description: Deletes a cycle -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id} +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/ --- ### Path parameters diff --git a/api-reference/cycle/get-cycle-detail.mdx b/api-reference/cycle/get-cycle-detail.mdx index fc7e036..c329674 100644 --- a/api-reference/cycle/get-cycle-detail.mdx +++ b/api-reference/cycle/get-cycle-detail.mdx @@ -1,7 +1,7 @@ --- title: Get cycle details description: Gets the details of a cycle -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id} +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/ --- ### Path parameters diff --git a/api-reference/cycle/list-archived-cycles.mdx b/api-reference/cycle/list-archived-cycles.mdx new file mode 100644 index 0000000..2b8e476 --- /dev/null +++ b/api-reference/cycle/list-archived-cycles.mdx @@ -0,0 +1,12 @@ +--- +title: List archived cycles +description: Gets all the archived cycles in a project +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/archived-cycles/ +--- + +### Path parameters + + + + + diff --git a/api-reference/cycle-issue/list-cycle-issues.mdx b/api-reference/cycle/list-cycle-work-items.mdx similarity index 79% rename from api-reference/cycle-issue/list-cycle-issues.mdx rename to api-reference/cycle/list-cycle-work-items.mdx index a238717..cdcb804 100644 --- a/api-reference/cycle-issue/list-cycle-issues.mdx +++ b/api-reference/cycle/list-cycle-work-items.mdx @@ -1,6 +1,6 @@ --- -title: List cycle issues -description: Gets all the issues in a cycle +title: List cycle work items +description: Gets all the work items (issues) in a cycle api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ --- @@ -11,3 +11,4 @@ api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle + diff --git a/api-reference/cycle/overview.mdx b/api-reference/cycle/overview.mdx index 1b59e85..1ee7169 100644 --- a/api-reference/cycle/overview.mdx +++ b/api-reference/cycle/overview.mdx @@ -4,23 +4,23 @@ title: Overview Cycles is a custom time period in which a team works to complete items on their backlog. At the end of the sprint, the team will usually have finished building and implementing a new version of their project or product. +## APIs + ```http POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/ PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/ +GET /api/v1/workspaces/:workspace-slug/projects/:project_id/archived-cycles/ +POST /api/v1/workspaces/:workspace-slug/projects/:project_id/archived-cycles/:cycle_id/archive/ +DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/archived-cycles/:cycle_id/unarchive/ +GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/ +POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/ +DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/:issue_id/ POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/transfer-issues/ ``` -To transfer issues of one cycle to another, the payload should be sent in the below format - -``` -{ - "new_cycle_id": "2380ce13-1cc4-4f67-9f57-a2b7686886d7" -} -``` - ### Cycle Object **Attributes** @@ -71,6 +71,20 @@ To transfer issues of one cycle to another, the payload should be sent in the be - `owned_by` uuid + The user ID of the cycle owner + +- `archived_at` _timestamp_ + + The timestamp when the cycle was archived (if archived) + +- `timezone` string + + The timezone for the cycle + +- `version` number + + Version number of the cycle + ```json JSON { @@ -91,3 +105,4 @@ To transfer issues of one cycle to another, the payload should be sent in the be } ``` + diff --git a/api-reference/cycle-issue/delete-cycle-issue.mdx b/api-reference/cycle/remove-cycle-work-item.mdx similarity index 73% rename from api-reference/cycle-issue/delete-cycle-issue.mdx rename to api-reference/cycle/remove-cycle-work-item.mdx index 7cc8f6d..0547d76 100644 --- a/api-reference/cycle-issue/delete-cycle-issue.mdx +++ b/api-reference/cycle/remove-cycle-work-item.mdx @@ -1,7 +1,7 @@ --- -title: Delete cycle issue -description: Deletes an issue in a cycle -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id} +title: Remove cycle work item +description: Removes a work item (issue) from a cycle +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ --- ### Path parameters @@ -13,3 +13,4 @@ api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cy + diff --git a/api-reference/cycle/transfer-cycle-work-items.mdx b/api-reference/cycle/transfer-cycle-work-items.mdx new file mode 100644 index 0000000..c3a6eaa --- /dev/null +++ b/api-reference/cycle/transfer-cycle-work-items.mdx @@ -0,0 +1,20 @@ +--- +title: Transfer cycle work items +description: Transfers work items (issues) from one cycle to another +api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ +--- + +### Path parameters + + + + + + + +### Body + + +ID of the target cycle to transfer work items to + + diff --git a/api-reference/cycle/unarchive-cycle.mdx b/api-reference/cycle/unarchive-cycle.mdx new file mode 100644 index 0000000..d895b1b --- /dev/null +++ b/api-reference/cycle/unarchive-cycle.mdx @@ -0,0 +1,14 @@ +--- +title: Unarchive cycle +description: Unarchives a cycle +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/archived-cycles/{cycle_id}/unarchive/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/cycle/update-cycle-detail.mdx b/api-reference/cycle/update-cycle-detail.mdx index e459c4e..eaf7561 100644 --- a/api-reference/cycle/update-cycle-detail.mdx +++ b/api-reference/cycle/update-cycle-detail.mdx @@ -1,7 +1,7 @@ --- title: Update cycle details description: Updates the details of a cycle -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id} +api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/ --- ### Path parameters @@ -14,4 +14,34 @@ api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cyc ### Body - \ No newline at end of file + +Name of the cycle + + + +Description of the cycle + + + +Start date of the cycle in YYYY-MM-DD format + + + +End date of the cycle in YYYY-MM-DD format + + + +User ID of the cycle owner + + + +External source identifier + + + +External ID from the external source + + + +Timezone for the cycle + \ No newline at end of file diff --git a/api-reference/initiative/add-epics-to-initiative.mdx b/api-reference/initiative/add-epics-to-initiative.mdx new file mode 100644 index 0000000..4663dbe --- /dev/null +++ b/api-reference/initiative/add-epics-to-initiative.mdx @@ -0,0 +1,18 @@ +--- +title: Add epics to initiative +description: Adds epics to an initiative +api: POST /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/epics/ +--- + +### Path parameters + + + + + +### Body + + +Array of epic IDs to add to the initiative + + diff --git a/api-reference/initiative/add-initiative-label.mdx b/api-reference/initiative/add-initiative-label.mdx new file mode 100644 index 0000000..6455b9f --- /dev/null +++ b/api-reference/initiative/add-initiative-label.mdx @@ -0,0 +1,28 @@ +--- +title: Add initiative label +description: Creates a new initiative label in a workspace +api: POST /api/v1/workspaces/{workspace-slug}/initiatives/labels/ +--- + +### Path parameters + + + +### Body + + +Name of the initiative label + + + +Description of the initiative label + + + +Color code for the initiative label + + + +Sort order for the initiative label + + diff --git a/api-reference/initiative/add-initiative.mdx b/api-reference/initiative/add-initiative.mdx new file mode 100644 index 0000000..3240df6 --- /dev/null +++ b/api-reference/initiative/add-initiative.mdx @@ -0,0 +1,52 @@ +--- +title: Add initiative +description: Creates a new initiative in a workspace +api: POST /api/v1/workspaces/{workspace-slug}/initiatives/ +--- + +### Path parameters + + + +### Body + + +Name of the initiative + + + +Plain text description of the initiative + + + +HTML description of the initiative + + + +Stripped version of the HTML description + + + +Binary description of the initiative + + + +User ID of the initiative lead + + + +Start date of the initiative in YYYY-MM-DD format + + + +End date of the initiative in YYYY-MM-DD format + + + +Logo properties for the initiative + + + +State of the initiative. Can be: DRAFT, PLANNED, ACTIVE, COMPLETED, CLOSED + + diff --git a/api-reference/initiative/add-labels-to-initiative.mdx b/api-reference/initiative/add-labels-to-initiative.mdx new file mode 100644 index 0000000..1282b48 --- /dev/null +++ b/api-reference/initiative/add-labels-to-initiative.mdx @@ -0,0 +1,18 @@ +--- +title: Add labels to initiative +description: Adds labels to an initiative +api: POST /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/labels/ +--- + +### Path parameters + + + + + +### Body + + +Array of initiative label IDs to add to the initiative + + diff --git a/api-reference/initiative/add-projects-to-initiative.mdx b/api-reference/initiative/add-projects-to-initiative.mdx new file mode 100644 index 0000000..0512933 --- /dev/null +++ b/api-reference/initiative/add-projects-to-initiative.mdx @@ -0,0 +1,18 @@ +--- +title: Add projects to initiative +description: Adds projects to an initiative +api: POST /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/projects/ +--- + +### Path parameters + + + + + +### Body + + +Array of project IDs to add to the initiative + + diff --git a/api-reference/initiative/delete-initiative-label.mdx b/api-reference/initiative/delete-initiative-label.mdx new file mode 100644 index 0000000..d7ef6bd --- /dev/null +++ b/api-reference/initiative/delete-initiative-label.mdx @@ -0,0 +1,12 @@ +--- +title: Delete initiative label +description: Deletes an initiative label +api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/labels/{label_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/initiative/delete-initiative.mdx b/api-reference/initiative/delete-initiative.mdx new file mode 100644 index 0000000..d7d47a1 --- /dev/null +++ b/api-reference/initiative/delete-initiative.mdx @@ -0,0 +1,12 @@ +--- +title: Delete initiative +description: Deletes an initiative +api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/initiative/get-initiative-detail.mdx b/api-reference/initiative/get-initiative-detail.mdx new file mode 100644 index 0000000..690522a --- /dev/null +++ b/api-reference/initiative/get-initiative-detail.mdx @@ -0,0 +1,12 @@ +--- +title: Get initiative details +description: Gets the details of an initiative +api: GET /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/initiative/get-initiative-label-detail.mdx b/api-reference/initiative/get-initiative-label-detail.mdx new file mode 100644 index 0000000..719e771 --- /dev/null +++ b/api-reference/initiative/get-initiative-label-detail.mdx @@ -0,0 +1,12 @@ +--- +title: Get initiative label details +description: Gets the details of an initiative label +api: GET /api/v1/workspaces/{workspace-slug}/initiatives/labels/{label_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/initiative/list-initiative-epics.mdx b/api-reference/initiative/list-initiative-epics.mdx new file mode 100644 index 0000000..9e047d7 --- /dev/null +++ b/api-reference/initiative/list-initiative-epics.mdx @@ -0,0 +1,22 @@ +--- +title: List initiative epics +description: Gets all the epics associated with an initiative +api: GET /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/epics/ +--- + +### Path parameters + + + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/initiative/list-initiative-labels-for-initiative.mdx b/api-reference/initiative/list-initiative-labels-for-initiative.mdx new file mode 100644 index 0000000..8e9626b --- /dev/null +++ b/api-reference/initiative/list-initiative-labels-for-initiative.mdx @@ -0,0 +1,22 @@ +--- +title: List initiative labels for initiative +description: Gets all the labels associated with an initiative +api: GET /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/labels/ +--- + +### Path parameters + + + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/initiative/list-initiative-labels.mdx b/api-reference/initiative/list-initiative-labels.mdx new file mode 100644 index 0000000..64a15b5 --- /dev/null +++ b/api-reference/initiative/list-initiative-labels.mdx @@ -0,0 +1,20 @@ +--- +title: List initiative labels +description: Gets all the initiative labels in a workspace +api: GET /api/v1/workspaces/{workspace-slug}/initiatives/labels/ +--- + +### Path parameters + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/initiative/list-initiative-projects.mdx b/api-reference/initiative/list-initiative-projects.mdx new file mode 100644 index 0000000..15b0856 --- /dev/null +++ b/api-reference/initiative/list-initiative-projects.mdx @@ -0,0 +1,22 @@ +--- +title: List initiative projects +description: Gets all the projects associated with an initiative +api: GET /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/projects/ +--- + +### Path parameters + + + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/initiative/list-initiatives.mdx b/api-reference/initiative/list-initiatives.mdx new file mode 100644 index 0000000..6adcb64 --- /dev/null +++ b/api-reference/initiative/list-initiatives.mdx @@ -0,0 +1,20 @@ +--- +title: List initiatives +description: Gets all the initiatives in a workspace +api: GET /api/v1/workspaces/{workspace-slug}/initiatives/ +--- + +### Path parameters + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/initiative/overview.mdx b/api-reference/initiative/overview.mdx new file mode 100644 index 0000000..a0ba14c --- /dev/null +++ b/api-reference/initiative/overview.mdx @@ -0,0 +1,133 @@ +--- +title: Overview +--- + +Initiatives are high-level strategic goals that help organize and track work across multiple projects, epics, and work items. They provide a way to group related work and measure progress toward larger objectives. + +## APIs + +### Initiative Management + +```http +POST /api/v1/workspaces/:workspace-slug/initiatives/ +GET /api/v1/workspaces/:workspace-slug/initiatives/ +GET /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/ +PATCH /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/ +DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/ +``` + +### Initiative Labels + +```http +POST /api/v1/workspaces/:workspace-slug/initiatives/labels/ +GET /api/v1/workspaces/:workspace-slug/initiatives/labels/ +GET /api/v1/workspaces/:workspace-slug/initiatives/labels/:label_id/ +PATCH /api/v1/workspaces/:workspace-slug/initiatives/labels/:label_id/ +DELETE /api/v1/workspaces/:workspace-slug/initiatives/labels/:label_id/ +GET /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/labels/ +POST /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/labels/ +DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/labels/ +``` + +### Initiative Projects + +```http +GET /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/projects/ +POST /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/projects/ +DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/projects/ +``` + +### Initiative Epics + +```http +GET /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/epics/ +POST /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/epics/ +DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/epics/ +``` + +### Initiative Object + +**Attributes** + +- `id` _uuid_ + + Unique identifier for the initiative + +- `name` _string_ **(required)** + + Name of the initiative + +- `description` _string_ + + Plain text description of the initiative + +- `description_html` _string_ + + HTML description of the initiative + +- `description_stripped` _string_ + + Stripped version of the HTML description + +- `description_binary` _string_ + + Binary description of the initiative + +- `lead` _uuid_ + + User ID of the initiative lead + +- `start_date` _date_ + + Start date of the initiative in YYYY-MM-DD format + +- `end_date` _date_ + + End date of the initiative in YYYY-MM-DD format + +- `logo_props` _object_ + + Logo properties for the initiative + +- `state` _string_ + + State of the initiative. Can be: DRAFT, PLANNED, ACTIVE, COMPLETED, CLOSED + +- `workspace` _uuid_ + + Workspace UUID which is automatically saved + +- `created_at` _timestamp_ + + The timestamp when the initiative was created + +- `updated_at` _timestamp_ + + The timestamp when the initiative was last updated + +- `created_by` _uuid_ + + ID of the user who created the initiative + +- `updated_by` _uuid_ + + ID of the user who last updated the initiative + + +```json JSON +{ + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "created_at": "2023-11-19T11:56:55.176802Z", + "updated_at": "2023-11-19T11:56:55.176809Z", + "name": "Q1 Product Launch", + "description": "Launch new product features in Q1", + "description_html": "

Launch new product features in Q1

", + "lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430", + "start_date": "2024-01-01", + "end_date": "2024-03-31", + "state": "ACTIVE", + "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4" +} +``` + + diff --git a/api-reference/initiative/remove-epics-from-initiative.mdx b/api-reference/initiative/remove-epics-from-initiative.mdx new file mode 100644 index 0000000..65fd2a7 --- /dev/null +++ b/api-reference/initiative/remove-epics-from-initiative.mdx @@ -0,0 +1,18 @@ +--- +title: Remove epics from initiative +description: Removes epics from an initiative +api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/epics/ +--- + +### Path parameters + + + + + +### Body + + +Array of epic IDs to remove from the initiative + + diff --git a/api-reference/initiative/remove-labels-from-initiative.mdx b/api-reference/initiative/remove-labels-from-initiative.mdx new file mode 100644 index 0000000..7d64660 --- /dev/null +++ b/api-reference/initiative/remove-labels-from-initiative.mdx @@ -0,0 +1,18 @@ +--- +title: Remove labels from initiative +description: Removes labels from an initiative +api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/labels/ +--- + +### Path parameters + + + + + +### Body + + +Array of initiative label IDs to remove from the initiative + + diff --git a/api-reference/initiative/remove-projects-from-initiative.mdx b/api-reference/initiative/remove-projects-from-initiative.mdx new file mode 100644 index 0000000..c6c87e5 --- /dev/null +++ b/api-reference/initiative/remove-projects-from-initiative.mdx @@ -0,0 +1,18 @@ +--- +title: Remove projects from initiative +description: Removes projects from an initiative +api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/projects/ +--- + +### Path parameters + + + + + +### Body + + +Array of project IDs to remove from the initiative + + diff --git a/api-reference/initiative/update-initiative-detail.mdx b/api-reference/initiative/update-initiative-detail.mdx new file mode 100644 index 0000000..ed294a0 --- /dev/null +++ b/api-reference/initiative/update-initiative-detail.mdx @@ -0,0 +1,54 @@ +--- +title: Update initiative details +description: Updates the details of an initiative +api: PATCH /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/ +--- + +### Path parameters + + + + + +### Body + + +Name of the initiative + + + +Plain text description of the initiative + + + +HTML description of the initiative + + + +Stripped version of the HTML description + + + +Binary description of the initiative + + + +User ID of the initiative lead + + + +Start date of the initiative in YYYY-MM-DD format + + + +End date of the initiative in YYYY-MM-DD format + + + +Logo properties for the initiative + + + +State of the initiative. Can be: DRAFT, PLANNED, ACTIVE, COMPLETED, CLOSED + + diff --git a/api-reference/initiative/update-initiative-label-detail.mdx b/api-reference/initiative/update-initiative-label-detail.mdx new file mode 100644 index 0000000..22c7730 --- /dev/null +++ b/api-reference/initiative/update-initiative-label-detail.mdx @@ -0,0 +1,30 @@ +--- +title: Update initiative label details +description: Updates the details of an initiative label +api: PATCH /api/v1/workspaces/{workspace-slug}/initiatives/labels/{label_id}/ +--- + +### Path parameters + + + + + +### Body + + +Name of the initiative label + + + +Description of the initiative label + + + +Color code for the initiative label + + + +Sort order for the initiative label + + diff --git a/api-reference/issue-activity/get-issue-activity-detail.mdx b/api-reference/issue-activity/get-issue-activity-detail.mdx index 89d158b..cedfe13 100644 --- a/api-reference/issue-activity/get-issue-activity-detail.mdx +++ b/api-reference/issue-activity/get-issue-activity-detail.mdx @@ -1,7 +1,7 @@ --- -title: Get issue activity details -description: Gets the details of an activity -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/activities/{activity_id} +title: Get work item activity details +description: Gets the details of a work item activity +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/activities/{activity_id}/ --- ### Path parameters diff --git a/api-reference/issue-activity/list-issue-activities.mdx b/api-reference/issue-activity/list-issue-activities.mdx index 52c296f..4e6bee3 100644 --- a/api-reference/issue-activity/list-issue-activities.mdx +++ b/api-reference/issue-activity/list-issue-activities.mdx @@ -1,6 +1,6 @@ --- -title: List issue activity -description: Gets the activities of an issue +title: List work item activities +description: Gets the activities of a work item api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/activities/ --- diff --git a/api-reference/issue-activity/overview.mdx b/api-reference/issue-activity/overview.mdx index 6208a56..be43278 100644 --- a/api-reference/issue-activity/overview.mdx +++ b/api-reference/issue-activity/overview.mdx @@ -1,24 +1,35 @@ --- title: Overview -description: Issue activities are the history of all the changes that happened to the issue like property changes etc. --- +Work item activities are the history of all the changes that happened to the work item like property changes etc. + +## APIs + ```http GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/activities/ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/activities/:activity_id/ ``` -### Issue Activity Object +### Work Item Activity Object **Attributes** +- `id` _uuid_ + + Unique identifier for the activity + - `created_at` _timestamp_ - The timestamp of the time when the project was created + The timestamp of the time when the activity was created - `updated_at` _timestamp_ - The timestamp of the time when the project was last updated + The timestamp of the time when the activity was last updated + +- `deleted_at` _timestamp_ or _null_ + + The timestamp when the activity was deleted (if deleted) - `verb` _string_ @@ -66,7 +77,7 @@ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ - `issue` _uuid_ - The issue the activity is attached to + The work item the activity is attached to - `issue_comment` _uuid or null_ @@ -74,7 +85,7 @@ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ - `actor` uuid - The actor who triggered this actor + The actor who triggered this activity ```json JSON @@ -86,7 +97,7 @@ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ "field": null, "old_value": null, "new_value": null, - "comment": "created the issue", + "comment": "created the work item", "attachments": [], "old_identifier": null, "new_identifier": null, diff --git a/api-reference/issue-attachments/complete-upload.mdx b/api-reference/issue-attachments/complete-upload.mdx index 1ce144d..341e280 100644 --- a/api-reference/issue-attachments/complete-upload.mdx +++ b/api-reference/issue-attachments/complete-upload.mdx @@ -11,7 +11,7 @@ The workspace-slug represents the unique workspace identifier for a workspace in The unique identifier of the project -The unique identifier of the issue +The unique identifier of the work item The unique identifier of the attachment generated by the [Get upload credentials](/api-reference/issue-attachments/get-upload-credentials#response) endpoint. diff --git a/api-reference/issue-attachments/delete-attachment.mdx b/api-reference/issue-attachments/delete-attachment.mdx new file mode 100644 index 0000000..5a186c5 --- /dev/null +++ b/api-reference/issue-attachments/delete-attachment.mdx @@ -0,0 +1,18 @@ +--- +title: Delete attachment +description: Deletes an attachment from a work item +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{attachment_id}/ +--- + +### Path parameters + + +The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + +The unique identifier of the project + +The unique identifier of the work item + +The unique identifier of the attachment + diff --git a/api-reference/issue-attachments/get-attachment-detail.mdx b/api-reference/issue-attachments/get-attachment-detail.mdx new file mode 100644 index 0000000..2fd6235 --- /dev/null +++ b/api-reference/issue-attachments/get-attachment-detail.mdx @@ -0,0 +1,18 @@ +--- +title: Get attachment details +description: Gets the details of a specific attachment +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{attachment_id}/ +--- + +### Path parameters + + +The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + +The unique identifier of the project + +The unique identifier of the work item + +The unique identifier of the attachment + diff --git a/api-reference/issue-attachments/get-attachments.mdx b/api-reference/issue-attachments/get-attachments.mdx index eef7cc0..76fa376 100644 --- a/api-reference/issue-attachments/get-attachments.mdx +++ b/api-reference/issue-attachments/get-attachments.mdx @@ -1,6 +1,6 @@ --- title: Get attachments -description: Gets all the attachments in the issue. +description: Gets all the attachments in the work item. api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/ --- @@ -11,7 +11,29 @@ The workspace-slug represents the unique workspace identifier for a workspace in The unique identifier of the project -The unique identifier of the issue +The unique identifier of the work item + +### Query parameters + + +Filter by work item UUID + + + +Filter by project UUID + + + +Filter by workspace UUID + + + +Number of results to return + + + +Number of results to skip + ### Response diff --git a/api-reference/issue-attachments/get-upload-credentials.mdx b/api-reference/issue-attachments/get-upload-credentials.mdx index ac09ab2..8575025 100644 --- a/api-reference/issue-attachments/get-upload-credentials.mdx +++ b/api-reference/issue-attachments/get-upload-credentials.mdx @@ -11,14 +11,26 @@ The workspace-slug represents the unique workspace identifier for a workspace in The unique identifier of the project -The unique identifier of the issue +The unique identifier of the work item ### Body Original filename of the attachment -MIME type of the file (e.g., `image/png`, `application/pdf`) + + +MIME type of the file (e.g., `image/png`, `application/pdf`) + + Size of the file in bytes + +External identifier for the asset (for integration tracking) + + + +External source system (for integration tracking) + + ### Response Returns an object containing the S3 pre-signed POST data for direct upload. diff --git a/api-reference/issue-attachments/overview.mdx b/api-reference/issue-attachments/overview.mdx index d4c14de..e4fe10e 100644 --- a/api-reference/issue-attachments/overview.mdx +++ b/api-reference/issue-attachments/overview.mdx @@ -1,12 +1,17 @@ --- title: Overview -description: Allows you to manage file attachments associated with issues and Intake issues. You can upload new attachments and retrieve existing attachments for a specific issue. --- +Allows you to manage file attachments associated with work items and Intake issues. You can upload new attachments and retrieve existing attachments for a specific work item. + +## APIs + ```http GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/ +GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/:attachment_id/ POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/asset-id/ +PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/:attachment_id/ +DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/:attachment_id/ ``` ## Upload Process @@ -15,7 +20,7 @@ PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ 2. [Upload the file](/api-reference/issue-attachments/upload-file) to storage. 3. [Complete attachment upload](/api-reference/issue-attachments/complete-upload) to notify server. -## Issue attachment object +## Work Item Attachment Object **Attributes** @@ -47,9 +52,13 @@ PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ Storage path/identifier for the attachment file -* `entity-type` _string_ +* `entity_type` _string_ + + Always `ISSUE_ATTACHMENT` for work item attachments + +* `entity_identifier` _string_ - Always `ISSUE_ATTACHMENT` for issue attachments + Entity identifier for the attachment * `is_deleted` _boolean_ @@ -117,11 +126,27 @@ PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ * `project` _string_ - ID of project containing the issue + ID of project containing the work item * `issue` _string_ - ID of issue containing the attachment + ID of work item containing the attachment + +* `user` _string_ + + ID of user associated with the attachment + +* `draft_issue` _string_ + + ID of draft work item if applicable + +* `comment` _string_ + + ID of comment if attachment is associated with a comment + +* `page` _string_ + + ID of page if attachment is associated with a page diff --git a/api-reference/issue-attachments/update-attachment.mdx b/api-reference/issue-attachments/update-attachment.mdx new file mode 100644 index 0000000..76cec2a --- /dev/null +++ b/api-reference/issue-attachments/update-attachment.mdx @@ -0,0 +1,64 @@ +--- +title: Update attachment +description: Updates the details of an attachment +api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{attachment_id}/ +--- + +### Path parameters + + +The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + +The unique identifier of the project + +The unique identifier of the work item + +The unique identifier of the attachment + +### Body + + +File metadata object containing name, size, and type + + + +Storage path/identifier for the attachment file + + + +Entity type of the attachment + + + +Entity identifier for the attachment + + + +Whether the attachment has been deleted + + + +Whether the attachment has been archived + + + +External identifier if the attachment is imported to Plane + + + +Name of the source if the attachment is imported to Plane + + + +File size in bytes + + + +Whether the file has been successfully uploaded + + + +Cloud storage metadata + + diff --git a/api-reference/issue-comment/add-issue-comment.mdx b/api-reference/issue-comment/add-issue-comment.mdx index 3c95fa0..cbbc1cb 100644 --- a/api-reference/issue-comment/add-issue-comment.mdx +++ b/api-reference/issue-comment/add-issue-comment.mdx @@ -1,6 +1,6 @@ --- -title: Add issue comment -description: Adds a comment to an issue +title: Add work item comment +description: Adds a comment to a work item api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/ --- @@ -14,4 +14,22 @@ api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issu ### Body - + +HTML string version of the comment + + + +JSON object version of the comment + + + +Access level of the comment. Can be: INTERNAL, EXTERNAL + + + +External source identifier + + + +External ID from the external source + diff --git a/api-reference/issue-comment/delete-issue-comment.mdx b/api-reference/issue-comment/delete-issue-comment.mdx index 7a4670a..895732a 100644 --- a/api-reference/issue-comment/delete-issue-comment.mdx +++ b/api-reference/issue-comment/delete-issue-comment.mdx @@ -1,7 +1,7 @@ --- -title: Delete issue comment -description: Deletes a comment of an issue -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id} +title: Delete work item comment +description: Deletes a comment of a work item +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id}/ --- ### Path parameters diff --git a/api-reference/issue-comment/get-issue-comment-detail.mdx b/api-reference/issue-comment/get-issue-comment-detail.mdx index 04dd23a..adf2a9d 100644 --- a/api-reference/issue-comment/get-issue-comment-detail.mdx +++ b/api-reference/issue-comment/get-issue-comment-detail.mdx @@ -1,7 +1,7 @@ --- -title: Get issue comment details -description: Gets the details of a comment of an issue -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id} +title: Get work item comment details +description: Gets the details of a comment of a work item +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id}/ --- ### Path parameters diff --git a/api-reference/issue-comment/list-issue-comments.mdx b/api-reference/issue-comment/list-issue-comments.mdx index bd4aadf..6874f0f 100644 --- a/api-reference/issue-comment/list-issue-comments.mdx +++ b/api-reference/issue-comment/list-issue-comments.mdx @@ -1,6 +1,6 @@ --- -title: List issue comments -description: Gets all the comments of an issue +title: List work item comments +description: Gets all the comments of a work item api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/ --- @@ -10,4 +10,26 @@ api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue - \ No newline at end of file + + +### Query parameters + + +Filter by work item UUID + + + +Filter by project UUID + + + +Filter by workspace UUID + + + +Number of results to return + + + +Number of results to skip + \ No newline at end of file diff --git a/api-reference/issue-comment/overview.mdx b/api-reference/issue-comment/overview.mdx index f244630..7a7300f 100644 --- a/api-reference/issue-comment/overview.mdx +++ b/api-reference/issue-comment/overview.mdx @@ -1,8 +1,11 @@ --- title: Overview -description: The comments that are added to the issue --- +The comments that are added to the work item. + +## APIs + ```http POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/comments/ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/comments/ @@ -11,23 +14,31 @@ PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/comments/:comment_id/ ``` -### Issue Comment Object +### Work Item Comment Object **Attributes** -- `created_by` , `updated_by` _uuid_ +- `id` _uuid_ - These values are auto saved and represent the id of the user that created or updated the module + Unique identifier for the comment - `created_at` _timestamp_ - The timestamp of the time when the project was created + The timestamp when the comment was created - `updated_at` _timestamp_ - The timestamp of the time when the project was last updated + The timestamp when the comment was last updated + +- `deleted_at` _timestamp_ or _null_ + + The timestamp when the comment was deleted (if deleted) -- `comment_html` html \*string **(required)\*** +- `edited_at` _timestamp_ or _null_ + + The timestamp when the comment was last edited + +- `comment_html` _string_ HTML string version of the comment @@ -35,6 +46,14 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ Stripped string version of the comment +- `comment_json` _object_ + + JSON object version of the comment + +- `attachments` _string[]_ + + Array of attachment URLs + - `access` _string_ If the comment should be visible externally also if the project is published or not. Takes in two values @@ -42,9 +61,25 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ - INTERNAL - EXTERNAL +- `external_source` _string_ + + External source identifier + +- `external_id` _string_ + + External ID from the external source + +- `is_member` _boolean_ + + Whether the current user is a member of the project + +- `created_by` , `updated_by` _uuid_ + + These values are auto saved and represent the id of the user that created or updated the comment + - `project` uuid - It contains projects uuid which is automatically saved. + It contains project uuid which is automatically saved. - `workspace` uuid @@ -52,7 +87,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ - `issue` _uuid_ - The issue the activity is attached to + The work item the comment is attached to - `actor` _uuid_ diff --git a/api-reference/issue-comment/update-issue-comment-detail.mdx b/api-reference/issue-comment/update-issue-comment-detail.mdx index 3161891..f75e79b 100644 --- a/api-reference/issue-comment/update-issue-comment-detail.mdx +++ b/api-reference/issue-comment/update-issue-comment-detail.mdx @@ -1,7 +1,7 @@ --- -title: Update issue comment details -description: Gets the details of a comment of an issue -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id} +title: Update work item comment details +description: Updates the details of a comment of a work item +api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id}/ --- ### Path parameters @@ -16,4 +16,22 @@ api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{iss ### Body - + +HTML string version of the comment + + + +JSON object version of the comment + + + +Access level of the comment. Can be: INTERNAL, EXTERNAL + + + +External source identifier + + + +External ID from the external source + diff --git a/api-reference/issue-types/types/add-issue-type.mdx b/api-reference/issue-types/types/add-issue-type.mdx index f81f48a..4fa7b3d 100644 --- a/api-reference/issue-types/types/add-issue-type.mdx +++ b/api-reference/issue-types/types/add-issue-type.mdx @@ -1,16 +1,41 @@ --- -title: Add issue type -description: Lets you create custom issue types in your project. -api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/ +title: Add work item type +description: Creates a new work item type in your project +api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/ --- ### Path parameters - + + ### Body - - - + +Name of the work item type + + + +Description of the work item type + + + +Logo properties for the work item type + + + +Whether this work item type is an epic + + + +Whether this is the default work item type + + + +Whether this work item type is active + + + +Level of the work item type + diff --git a/api-reference/issue-types/types/delete-issue-type.mdx b/api-reference/issue-types/types/delete-issue-type.mdx index b494557..b51082a 100644 --- a/api-reference/issue-types/types/delete-issue-type.mdx +++ b/api-reference/issue-types/types/delete-issue-type.mdx @@ -1,11 +1,13 @@ --- -title: Delete issue type -description: Lets you to remove an existing issue type from your project. -api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/ +title: Delete work item type +description: Deletes a work item type from your project +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/{work_item_type_id}/ --- ### Path parameters - + + - + + diff --git a/api-reference/issue-types/types/get-issue-type-details.mdx b/api-reference/issue-types/types/get-issue-type-details.mdx index 0bcb772..ca7eac0 100644 --- a/api-reference/issue-types/types/get-issue-type-details.mdx +++ b/api-reference/issue-types/types/get-issue-type-details.mdx @@ -1,11 +1,13 @@ --- -title: Get issue type details -description: Retrieves details for a specific issue type using its unique ID. -api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/ +title: Get work item type details +description: Retrieves details for a specific work item type using its unique ID +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/{work_item_type_id}/ --- ### Path parameters - + + - + + diff --git a/api-reference/issue-types/types/list-issue-types.mdx b/api-reference/issue-types/types/list-issue-types.mdx index f3f7410..b8d99a6 100644 --- a/api-reference/issue-types/types/list-issue-types.mdx +++ b/api-reference/issue-types/types/list-issue-types.mdx @@ -1,10 +1,25 @@ --- -title: List issue types -description: Fetches all available issue types in your project. -api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/ +title: List work item types +description: Fetches all available work item types in your project +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/ --- ### Path parameters - + + + +### Query parameters + + +Project UUID to filter work item types + + + +Number of results to return + + + +Number of results to skip + diff --git a/api-reference/issue-types/types/overview.mdx b/api-reference/issue-types/types/overview.mdx index 8b6867d..50a6a11 100644 --- a/api-reference/issue-types/types/overview.mdx +++ b/api-reference/issue-types/types/overview.mdx @@ -1,59 +1,110 @@ --- title: Overview -description: Provides a comprehensive suite of endpoints for adding, modifying, and deleting issue types within your project. +description: Provides a comprehensive suite of endpoints for adding, modifying, and deleting work item types within your project. --- +## APIs + ```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type_id/ +POST /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/ +GET /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/ +GET /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/:work_item_type_id/ +PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/:work_item_type_id/ +DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/:work_item_type_id/ ``` -### Issue Types Object +### Work Item Type Object + +**Attributes** + +- `id` _uuid_ + + Unique identifier for the work item type + +- `name` _string_ + + Name of the work item type + +- `description` _string_ + + Description of the work item type + +- `logo_props` _object_ + + Logo properties for the work item type + +- `is_epic` _boolean_ + + Whether this work item type is an epic + +- `is_default` _boolean_ + + Whether this is the default work item type + +- `is_active` _boolean_ + + Whether this work item type is active + +- `level` _number_ + + Level of the work item type - `workspace` _uuid_ - The workspace which the issue is part of auto generated from backend + The workspace which the work item type is part of (auto generated from backend) - `project` _uuid_ - The project which the issue is part of auto generated from backend + The project which the work item type is part of (auto generated from backend) -- `created_at` , `updated_at` timestamp +- `created_at` _timestamp_ - Timestamp of the issue when it was created and when it was last updated. + Timestamp when the work item type was created -- `created_by` & `updated_by` +- `updated_at` _timestamp_ - This values are auto saved and represent the id of the user that created or the updated the project. + Timestamp when the work item type was last updated -- `external_id` & `external_source` +- `created_by` _uuid_ - This values are auto saved and represent the id of the user that created or the updated the project. + ID of the user who created the work item type (auto saved) - +- `updated_by` _uuid_ + + ID of the user who last updated the work item type (auto saved) + +- `deleted_at` _timestamp_ + Timestamp when the work item type was deleted (null if not deleted) + +- `external_id` _string_ + + External ID for the work item type (auto saved) + +- `external_source` _string_ + + External source for the work item type (auto saved) + + ```json JSON { - "id": "d6af3c13-3459-43ab-b91c-c33ef2fd7131", - "name": "Postman issue type", - "description": "Postman issue type description", - "logo_props": {}, - "level": 0, - "is_active": true, - "is_default": false, - "deleted_at": null, - "workspace": "70b6599f-9313-4c0d-b5c0-406a13a05647", - "project": "", // missing - "created_by": "9d6d1ecd-bf73-4169-80c8-7dee79b217f4", - "updated_by": "9d6d1ecd-bf73-4169-80c8-7dee79b217f4", - "created_at": "2024-10-23T06:54:46.169344Z", - "updated_at": "2024-10-23T06:54:46.169390Z" - "external_id": null, - "external_source": null, + "id": "d6af3c13-3459-43ab-b91c-c33ef2fd7131", + "name": "Postman work item type", + "description": "Postman work item type description", + "logo_props": {}, + "is_epic": false, + "is_default": false, + "is_active": true, + "level": 0, + "workspace": "70b6599f-9313-4c0d-b5c0-406a13a05647", + "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "created_at": "2024-10-23T06:54:46.169344Z", + "updated_at": "2024-10-23T06:54:46.169390Z", + "created_by": "9d6d1ecd-bf73-4169-80c8-7dee79b217f4", + "updated_by": "9d6d1ecd-bf73-4169-80c8-7dee79b217f4", + "deleted_at": null, + "external_id": null, + "external_source": null } ``` - diff --git a/api-reference/issue-types/types/update-issue-types.mdx b/api-reference/issue-types/types/update-issue-types.mdx index 41636d4..4025d6d 100644 --- a/api-reference/issue-types/types/update-issue-types.mdx +++ b/api-reference/issue-types/types/update-issue-types.mdx @@ -1,17 +1,43 @@ --- -title: Update issue type -description: Allows you to modify an existing issue type. -api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/ +title: Update work item type +description: Updates the details of a work item type +api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/{work_item_type_id}/ --- ### Path parameters - + + - + + ### Body - - - + +Name of the work item type + + + +Description of the work item type + + + +Logo properties for the work item type + + + +Whether this work item type is an epic + + + +Whether this is the default work item type + + + +Whether this work item type is active + + + +Level of the work item type + diff --git a/api-reference/issue/add-issue.mdx b/api-reference/issue/add-issue.mdx index 86cab14..96efb4f 100644 --- a/api-reference/issue/add-issue.mdx +++ b/api-reference/issue/add-issue.mdx @@ -1,6 +1,6 @@ --- -title: Add issue -description: Adds an issue to a project +title: Add work item +description: Adds a work item to a project api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/ --- @@ -12,4 +12,50 @@ api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/ ### Body - + +Name of the work item + + + +HTML description of the work item + + + +UUID of the state for the work item + + + +Array of user UUIDs assigned to the work item + + + +Array of label UUIDs for the work item + + + +UUID of the parent work item + + + +Estimate point for the work item (value between 0-7) + + + +UUID of the work item type + + + +UUID of the module the work item belongs to + + + +Target date of the work item in YYYY-MM-DD format + + + +Start date of the work item in YYYY-MM-DD format + + + +Priority of the work item. Can be: none, urgent, high, medium, low + diff --git a/api-reference/issue/delete-issue.mdx b/api-reference/issue/delete-issue.mdx index c19154e..376861c 100644 --- a/api-reference/issue/delete-issue.mdx +++ b/api-reference/issue/delete-issue.mdx @@ -1,7 +1,7 @@ --- -title: Delete issue -description: Deletes an issue in a project -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id} +title: Delete work item +description: Deletes a work item in a project +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/ --- ### Path parameters diff --git a/api-reference/issue/get-issue-detail.mdx b/api-reference/issue/get-issue-detail.mdx index 69dcd12..b67dfcf 100644 --- a/api-reference/issue/get-issue-detail.mdx +++ b/api-reference/issue/get-issue-detail.mdx @@ -1,7 +1,7 @@ --- -title: Get issue by UUID -description: Gets the details of an issue using the UUID -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id} +title: Get work item by UUID +description: Gets the details of a work item using the UUID +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/ --- ### Path parameters @@ -11,3 +11,9 @@ api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue + +### Query parameters + + +Comma-separated list of fields to expand. Can include: type, module, labels, assignees, state, project + diff --git a/api-reference/issue/get-issue-sequence-id.mdx b/api-reference/issue/get-issue-sequence-id.mdx index 759b56c..d677c8f 100644 --- a/api-reference/issue/get-issue-sequence-id.mdx +++ b/api-reference/issue/get-issue-sequence-id.mdx @@ -1,11 +1,19 @@ --- -title: Get issue by sequence ID -description: Gets the details of an issue using the sequence id -api: GET /api/v1/workspaces/{workspace-slug}/issues/{sequence_id}/ +title: Get work item by identifier +description: Gets the details of a work item using the identifier (e.g., PROJ-123) +api: GET /api/v1/workspaces/{workspace-slug}/issues/{identifier}/ --- ### Path parameters - + +Work item identifier in the format PROJECT-123 (e.g., PROJ-123) + + +### Query parameters + + +Comma-separated list of fields to expand. Can include: type, module, labels, assignees, state, project + diff --git a/api-reference/issue/list-issues.mdx b/api-reference/issue/list-issues.mdx index 4fb6151..a76c51b 100644 --- a/api-reference/issue/list-issues.mdx +++ b/api-reference/issue/list-issues.mdx @@ -1,6 +1,6 @@ --- -title: List issues -description: Gets all the issues of a project +title: List work items +description: Gets all the work items of a project api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/ --- @@ -8,5 +8,29 @@ api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/ - - \ No newline at end of file + +### Query parameters + + +Filter by project UUID + + + +Filter by state UUID + + + +Filter by assignee user UUID + + + +Number of results to return + + + +Number of results to skip + + + +Comma-separated list of fields to expand. Can include: type, module, labels, assignees, state, project + \ No newline at end of file diff --git a/api-reference/issue/overview.mdx b/api-reference/issue/overview.mdx index df3e00a..10bbec8 100644 --- a/api-reference/issue/overview.mdx +++ b/api-reference/issue/overview.mdx @@ -1,37 +1,41 @@ --- title: Overview -description: Inside an issue, you can add as many details as you like to get your work done. --- +Inside a work item, you can add as many details as you like to get your work done. + +## APIs + ```http POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ - +GET /api/v1/workspaces/:workspace-slug/issues/:identifier/ +GET /api/v1/workspaces/:workspace-slug/issues/search/ ``` -### Issue Object +### Work Item Object **Attributes** * `name` _string_ **(required)** - Name of the issues + Name of the work item * `created_at` , `updated_at` _timestamp_ - Timestamp of the issue when it was created and when it was last updated + Timestamp of the work item when it was created and when it was last updated * `estimate_point` _integer_ or _null_ - Total estimate points for the issue takes value between (0,7). + Total estimate points for the work item takes value between (0,7). * `description_html` _string_ - HTML description of the issue + HTML description of the work item * `description_stripped` _string_ @@ -39,7 +43,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ * `priority` _string_ - Priority of the issue takes in 5 values + Priority of the work item takes in 5 values * none * urgent @@ -48,15 +52,15 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ * low * `start_date` _date_ - Start date of the issue + Start date of the work item * `target_date` _date_ - Target date of the issue + Target date of the work item * `sequence_id` _integer_ - Auto generated from the system the unique identifier of the issue + Auto generated from the system the unique identifier of the work item * `sort_order` _decimal_ @@ -64,7 +68,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ * `completed_at` _timestamp_ or _null_ - Timestamp when the issue is moved to any completed group state + Timestamp when the work item is moved to any completed group state * `created_by` & `updated_by` @@ -72,27 +76,57 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ * `project` _uuid_ - The project which the issue is part of auto generated from backend + The project which the work item is part of auto generated from backend * `workspace` _uuid_ - The workspace which the issue is part of auto generated from backend + The workspace which the work item is part of auto generated from backend * `parent` _uuid_ - The uuid of the parent issue which should be part of the same workspace + The uuid of the parent work item which should be part of the same workspace * `state` _uuid_ - The uuid of the state which is present in the project where the issue is being created. + The uuid of the state which is present in the project where the work item is being created. * `assignees` - _\[uuid,\]_ - The array of uuids of the users who are part of the project where the issue is being created or updated. + The array of uuids of the users who are part of the project where the work item is being created or updated. * `labels` - _\[uuid,\]_ - The array of uuids of the labels which are present in the project where the issue is being created or updated. + The array of uuids of the labels which are present in the project where the work item is being created or updated. + +* `type` _uuid_ + + The uuid of the work item type for the work item. + +* `module` _uuid_ + + The uuid of the module the work item belongs to. + +* `is_draft` _boolean_ + + Whether the work item is a draft. + +* `archived_at` _timestamp_ or _null_ + + Timestamp when the work item was archived. + +* `description_binary` _string_ + + Binary description of the work item. + +**Expandable Fields** + +The following fields can be expanded when retrieving a work item by including them in the `expand` query parameter: +- `type` - Expands to full WorkItemType object +- `module` - Expands to full Module object +- `labels` - Expands to array of full Label objects +- `assignees` - Expands to array of full User objects +- `state` - Expands to full State object +- `project` - Expands to full Project object ```json JSON @@ -101,7 +135,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ "created_at": "2023-11-19T11:56:55.176802Z", "updated_at": "2023-11-19T11:56:55.176809Z", "estimate_point": null, - "name": "First Issue", + "name": "First Work Item", "description_html": "

", "description_stripped": "", "priority": "none", diff --git a/api-reference/issue/search-issues.mdx b/api-reference/issue/search-issues.mdx new file mode 100644 index 0000000..29a270a --- /dev/null +++ b/api-reference/issue/search-issues.mdx @@ -0,0 +1,20 @@ +--- +title: Search work items +description: Searches for work items across a workspace +api: GET /api/v1/workspaces/{workspace-slug}/issues/search/ +--- + +### Path parameters + + + +### Query parameters + + +Search query string + + + +Filter by project UUID + + diff --git a/api-reference/issue/update-issue-detail.mdx b/api-reference/issue/update-issue-detail.mdx index 8ac211c..0c7983b 100644 --- a/api-reference/issue/update-issue-detail.mdx +++ b/api-reference/issue/update-issue-detail.mdx @@ -1,7 +1,7 @@ --- -title: Update issue details -description: Updates the details of an issue -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id} +title: Update work item details +description: Updates the details of a work item +api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/ --- ### Path parameters @@ -14,4 +14,50 @@ api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{iss ### Body - \ No newline at end of file + +Name of the work item + + + +HTML description of the work item + + + +UUID of the state for the work item + + + +Array of user UUIDs assigned to the work item + + + +Array of label UUIDs for the work item + + + +UUID of the parent work item + + + +Estimate point for the work item (value between 0-7) + + + +UUID of the work item type + + + +UUID of the module the work item belongs to + + + +Target date of the work item in YYYY-MM-DD format + + + +Start date of the work item in YYYY-MM-DD format + + + +Priority of the work item. Can be: none, urgent, high, medium, low + \ No newline at end of file diff --git a/api-reference/module-issue/overview.mdx b/api-reference/module-issue/overview.mdx deleted file mode 100644 index 281fb89..0000000 --- a/api-reference/module-issue/overview.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Overview -description: It contains all the list of issues which are inside a module. ---- - -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/:issue_id/ - -``` - -### Module Issue Object - -For creating a module issue, the payload should be sent in the below format. - -```json -{ - "issues": ["d2e49a6e-e315-4b38-aecc-71c8c709ca6a"] -} -``` - -- `sub_issues_count` - - It tells the count of sub issues of the issue - -- `created_at` _timestamp_ - - The timestamp of the time when the project was created - -- `updated_at` _timestamp_ - - The timestamp of the time when the project was last updated - -- `created_by` , `updated_by` _uuid_ - - These values are auto saved and represent the id of the user that created or updated the module - -- `Project` uuid - - It contains projects uuid which is automatically saved. - -- `Workspace` uuid - - It contains workspace uuid which is automatically saved - -- `module` uuid - - Module id of which the issue belongs to - -- `issue` uuid - - Issue id of the issue - - -```json -{ - "id": "484e72ec-846c-4764-82aa-89081e6ea2a6", - "sub_issues_count": 0, - "created_at": "2023-11-22T07:53:38.512357Z", - "updated_at": "2023-11-22T07:53:38.512388Z", - "created_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c", - "updated_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c", - "project": "6436c4ae-fba7-45dc-ad4a-5440e17cb1b2", - "workspace": "c467e125-59e3-44ec-b5ee-f9c1e138c611", - "module": "5090ed11-ccc4-4a5c-87ba-9330bd926b4f", - "issue": "c099e795-e2a8-427c-9714-1dfbdc56707a" -} -``` - diff --git a/api-reference/module-issue/add-module-issue.mdx b/api-reference/module/add-module-work-items.mdx similarity index 76% rename from api-reference/module-issue/add-module-issue.mdx rename to api-reference/module/add-module-work-items.mdx index 9a55d9e..9b22d72 100644 --- a/api-reference/module-issue/add-module-issue.mdx +++ b/api-reference/module/add-module-work-items.mdx @@ -1,6 +1,6 @@ --- -title: Add module issue -description: Adds an issue in a module +title: Add module work items +description: Adds work items (issues) to a module api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/module-issues/ --- @@ -15,5 +15,6 @@ api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{mod ### Body -It expects a list of issue ids +List of work item (issue) IDs to add to the module + diff --git a/api-reference/module/add-module.mdx b/api-reference/module/add-module.mdx index 48952ea..94f502c 100644 --- a/api-reference/module/add-module.mdx +++ b/api-reference/module/add-module.mdx @@ -12,4 +12,38 @@ api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/ ### Body - + +Name of the module + + + +Description of the module + + + +Start date of the module in YYYY-MM-DD format + + + +Target date of the module in YYYY-MM-DD format + + + +Status of the module. Can be: backlog, planned, in-progress, paused, completed, cancelled + + + +User ID of the module lead + + + +List of member user IDs assigned to the module + + + +External source identifier + + + +External ID from the external source + diff --git a/api-reference/module/archive-module.mdx b/api-reference/module/archive-module.mdx new file mode 100644 index 0000000..08936e2 --- /dev/null +++ b/api-reference/module/archive-module.mdx @@ -0,0 +1,14 @@ +--- +title: Archive module +description: Archives a module +api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/archive/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/module/delete-module.mdx b/api-reference/module/delete-module.mdx index 403e787..b46d5a4 100644 --- a/api-reference/module/delete-module.mdx +++ b/api-reference/module/delete-module.mdx @@ -1,7 +1,7 @@ --- title: Delete module description: Deletes a module -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id} +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/ --- ### Path parameters diff --git a/api-reference/module/get-module-detail.mdx b/api-reference/module/get-module-detail.mdx index f399f86..ede72ed 100644 --- a/api-reference/module/get-module-detail.mdx +++ b/api-reference/module/get-module-detail.mdx @@ -1,7 +1,7 @@ --- title: Get module details description: Gets the details of a module -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id} +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/ --- ### Path parameters diff --git a/api-reference/module/list-archived-modules.mdx b/api-reference/module/list-archived-modules.mdx new file mode 100644 index 0000000..5c1b546 --- /dev/null +++ b/api-reference/module/list-archived-modules.mdx @@ -0,0 +1,12 @@ +--- +title: List archived modules +description: Gets all the archived modules in a project +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/archived/ +--- + +### Path parameters + + + + + diff --git a/api-reference/module-issue/list-module-issues.mdx b/api-reference/module/list-module-work-items.mdx similarity index 79% rename from api-reference/module-issue/list-module-issues.mdx rename to api-reference/module/list-module-work-items.mdx index 87f7767..b8ec9ae 100644 --- a/api-reference/module-issue/list-module-issues.mdx +++ b/api-reference/module/list-module-work-items.mdx @@ -1,6 +1,6 @@ --- -title: List module issues -description: Gets all the issues in a module +title: List module work items +description: Gets all the work items (issues) in a module api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/module-issues/ --- @@ -11,3 +11,4 @@ api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{modu + diff --git a/api-reference/module/overview.mdx b/api-reference/module/overview.mdx index 91128b4..c16fd65 100644 --- a/api-reference/module/overview.mdx +++ b/api-reference/module/overview.mdx @@ -1,14 +1,23 @@ --- title: Overview -description: Modules are smaller, focused projects that help you group and organize issues within a specific time frame. They allow you to break down your work into manageable chunks and track progress towards specific goals or objectives. --- +Modules are smaller, focused projects that help you group and organize issues within a specific time frame. They allow you to break down your work into manageable chunks and track progress towards specific goals or objectives. + +## APIs + ```http POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/ PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/ +GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/archived/ +POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/archive/ +POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/unarchive/ +GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/ +POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/ +DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/:issue_id/ ``` ### Module Object @@ -80,8 +89,24 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_i Lead of the module +- `members` string[] + + List of member user IDs assigned to the module + +- `archived_at` _timestamp_ + + The timestamp when the module was archived (if archived) + +- `logo_props` + + Logo properties for the module + +- `description_text` + + Description in plain text format + -``` +```json JSON { "id": "b69b19ae-261f-428c-899f-dd58efaa36c0", "created_at": "2023-11-19T11:48:21.130161Z", diff --git a/api-reference/module-issue/delete-module-issue.mdx b/api-reference/module/remove-module-work-item.mdx similarity index 72% rename from api-reference/module-issue/delete-module-issue.mdx rename to api-reference/module/remove-module-work-item.mdx index 682fa88..6fd3d63 100644 --- a/api-reference/module-issue/delete-module-issue.mdx +++ b/api-reference/module/remove-module-work-item.mdx @@ -1,7 +1,7 @@ --- -title: Delete module issue -description: Deletes an issue in a module -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/module-issues/{issue_id} +title: Remove module work item +description: Removes a work item (issue) from a module +api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/module-issues/{issue_id}/ --- ### Path parameters @@ -13,3 +13,4 @@ api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{m + diff --git a/api-reference/module/unarchive-module.mdx b/api-reference/module/unarchive-module.mdx new file mode 100644 index 0000000..e7434e8 --- /dev/null +++ b/api-reference/module/unarchive-module.mdx @@ -0,0 +1,14 @@ +--- +title: Unarchive module +description: Unarchives a module +api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/unarchive/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/module/update-module-detail.mdx b/api-reference/module/update-module-detail.mdx index 207751d..3d784ce 100644 --- a/api-reference/module/update-module-detail.mdx +++ b/api-reference/module/update-module-detail.mdx @@ -1,7 +1,7 @@ --- title: Update module details description: Updates the details of a module -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id} +api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/ --- ### Path parameters @@ -14,4 +14,38 @@ api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{mo ### Body - \ No newline at end of file + +Name of the module + + + +Description of the module + + + +Start date of the module in YYYY-MM-DD format + + + +Target date of the module in YYYY-MM-DD format + + + +Status of the module. Can be: backlog, planned, in-progress, paused, completed, cancelled + + + +User ID of the module lead + + + +List of member user IDs assigned to the module + + + +External source identifier + + + +External ID from the external source + \ No newline at end of file diff --git a/api-reference/page/add-project-page.mdx b/api-reference/page/add-project-page.mdx new file mode 100644 index 0000000..30a754b --- /dev/null +++ b/api-reference/page/add-project-page.mdx @@ -0,0 +1,22 @@ +--- +title: Add project page +description: Creates a new page at the project level +api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/pages/ +--- + +### Path parameters + + + + + +### Body + + +Name of the page + + + +HTML description/content of the page + + diff --git a/api-reference/page/add-workspace-page.mdx b/api-reference/page/add-workspace-page.mdx new file mode 100644 index 0000000..94e91d6 --- /dev/null +++ b/api-reference/page/add-workspace-page.mdx @@ -0,0 +1,20 @@ +--- +title: Add workspace page +description: Creates a new page at the workspace level +api: POST /api/v1/workspaces/{workspace-slug}/pages/ +--- + +### Path parameters + + + +### Body + + +Name of the page + + + +HTML description/content of the page + + diff --git a/api-reference/page/get-project-page.mdx b/api-reference/page/get-project-page.mdx new file mode 100644 index 0000000..9bcfd72 --- /dev/null +++ b/api-reference/page/get-project-page.mdx @@ -0,0 +1,14 @@ +--- +title: Get project page +description: Gets the details of a project page by ID +api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/pages/{page_id}/ +--- + +### Path parameters + + + + + + + diff --git a/api-reference/page/get-workspace-page.mdx b/api-reference/page/get-workspace-page.mdx new file mode 100644 index 0000000..14ec9d7 --- /dev/null +++ b/api-reference/page/get-workspace-page.mdx @@ -0,0 +1,12 @@ +--- +title: Get workspace page +description: Gets the details of a workspace page by ID +api: GET /api/v1/workspaces/{workspace-slug}/pages/{page_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/page/overview.mdx b/api-reference/page/overview.mdx new file mode 100644 index 0000000..21885ac --- /dev/null +++ b/api-reference/page/overview.mdx @@ -0,0 +1,68 @@ +--- +title: Overview +--- + +Pages allow you to create and manage documentation pages at both workspace and project levels. Workspace pages are accessible across all projects in a workspace, while project pages are specific to a particular project. + +## APIs + +### Workspace Pages + +```http +POST /api/v1/workspaces/:workspace-slug/pages/ +GET /api/v1/workspaces/:workspace-slug/pages/:page_id/ +``` + +### Project Pages + +```http +POST /api/v1/workspaces/:workspace-slug/projects/:project_id/pages/ +GET /api/v1/workspaces/:workspace-slug/projects/:project_id/pages/:page_id/ +``` + +### Page Object + +**Attributes** + +- `id` _uuid_ + + Unique identifier for the page + +- `name` _string_ + + Name of the page + +- `description_html` _string_ + + HTML description/content of the page + +- `created_at` _timestamp_ + + The timestamp when the page was created + +- `updated_at` _timestamp_ + + The timestamp when the page was last updated + +- `created_by` _uuid_ + + ID of the user who created the page + +- `updated_by` _uuid_ + + ID of the user who last updated the page + + +```json JSON +{ + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "created_at": "2023-11-19T11:56:55.176802Z", + "updated_at": "2023-11-19T11:56:55.176809Z", + "name": "Getting Started", + "description_html": "

Welcome

This is a getting started guide.

", + "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430", + "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430" +} +``` + + diff --git a/api-reference/sticky/add-sticky.mdx b/api-reference/sticky/add-sticky.mdx new file mode 100644 index 0000000..e893a12 --- /dev/null +++ b/api-reference/sticky/add-sticky.mdx @@ -0,0 +1,32 @@ +--- +title: Add sticky +description: Creates a new sticky in a workspace +api: POST /api/v1/workspaces/{workspace-slug}/stickies/ +--- + +### Path parameters + + + +### Body + + +Name of the sticky + + + +HTML description of the sticky + + + +Logo properties for the sticky + + + +Color of the sticky + + + +Background color of the sticky + + diff --git a/api-reference/sticky/delete-sticky.mdx b/api-reference/sticky/delete-sticky.mdx new file mode 100644 index 0000000..7df37f8 --- /dev/null +++ b/api-reference/sticky/delete-sticky.mdx @@ -0,0 +1,12 @@ +--- +title: Delete sticky +description: Deletes a sticky +api: DELETE /api/v1/workspaces/{workspace-slug}/stickies/{sticky_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/sticky/get-sticky-detail.mdx b/api-reference/sticky/get-sticky-detail.mdx new file mode 100644 index 0000000..53dac8d --- /dev/null +++ b/api-reference/sticky/get-sticky-detail.mdx @@ -0,0 +1,12 @@ +--- +title: Get sticky details +description: Gets the details of a sticky +api: GET /api/v1/workspaces/{workspace-slug}/stickies/{sticky_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/sticky/list-stickies.mdx b/api-reference/sticky/list-stickies.mdx new file mode 100644 index 0000000..419439a --- /dev/null +++ b/api-reference/sticky/list-stickies.mdx @@ -0,0 +1,20 @@ +--- +title: List stickies +description: Gets all the stickies in a workspace +api: GET /api/v1/workspaces/{workspace-slug}/stickies/ +--- + +### Path parameters + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/sticky/overview.mdx b/api-reference/sticky/overview.mdx new file mode 100644 index 0000000..c45cb75 --- /dev/null +++ b/api-reference/sticky/overview.mdx @@ -0,0 +1,102 @@ +--- +title: Overview +--- + +Stickies are workspace-level notes or reminders that can be used to capture quick thoughts, ideas, or important information. + +## APIs + +```http +POST /api/v1/workspaces/:workspace-slug/stickies/ +GET /api/v1/workspaces/:workspace-slug/stickies/ +GET /api/v1/workspaces/:workspace-slug/stickies/:sticky_id/ +PATCH /api/v1/workspaces/:workspace-slug/stickies/:sticky_id/ +DELETE /api/v1/workspaces/:workspace-slug/stickies/:sticky_id/ +``` + +### Sticky Object + +**Attributes** + +- `id` _uuid_ + + Unique identifier for the sticky + +- `name` _string_ + + Name of the sticky + +- `description` _object_ + + JSON description of the sticky + +- `description_html` _string_ + + HTML description of the sticky + +- `description_stripped` _string_ + + Stripped version of the HTML description + +- `description_binary` _string_ + + Binary description of the sticky + +- `logo_props` _object_ + + Logo properties for the sticky + +- `color` _string_ + + Color of the sticky + +- `background_color` _string_ + + Background color of the sticky + +- `workspace` _uuid_ + + Workspace UUID which is automatically saved + +- `owner` _uuid_ + + User ID of the sticky owner + +- `sort_order` _number_ + + Sort order for the sticky + +- `created_at` _timestamp_ + + The timestamp when the sticky was created + +- `updated_at` _timestamp_ + + The timestamp when the sticky was last updated + +- `created_by` _uuid_ + + ID of the user who created the sticky + +- `updated_by` _uuid_ + + ID of the user who last updated the sticky + + +```json JSON +{ + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "created_at": "2023-11-19T11:56:55.176802Z", + "updated_at": "2023-11-19T11:56:55.176809Z", + "name": "Important Note", + "description": {}, + "description_html": "

This is an important note

", + "color": "#FF5733", + "background_color": "#FFF9E6", + "sort_order": 1000.0, + "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4", + "owner": "16c61a3a-512a-48ac-b0be-b6b46fe6f430" +} +``` + + diff --git a/api-reference/sticky/update-sticky-detail.mdx b/api-reference/sticky/update-sticky-detail.mdx new file mode 100644 index 0000000..be78dbd --- /dev/null +++ b/api-reference/sticky/update-sticky-detail.mdx @@ -0,0 +1,34 @@ +--- +title: Update sticky details +description: Updates the details of a sticky +api: PATCH /api/v1/workspaces/{workspace-slug}/stickies/{sticky_id}/ +--- + +### Path parameters + + + + + +### Body + + +Name of the sticky + + + +HTML description of the sticky + + + +Logo properties for the sticky + + + +Color of the sticky + + + +Background color of the sticky + + diff --git a/api-reference/teamspace/add-projects-to-teamspace.mdx b/api-reference/teamspace/add-projects-to-teamspace.mdx new file mode 100644 index 0000000..0c139d8 --- /dev/null +++ b/api-reference/teamspace/add-projects-to-teamspace.mdx @@ -0,0 +1,18 @@ +--- +title: Add projects to teamspace +description: Adds projects to a teamspace +api: POST /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/projects/ +--- + +### Path parameters + + + + + +### Body + + +Array of project IDs to add to the teamspace + + diff --git a/api-reference/teamspace/add-teamspace-members.mdx b/api-reference/teamspace/add-teamspace-members.mdx new file mode 100644 index 0000000..08bb982 --- /dev/null +++ b/api-reference/teamspace/add-teamspace-members.mdx @@ -0,0 +1,18 @@ +--- +title: Add members to teamspace +description: Adds members to a teamspace +api: POST /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/members/ +--- + +### Path parameters + + + + + +### Body + + +Array of user IDs to add to the teamspace + + diff --git a/api-reference/teamspace/add-teamspace.mdx b/api-reference/teamspace/add-teamspace.mdx new file mode 100644 index 0000000..25db7d8 --- /dev/null +++ b/api-reference/teamspace/add-teamspace.mdx @@ -0,0 +1,40 @@ +--- +title: Add teamspace +description: Creates a new teamspace in a workspace +api: POST /api/v1/workspaces/{workspace-slug}/teamspaces/ +--- + +### Path parameters + + + +### Body + + +Name of the teamspace + + + +JSON description of the teamspace + + + +HTML description of the teamspace + + + +Stripped version of the HTML description + + + +Binary description of the teamspace + + + +Logo properties for the teamspace + + + +User ID of the teamspace lead + + diff --git a/api-reference/teamspace/delete-teamspace.mdx b/api-reference/teamspace/delete-teamspace.mdx new file mode 100644 index 0000000..3392d06 --- /dev/null +++ b/api-reference/teamspace/delete-teamspace.mdx @@ -0,0 +1,12 @@ +--- +title: Delete teamspace +description: Deletes a teamspace +api: DELETE /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/teamspace/get-teamspace-detail.mdx b/api-reference/teamspace/get-teamspace-detail.mdx new file mode 100644 index 0000000..c98ce55 --- /dev/null +++ b/api-reference/teamspace/get-teamspace-detail.mdx @@ -0,0 +1,12 @@ +--- +title: Get teamspace details +description: Gets the details of a teamspace +api: GET /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/ +--- + +### Path parameters + + + + + diff --git a/api-reference/teamspace/list-teamspace-members.mdx b/api-reference/teamspace/list-teamspace-members.mdx new file mode 100644 index 0000000..128865b --- /dev/null +++ b/api-reference/teamspace/list-teamspace-members.mdx @@ -0,0 +1,22 @@ +--- +title: List teamspace members +description: Gets all the members associated with a teamspace +api: GET /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/members/ +--- + +### Path parameters + + + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/teamspace/list-teamspace-projects.mdx b/api-reference/teamspace/list-teamspace-projects.mdx new file mode 100644 index 0000000..fd0614e --- /dev/null +++ b/api-reference/teamspace/list-teamspace-projects.mdx @@ -0,0 +1,22 @@ +--- +title: List teamspace projects +description: Gets all the projects associated with a teamspace +api: GET /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/projects/ +--- + +### Path parameters + + + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/teamspace/list-teamspaces.mdx b/api-reference/teamspace/list-teamspaces.mdx new file mode 100644 index 0000000..c444530 --- /dev/null +++ b/api-reference/teamspace/list-teamspaces.mdx @@ -0,0 +1,20 @@ +--- +title: List teamspaces +description: Gets all the teamspaces in a workspace +api: GET /api/v1/workspaces/{workspace-slug}/teamspaces/ +--- + +### Path parameters + + + +### Query parameters + + +Number of results to return + + + +Number of results to skip + + diff --git a/api-reference/teamspace/overview.mdx b/api-reference/teamspace/overview.mdx new file mode 100644 index 0000000..e5956b4 --- /dev/null +++ b/api-reference/teamspace/overview.mdx @@ -0,0 +1,104 @@ +--- +title: Overview +--- + +Teamspaces allow you to organize teams, projects, and members within a workspace. They provide a way to group related work and manage access at a team level. + +## APIs + +### Teamspace Management + +```http +POST /api/v1/workspaces/:workspace-slug/teamspaces/ +GET /api/v1/workspaces/:workspace-slug/teamspaces/ +GET /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/ +PATCH /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/ +DELETE /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/ +``` + +### Teamspace Members + +```http +GET /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/members/ +POST /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/members/ +DELETE /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/members/ +``` + +### Teamspace Projects + +```http +GET /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/projects/ +POST /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/projects/ +DELETE /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/projects/ +``` + +### Teamspace Object + +**Attributes** + +- `id` _uuid_ + + Unique identifier for the teamspace + +- `name` _string_ **(required)** + + Name of the teamspace + +- `description_json` _object_ + + JSON description of the teamspace + +- `description_html` _string_ + + HTML description of the teamspace + +- `description_stripped` _string_ + + Stripped version of the HTML description + +- `description_binary` _string_ + + Binary description of the teamspace + +- `logo_props` _object_ + + Logo properties for the teamspace + +- `lead` _uuid_ + + User ID of the teamspace lead + +- `workspace` _uuid_ + + Workspace UUID which is automatically saved + +- `created_at` _timestamp_ + + The timestamp when the teamspace was created + +- `updated_at` _timestamp_ + + The timestamp when the teamspace was last updated + +- `created_by` _uuid_ + + ID of the user who created the teamspace + +- `updated_by` _uuid_ + + ID of the user who last updated the teamspace + + +```json JSON +{ + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "created_at": "2023-11-19T11:56:55.176802Z", + "updated_at": "2023-11-19T11:56:55.176809Z", + "name": "Engineering Team", + "description_html": "

Engineering team workspace

", + "lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430", + "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4" +} +``` + + diff --git a/api-reference/teamspace/remove-projects-from-teamspace.mdx b/api-reference/teamspace/remove-projects-from-teamspace.mdx new file mode 100644 index 0000000..640640f --- /dev/null +++ b/api-reference/teamspace/remove-projects-from-teamspace.mdx @@ -0,0 +1,18 @@ +--- +title: Remove projects from teamspace +description: Removes projects from a teamspace +api: DELETE /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/projects/ +--- + +### Path parameters + + + + + +### Body + + +Array of project IDs to remove from the teamspace + + diff --git a/api-reference/teamspace/remove-teamspace-members.mdx b/api-reference/teamspace/remove-teamspace-members.mdx new file mode 100644 index 0000000..be48a07 --- /dev/null +++ b/api-reference/teamspace/remove-teamspace-members.mdx @@ -0,0 +1,18 @@ +--- +title: Remove members from teamspace +description: Removes members from a teamspace +api: DELETE /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/members/ +--- + +### Path parameters + + + + + +### Body + + +Array of user IDs to remove from the teamspace + + diff --git a/api-reference/teamspace/update-teamspace-detail.mdx b/api-reference/teamspace/update-teamspace-detail.mdx new file mode 100644 index 0000000..93bc922 --- /dev/null +++ b/api-reference/teamspace/update-teamspace-detail.mdx @@ -0,0 +1,42 @@ +--- +title: Update teamspace details +description: Updates the details of a teamspace +api: PATCH /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/ +--- + +### Path parameters + + + + + +### Body + + +Name of the teamspace + + + +JSON description of the teamspace + + + +HTML description of the teamspace + + + +Stripped version of the HTML description + + + +Binary description of the teamspace + + + +Logo properties for the teamspace + + + +User ID of the teamspace lead + + diff --git a/api-reference/user/get-current-user.mdx b/api-reference/user/get-current-user.mdx new file mode 100644 index 0000000..005d24c --- /dev/null +++ b/api-reference/user/get-current-user.mdx @@ -0,0 +1,10 @@ +--- +title: Get current user +description: Gets the information of the currently authenticated user +api: GET /api/v1/users/me/ +--- + +### Response + +Returns the user object for the currently authenticated user based on the authentication token provided in the request. + diff --git a/api-reference/user/overview.mdx b/api-reference/user/overview.mdx new file mode 100644 index 0000000..5dc09cd --- /dev/null +++ b/api-reference/user/overview.mdx @@ -0,0 +1,58 @@ +--- +title: Overview +--- + +Users represent the people who use Plane. The Users API allows you to retrieve information about the current authenticated user. + +## APIs + +```http +GET /api/v1/users/me/ +``` + +### User Object + +**Attributes** + +- `id` _uuid_ + + Unique identifier for the user + +- `first_name` _string_ + + First name of the user + +- `last_name` _string_ + + Last name of the user + +- `email` _string_ + + Email address of the user + +- `avatar` _string_ + + Avatar identifier for the user + +- `avatar_url` _string_ + + URL of the user's avatar image + +- `display_name` _string_ + + Display name of the user + + +```json JSON +{ + "id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430", + "first_name": "John", + "last_name": "Doe", + "email": "john.doe@example.com", + "avatar": "avatar-123", + "avatar_url": "https://example.com/avatars/avatar-123.png", + "display_name": "John Doe" +} +``` + + diff --git a/mint.json b/mint.json index bd49cd1..9e695f9 100644 --- a/mint.json +++ b/mint.json @@ -203,7 +203,7 @@ ] }, { - "group": "Issue", + "group": "Work Item", "pages": [ "api-reference/issue/overview", "api-reference/issue/add-issue", @@ -211,77 +211,81 @@ "api-reference/issue/get-issue-detail", "api-reference/issue/get-issue-sequence-id", "api-reference/issue/update-issue-detail", - "api-reference/issue/delete-issue" + "api-reference/issue/delete-issue", + "api-reference/issue/search-issues", + { + "group": "Work Item activity", + "pages": [ + "api-reference/issue-activity/overview", + "api-reference/issue-activity/list-issue-activities", + "api-reference/issue-activity/get-issue-activity-detail" + ] + }, + { + "group": "Work Item comment", + "pages": [ + "api-reference/issue-comment/overview", + "api-reference/issue-comment/add-issue-comment", + "api-reference/issue-comment/list-issue-comments", + "api-reference/issue-comment/get-issue-comment-detail", + "api-reference/issue-comment/update-issue-comment-detail", + "api-reference/issue-comment/delete-issue-comment" + ] + }, + { + "group": "Work Item attachments", + "pages": [ + "api-reference/issue-attachments/overview", + "api-reference/issue-attachments/get-attachments", + "api-reference/issue-attachments/get-attachment-detail", + "api-reference/issue-attachments/get-upload-credentials", + "api-reference/issue-attachments/upload-file", + "api-reference/issue-attachments/complete-upload", + "api-reference/issue-attachments/update-attachment", + "api-reference/issue-attachments/delete-attachment" + ] + } ] }, { - "group": "Issue activity", - "pages": [ - "api-reference/issue-activity/overview", - "api-reference/issue-activity/list-issue-activities", - "api-reference/issue-activity/get-issue-activity-detail" - ] - }, - { - "group": "Issue comment", - "pages": [ - "api-reference/issue-comment/overview", - "api-reference/issue-comment/add-issue-comment", - "api-reference/issue-comment/list-issue-comments", - "api-reference/issue-comment/get-issue-comment-detail", - "api-reference/issue-comment/update-issue-comment-detail", - "api-reference/issue-comment/delete-issue-comment" - ] - }, - { - "group": "Issue types", + "group": "Work Item types", "pages": [ "api-reference/issue-types/types/overview", "api-reference/issue-types/types/add-issue-type", "api-reference/issue-types/types/list-issue-types", "api-reference/issue-types/types/get-issue-type-details", "api-reference/issue-types/types/update-issue-types", - "api-reference/issue-types/types/delete-issue-type" - ] - }, - { - "group": "Issue properties", - "pages": [ - "api-reference/issue-types/properties/overview", - "api-reference/issue-types/properties/add-property", - "api-reference/issue-types/properties/list-properties", - "api-reference/issue-types/properties/get-property-details", - "api-reference/issue-types/properties/update-property", - "api-reference/issue-types/properties/delete-property" - ] - }, - { - "group": "Issue property options", - "pages": [ - "api-reference/issue-types/options/overview", - "api-reference/issue-types/options/add-dropdown-options", - "api-reference/issue-types/options/list-dropdown-options", - "api-reference/issue-types/options/get-option-details", - "api-reference/issue-types/options/update-dropdown-options", - "api-reference/issue-types/options/delete-dropdown-options" - ] - }, - { - "group": "Issue property values", - "pages": [ - "api-reference/issue-types/values/overview", - "api-reference/issue-types/values/add-property-values", - "api-reference/issue-types/values/list-property-values" - ] - }, - { - "group": "Issue attachments", - "pages": [ - "api-reference/issue-attachments/overview", - "api-reference/issue-attachments/get-attachments", - "api-reference/issue-attachments/get-upload-credentials", - "api-reference/issue-attachments/upload-file", - "api-reference/issue-attachments/complete-upload" + "api-reference/issue-types/types/delete-issue-type", + { + "group": "Work Item Properties", + "pages": [ + "api-reference/issue-types/properties/overview", + "api-reference/issue-types/properties/add-property", + "api-reference/issue-types/properties/list-properties", + "api-reference/issue-types/properties/get-property-details", + "api-reference/issue-types/properties/update-property", + "api-reference/issue-types/properties/delete-property" + ] + }, + { + "group": "Work Item property options", + "pages": [ + "api-reference/issue-types/options/overview", + "api-reference/issue-types/options/add-dropdown-options", + "api-reference/issue-types/options/list-dropdown-options", + "api-reference/issue-types/options/get-option-details", + "api-reference/issue-types/options/update-dropdown-options", + "api-reference/issue-types/options/delete-dropdown-options" + ] + }, + { + "group": "Work Item property values", + "pages": [ + "api-reference/issue-types/values/overview", + "api-reference/issue-types/values/add-property-values", + "api-reference/issue-types/values/list-property-values" + ] + } ] }, { @@ -292,16 +296,13 @@ "api-reference/module/list-modules", "api-reference/module/get-module-detail", "api-reference/module/update-module-detail", - "api-reference/module/delete-module" - ] - }, - { - "group": "Module issue", - "pages": [ - "api-reference/module-issue/overview", - "api-reference/module-issue/add-module-issue", - "api-reference/module-issue/list-module-issues", - "api-reference/module-issue/delete-module-issue" + "api-reference/module/delete-module", + "api-reference/module/list-archived-modules", + "api-reference/module/archive-module", + "api-reference/module/unarchive-module", + "api-reference/module/list-module-work-items", + "api-reference/module/add-module-work-items", + "api-reference/module/remove-module-work-item" ] }, { @@ -312,16 +313,14 @@ "api-reference/cycle/list-cycles", "api-reference/cycle/get-cycle-detail", "api-reference/cycle/update-cycle-detail", - "api-reference/cycle/delete-cycle" - ] - }, - { - "group": "Cycle issue", - "pages": [ - "api-reference/cycle-issue/overview", - "api-reference/cycle-issue/add-cycle-issue", - "api-reference/cycle-issue/list-cycle-issues", - "api-reference/cycle-issue/delete-cycle-issue" + "api-reference/cycle/delete-cycle", + "api-reference/cycle/list-archived-cycles", + "api-reference/cycle/archive-cycle", + "api-reference/cycle/unarchive-cycle", + "api-reference/cycle/list-cycle-work-items", + "api-reference/cycle/add-cycle-work-items", + "api-reference/cycle/remove-cycle-work-item", + "api-reference/cycle/transfer-cycle-work-items" ] }, { @@ -353,6 +352,138 @@ "api-reference/members/get-workspace-members", "api-reference/members/get-project-members" ] + }, + { + "group": "Initiative", + "pages": [ + "api-reference/initiative/overview", + "api-reference/initiative/add-initiative", + "api-reference/initiative/list-initiatives", + "api-reference/initiative/get-initiative-detail", + "api-reference/initiative/update-initiative-detail", + "api-reference/initiative/delete-initiative", + { + "group": "Initiative Labels", + "pages": [ + "api-reference/initiative/add-initiative-label", + "api-reference/initiative/list-initiative-labels", + "api-reference/initiative/get-initiative-label-detail", + "api-reference/initiative/update-initiative-label-detail", + "api-reference/initiative/delete-initiative-label", + "api-reference/initiative/list-initiative-labels-for-initiative", + "api-reference/initiative/add-labels-to-initiative", + "api-reference/initiative/remove-labels-from-initiative" + ] + }, + { + "group": "Initiative Projects", + "pages": [ + "api-reference/initiative/list-initiative-projects", + "api-reference/initiative/add-projects-to-initiative", + "api-reference/initiative/remove-projects-from-initiative" + ] + }, + { + "group": "Initiative Epics", + "pages": [ + "api-reference/initiative/list-initiative-epics", + "api-reference/initiative/add-epics-to-initiative", + "api-reference/initiative/remove-epics-from-initiative" + ] + } + ] + }, + { + "group": "Page", + "pages": [ + "api-reference/page/overview", + "api-reference/page/add-workspace-page", + "api-reference/page/get-workspace-page", + "api-reference/page/add-project-page", + "api-reference/page/get-project-page" + ] + }, + { + "group": "Customer", + "pages": [ + "api-reference/customer/overview", + "api-reference/customer/add-customer", + "api-reference/customer/list-customers", + "api-reference/customer/get-customer-detail", + "api-reference/customer/update-customer-detail", + "api-reference/customer/delete-customer", + "api-reference/customer/list-customer-work-items", + "api-reference/customer/link-work-items-to-customer", + "api-reference/customer/unlink-work-item-from-customer", + { + "group": "Customer Properties", + "pages": [ + "api-reference/customer/list-customer-properties", + "api-reference/customer/add-customer-property", + "api-reference/customer/get-customer-property-detail", + "api-reference/customer/update-customer-property-detail", + "api-reference/customer/delete-customer-property", + "api-reference/customer/list-customer-property-values", + "api-reference/customer/get-customer-property-value", + "api-reference/customer/update-customer-property-value" + ] + }, + { + "group": "Customer Requests", + "pages": [ + "api-reference/customer/list-customer-requests", + "api-reference/customer/add-customer-request", + "api-reference/customer/get-customer-request-detail", + "api-reference/customer/update-customer-request-detail", + "api-reference/customer/delete-customer-request" + ] + } + ] + }, + { + "group": "Teamspace", + "pages": [ + "api-reference/teamspace/overview", + "api-reference/teamspace/add-teamspace", + "api-reference/teamspace/list-teamspaces", + "api-reference/teamspace/get-teamspace-detail", + "api-reference/teamspace/update-teamspace-detail", + "api-reference/teamspace/delete-teamspace", + { + "group": "Teamspace Members", + "pages": [ + "api-reference/teamspace/list-teamspace-members", + "api-reference/teamspace/add-teamspace-members", + "api-reference/teamspace/remove-teamspace-members" + ] + }, + { + "group": "Teamspace Projects", + "pages": [ + "api-reference/teamspace/list-teamspace-projects", + "api-reference/teamspace/add-projects-to-teamspace", + "api-reference/teamspace/remove-projects-from-teamspace" + ] + } + ] + }, + { + "group": "Sticky", + "pages": [ + "api-reference/sticky/overview", + "api-reference/sticky/add-sticky", + "api-reference/sticky/list-stickies", + "api-reference/sticky/get-sticky-detail", + "api-reference/sticky/update-sticky-detail", + "api-reference/sticky/delete-sticky" + ] + }, + { + "group": "User", + "pages": [ + "api-reference/user/overview", + "api-reference/user/get-current-user" + ] } ] }, From 0a6417523f20f2464706dff774a4ad19b0192c72 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Wed, 26 Nov 2025 21:09:15 +0530 Subject: [PATCH 2/3] review fixes --- .../customer/add-customer-property.mdx | 44 +-- .../customer/add-customer-request.mdx | 22 +- api-reference/customer/add-customer.mdx | 18 +- .../customer/delete-customer-property.mdx | 16 +- .../customer/delete-customer-request.mdx | 20 +- api-reference/customer/delete-customer.mdx | 16 +- .../customer/get-customer-detail.mdx | 16 +- .../customer/get-customer-property-detail.mdx | 16 +- .../customer/get-customer-property-value.mdx | 20 +- .../customer/get-customer-request-detail.mdx | 20 +- .../customer/link-work-items-to-customer.mdx | 18 +- .../customer/list-customer-properties.mdx | 20 +- .../list-customer-property-values.mdx | 28 +- .../customer/list-customer-requests.mdx | 26 +- .../customer/list-customer-work-items.mdx | 17 +- api-reference/customer/list-customers.mdx | 14 +- api-reference/customer/overview.mdx | 47 +-- .../unlink-work-item-from-customer.mdx | 18 +- .../customer/update-customer-detail.mdx | 23 +- .../update-customer-property-detail.mdx | 48 ++-- .../update-customer-property-value.mdx | 24 +- .../update-customer-request-detail.mdx | 26 +- api-reference/cycle/add-cycle-work-items.mdx | 18 +- api-reference/cycle/add-cycle.mdx | 34 +-- api-reference/cycle/archive-cycle.mdx | 17 +- api-reference/cycle/delete-cycle.mdx | 16 +- api-reference/cycle/get-cycle-detail.mdx | 16 +- api-reference/cycle/list-archived-cycles.mdx | 14 +- api-reference/cycle/list-cycle-work-items.mdx | 16 +- api-reference/cycle/list-cycles.mdx | 14 +- api-reference/cycle/overview.mdx | 25 +- .../cycle/remove-cycle-work-item.mdx | 18 +- .../cycle/transfer-cycle-work-items.mdx | 18 +- api-reference/cycle/unarchive-cycle.mdx | 16 +- api-reference/cycle/update-cycle-detail.mdx | 34 +-- api-reference/inbox-issue/add-inbox-issue.mdx | 4 +- .../inbox-issue/delete-inbox-issue.mdx | 6 +- .../inbox-issue/get-inbox-issue-detail.mdx | 6 +- .../inbox-issue/list-inbox-issues.mdx | 4 +- api-reference/inbox-issue/overview.mdx | 10 +- .../inbox-issue/update-inbox-issue-detail.mdx | 6 +- .../initiative/add-epics-to-initiative.mdx | 18 +- .../initiative/add-initiative-label.mdx | 22 +- api-reference/initiative/add-initiative.mdx | 32 ++- .../initiative/add-labels-to-initiative.mdx | 18 +- .../initiative/add-projects-to-initiative.mdx | 18 +- .../initiative/delete-initiative-label.mdx | 17 +- .../initiative/delete-initiative.mdx | 16 +- .../initiative/get-initiative-detail.mdx | 16 +- .../get-initiative-label-detail.mdx | 16 +- .../initiative/list-initiative-epics.mdx | 24 +- .../list-initiative-labels-for-initiative.mdx | 22 +- .../initiative/list-initiative-labels.mdx | 18 +- .../initiative/list-initiative-projects.mdx | 22 +- api-reference/initiative/list-initiatives.mdx | 18 +- api-reference/initiative/overview.mdx | 47 +-- .../remove-epics-from-initiative.mdx | 18 +- .../remove-labels-from-initiative.mdx | 18 +- .../remove-projects-from-initiative.mdx | 18 +- .../initiative/update-initiative-detail.mdx | 38 +-- .../update-initiative-label-detail.mdx | 26 +- .../intake-issue/add-intake-issue.mdx | 20 +- .../intake-issue/delete-intake-issue.mdx | 19 +- .../intake-issue/get-intake-issue-detail.mdx | 17 +- .../intake-issue/list-intake-issues.mdx | 15 +- api-reference/intake-issue/overview.mdx | 33 +-- .../update-intake-issue-detail.mdx | 21 +- api-reference/introduction.mdx | 24 +- .../get-issue-activity-detail.mdx | 24 +- .../issue-activity/list-issue-activities.mdx | 20 +- api-reference/issue-activity/overview.mdx | 21 +- .../issue-attachments/complete-upload.mdx | 12 +- .../issue-attachments/delete-attachment.mdx | 18 +- .../get-attachment-detail.mdx | 12 +- .../issue-attachments/get-attachments.mdx | 28 +- .../get-upload-credentials.mdx | 28 +- api-reference/issue-attachments/overview.mdx | 28 +- .../issue-attachments/update-attachment.mdx | 42 +-- .../issue-attachments/upload-file.mdx | 2 +- .../issue-comment/add-issue-comment.mdx | 32 ++- .../issue-comment/delete-issue-comment.mdx | 24 +- .../get-issue-comment-detail.mdx | 24 +- .../issue-comment/list-issue-comments.mdx | 32 ++- api-reference/issue-comment/overview.mdx | 26 +- .../update-issue-comment-detail.mdx | 36 ++- .../options/add-dropdown-options.mdx | 26 +- .../options/delete-dropdown-options.mdx | 21 +- .../options/get-option-details.mdx | 21 +- .../options/list-dropdown-options.mdx | 18 +- .../issue-types/options/overview.mdx | 25 +- .../options/update-dropdown-options.mdx | 31 +- .../issue-types/properties/add-property.mdx | 42 +-- .../properties/delete-property.mdx | 23 +- .../properties/get-property-details.mdx | 23 +- .../properties/list-properties.mdx | 20 +- .../issue-types/properties/overview.mdx | 27 +- .../properties/update-property.mdx | 48 ++-- .../issue-types/types/add-issue-type.mdx | 32 ++- .../issue-types/types/delete-issue-type.mdx | 22 +- .../types/get-issue-type-details.mdx | 20 +- .../issue-types/types/list-issue-types.mdx | 24 +- api-reference/issue-types/types/overview.mdx | 26 +- .../issue-types/types/update-issue-types.mdx | 34 ++- .../values/add-property-values.mdx | 27 +- .../values/list-property-values.mdx | 25 +- api-reference/issue-types/values/overview.mdx | 21 +- api-reference/issue/add-issue.mdx | 51 ++-- api-reference/issue/delete-issue.mdx | 20 +- api-reference/issue/get-issue-detail.mdx | 24 +- api-reference/issue/get-issue-sequence-id.mdx | 18 +- api-reference/issue/list-issues.mdx | 30 +- api-reference/issue/overview.mdx | 31 +- api-reference/issue/search-issues.mdx | 12 +- api-reference/issue/update-issue-detail.mdx | 56 ++-- api-reference/label/add-label.mdx | 22 +- api-reference/label/delete-label.mdx | 20 +- api-reference/label/get-label-detail.mdx | 20 +- api-reference/label/list-labels.mdx | 14 +- api-reference/label/overview.mdx | 15 +- api-reference/label/update-label-detail.mdx | 26 +- api-reference/link/add-link.mdx | 30 +- api-reference/link/delete-link.mdx | 22 +- api-reference/link/get-link-detail.mdx | 24 +- api-reference/link/list-links.mdx | 20 +- api-reference/link/overview.mdx | 15 +- api-reference/link/update-link-detail.mdx | 34 ++- api-reference/members/get-project-members.mdx | 15 +- .../members/get-workspace-members.mdx | 16 +- api-reference/members/overview.mdx | 11 +- .../module/add-module-work-items.mdx | 20 +- api-reference/module/add-module.mdx | 34 +-- api-reference/module/archive-module.mdx | 16 +- api-reference/module/delete-module.mdx | 16 +- api-reference/module/get-module-detail.mdx | 14 +- .../module/list-archived-modules.mdx | 14 +- .../module/list-module-work-items.mdx | 17 +- api-reference/module/list-modules.mdx | 14 +- api-reference/module/overview.mdx | 20 +- .../module/remove-module-work-item.mdx | 18 +- api-reference/module/unarchive-module.mdx | 17 +- api-reference/module/update-module-detail.mdx | 32 ++- api-reference/page/add-project-page.mdx | 22 +- api-reference/page/add-workspace-page.mdx | 18 +- api-reference/page/get-project-page.mdx | 18 +- api-reference/page/get-workspace-page.mdx | 16 +- api-reference/page/overview.mdx | 22 +- api-reference/project/add-project.mdx | 24 +- api-reference/project/delete-project.mdx | 16 +- api-reference/project/get-project-detail.mdx | 16 +- api-reference/project/list-projects.mdx | 12 +- api-reference/project/overview.mdx | 23 +- .../project/update-project-detail.mdx | 26 +- api-reference/state/add-state.mdx | 22 +- api-reference/state/delete-state.mdx | 20 +- api-reference/state/get-state-detail.mdx | 20 +- api-reference/state/list-states.mdx | 16 +- api-reference/state/overview.mdx | 19 +- api-reference/state/update-state-detail.mdx | 24 +- api-reference/sticky/add-sticky.mdx | 24 +- api-reference/sticky/delete-sticky.mdx | 16 +- api-reference/sticky/get-sticky-detail.mdx | 16 +- api-reference/sticky/list-stickies.mdx | 18 +- api-reference/sticky/overview.mdx | 16 +- api-reference/sticky/update-sticky-detail.mdx | 28 +- .../teamspace/add-projects-to-teamspace.mdx | 4 +- .../teamspace/add-teamspace-members.mdx | 16 +- api-reference/teamspace/add-teamspace.mdx | 28 +- api-reference/teamspace/delete-teamspace.mdx | 14 +- .../teamspace/get-teamspace-detail.mdx | 16 +- .../teamspace/list-teamspace-members.mdx | 22 +- .../teamspace/list-teamspace-projects.mdx | 10 +- api-reference/teamspace/list-teamspaces.mdx | 18 +- api-reference/teamspace/overview.mdx | 62 ++-- .../remove-projects-from-teamspace.mdx | 18 +- .../teamspace/remove-teamspace-members.mdx | 16 +- .../teamspace/update-teamspace-detail.mdx | 30 +- api-reference/user/get-current-user.mdx | 8 +- api-reference/user/overview.mdx | 10 +- api-reference/worklogs/create-worklog.mdx | 26 +- api-reference/worklogs/delete-worklog.mdx | 13 +- api-reference/worklogs/get-total-time.mdx | 14 +- .../worklogs/get-worklogs-for-issue.mdx | 18 +- api-reference/worklogs/overview.mdx | 14 +- api-reference/worklogs/update-worklog.mdx | 17 +- mint.json | 269 ++++++++++-------- 185 files changed, 2353 insertions(+), 1885 deletions(-) diff --git a/api-reference/customer/add-customer-property.mdx b/api-reference/customer/add-customer-property.mdx index 9d32aef..93432bf 100644 --- a/api-reference/customer/add-customer-property.mdx +++ b/api-reference/customer/add-customer-property.mdx @@ -1,72 +1,74 @@ --- -title: Add customer property -description: Creates a new customer property definition -api: POST /api/v1/workspaces/{workspace-slug}/customer-properties/ +title: Create a customer property +description: Creates a new customer property definition in a workspace. +api: POST /api/v1/workspaces/{workspace_slug}/customer-properties/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body +## Body parameters -Name of the property +Name of the property. -Display name of the property +Display name of the property. -Description of the property +Description of the property. -Type of the property +Type of the property. -Relation type of the property +Relation type of the property. -Whether the property is required +Whether the property is required. -Whether the property supports multiple values +Whether the property supports multiple values. -Whether the property is active +Whether the property is active. -Sort order for the property +Sort order for the property. -Default values for the property +Default values for the property. -Settings for the property +Settings for the property. -Validation rules for the property +Validation rules for the property. -Logo properties for the property +Logo properties for the property. -External source identifier +External source identifier. -External ID from the external source +External ID from the external source. diff --git a/api-reference/customer/add-customer-request.mdx b/api-reference/customer/add-customer-request.mdx index 92b88bc..563d954 100644 --- a/api-reference/customer/add-customer-request.mdx +++ b/api-reference/customer/add-customer-request.mdx @@ -1,22 +1,26 @@ --- -title: Add customer request -description: Creates a new request for a customer -api: POST /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/ +title: Create a customer request +description: Creates a new request for a customer. +api: POST /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + -### Body +## Body parameters -Title of the request +Title of the request. -Description of the request +Description of the request. diff --git a/api-reference/customer/add-customer.mdx b/api-reference/customer/add-customer.mdx index 155bd3d..0d9fe54 100644 --- a/api-reference/customer/add-customer.mdx +++ b/api-reference/customer/add-customer.mdx @@ -1,20 +1,22 @@ --- -title: Add customer -description: Creates a new customer in a workspace -api: POST /api/v1/workspaces/{workspace-slug}/customers/ +title: Create a customer +description: Creates a new customer in a workspace. +api: POST /api/v1/workspaces/{workspace_slug}/customers/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body +## Body parameters -Name of the customer +Name of the customer. -Email address of the customer +Email address of the customer. diff --git a/api-reference/customer/delete-customer-property.mdx b/api-reference/customer/delete-customer-property.mdx index 63c3468..95ca878 100644 --- a/api-reference/customer/delete-customer-property.mdx +++ b/api-reference/customer/delete-customer-property.mdx @@ -1,12 +1,16 @@ --- -title: Delete customer property -description: Deletes a customer property definition -api: DELETE /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/ +title: Delete a customer property +description: Permanently deletes a customer property definition from a workspace. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer property. + diff --git a/api-reference/customer/delete-customer-request.mdx b/api-reference/customer/delete-customer-request.mdx index 90deadd..5ba8df3 100644 --- a/api-reference/customer/delete-customer-request.mdx +++ b/api-reference/customer/delete-customer-request.mdx @@ -1,14 +1,20 @@ --- -title: Delete customer request -description: Deletes a customer request -api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/{request_id}/ +title: Delete a customer request +description: Permanently deletes a customer request. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + - + +The unique identifier for the request. + diff --git a/api-reference/customer/delete-customer.mdx b/api-reference/customer/delete-customer.mdx index cb8df4b..806be82 100644 --- a/api-reference/customer/delete-customer.mdx +++ b/api-reference/customer/delete-customer.mdx @@ -1,12 +1,16 @@ --- -title: Delete customer -description: Deletes a customer -api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/ +title: Delete a customer +description: Permanently deletes a customer from a workspace. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + diff --git a/api-reference/customer/get-customer-detail.mdx b/api-reference/customer/get-customer-detail.mdx index 9c6cbcc..103ef67 100644 --- a/api-reference/customer/get-customer-detail.mdx +++ b/api-reference/customer/get-customer-detail.mdx @@ -1,12 +1,16 @@ --- -title: Get customer details -description: Gets the details of a customer -api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/ +title: Retrieve a customer +description: Retrieves the details of an existing customer by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + diff --git a/api-reference/customer/get-customer-property-detail.mdx b/api-reference/customer/get-customer-property-detail.mdx index e33cff9..7fe8347 100644 --- a/api-reference/customer/get-customer-property-detail.mdx +++ b/api-reference/customer/get-customer-property-detail.mdx @@ -1,12 +1,16 @@ --- -title: Get customer property details -description: Gets the details of a customer property definition -api: GET /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/ +title: Retrieve a customer property +description: Retrieves the details of an existing customer property definition by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer property. + diff --git a/api-reference/customer/get-customer-property-value.mdx b/api-reference/customer/get-customer-property-value.mdx index b24c6ca..e86ba09 100644 --- a/api-reference/customer/get-customer-property-value.mdx +++ b/api-reference/customer/get-customer-property-value.mdx @@ -1,14 +1,20 @@ --- -title: Get customer property value -description: Gets a specific property value for a customer -api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/property-values/{property_id}/ +title: Retrieve a customer property value +description: Retrieves a specific property value for a customer by property ID. +api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/property-values/{property_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + - + +The unique identifier for the customer property. + diff --git a/api-reference/customer/get-customer-request-detail.mdx b/api-reference/customer/get-customer-request-detail.mdx index 28dad78..654168b 100644 --- a/api-reference/customer/get-customer-request-detail.mdx +++ b/api-reference/customer/get-customer-request-detail.mdx @@ -1,14 +1,20 @@ --- -title: Get customer request details -description: Gets the details of a customer request -api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/{request_id}/ +title: Retrieve a customer request +description: Retrieves the details of an existing customer request by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + - + +The unique identifier for the request. + diff --git a/api-reference/customer/link-work-items-to-customer.mdx b/api-reference/customer/link-work-items-to-customer.mdx index 770b509..cde87d0 100644 --- a/api-reference/customer/link-work-items-to-customer.mdx +++ b/api-reference/customer/link-work-items-to-customer.mdx @@ -1,18 +1,22 @@ --- title: Link work items to customer -description: Links work items (issues) to a customer -api: POST /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/issues/ +description: Links one or more work items to a customer. +api: POST /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/work-items/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + -### Body +## Body parameters -Array of work item (issue) IDs to link to the customer +Array of work item IDs to link to the customer. diff --git a/api-reference/customer/list-customer-properties.mdx b/api-reference/customer/list-customer-properties.mdx index a9bad51..c0ec1a2 100644 --- a/api-reference/customer/list-customer-properties.mdx +++ b/api-reference/customer/list-customer-properties.mdx @@ -1,24 +1,26 @@ --- -title: List customer properties -description: Gets all the customer property definitions in a workspace -api: GET /api/v1/workspaces/{workspace-slug}/customer-properties/ +title: List all customer properties +description: Returns a list of all customer property definitions in a workspace. +api: GET /api/v1/workspaces/{workspace_slug}/customer-properties/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Query parameters +## Query parameters -Filter by workspace UUID +Filter by workspace ID. -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/customer/list-customer-property-values.mdx b/api-reference/customer/list-customer-property-values.mdx index 5fd2fd4..7efc06e 100644 --- a/api-reference/customer/list-customer-property-values.mdx +++ b/api-reference/customer/list-customer-property-values.mdx @@ -1,34 +1,38 @@ --- -title: List customer property values -description: Gets all the property values for a customer -api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/property-values/ +title: List all customer property values +description: Returns a list of all property values for a customer. +api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/property-values/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + -### Query parameters +## Query parameters -Filter by customer UUID +Filter by customer ID. -Filter by property UUID +Filter by property ID. -Filter by workspace UUID +Filter by workspace ID. -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/customer/list-customer-requests.mdx b/api-reference/customer/list-customer-requests.mdx index 80b0632..47a8652 100644 --- a/api-reference/customer/list-customer-requests.mdx +++ b/api-reference/customer/list-customer-requests.mdx @@ -1,30 +1,34 @@ --- -title: List customer requests -description: Gets all the requests for a customer -api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/ +title: List all customer requests +description: Returns a list of all requests for a customer. +api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + -### Query parameters +## Query parameters -Filter by customer UUID +Filter by customer ID. -Filter by workspace UUID +Filter by workspace ID. -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/customer/list-customer-work-items.mdx b/api-reference/customer/list-customer-work-items.mdx index b651dc4..441db85 100644 --- a/api-reference/customer/list-customer-work-items.mdx +++ b/api-reference/customer/list-customer-work-items.mdx @@ -1,12 +1,17 @@ --- -title: List customer work items -description: Gets all the work items (issues) associated with a customer -api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/issues/ +title: List all customer work items +description: Returns a list of all work items associated with a customer. +api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/work-items/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier for the customer. + - diff --git a/api-reference/customer/list-customers.mdx b/api-reference/customer/list-customers.mdx index d0e752f..34ba77b 100644 --- a/api-reference/customer/list-customers.mdx +++ b/api-reference/customer/list-customers.mdx @@ -1,24 +1,26 @@ --- -title: List customers +title: List all customers description: Gets all the customers in a workspace -api: GET /api/v1/workspaces/{workspace-slug}/customers/ +api: GET /api/v1/workspaces/{workspace_slug}/customers/ --- ### Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + ### Query parameters -Filter by workspace UUID +Filter by workspace ID. -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/customer/overview.mdx b/api-reference/customer/overview.mdx index 7201e5a..fb358cf 100644 --- a/api-reference/customer/overview.mdx +++ b/api-reference/customer/overview.mdx @@ -4,50 +4,9 @@ title: Overview Customers allow you to manage customer relationships and track customer-related work items, requests, and custom properties within a workspace. -## APIs +[Learn more about Customers →](https://docs.plane.so/customers) -### Customer Management - -```http -POST /api/v1/workspaces/:workspace-slug/customers/ -GET /api/v1/workspaces/:workspace-slug/customers/ -GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/ -PATCH /api/v1/workspaces/:workspace-slug/customers/:customer_id/ -DELETE /api/v1/workspaces/:workspace-slug/customers/:customer_id/ -``` - -### Customer Work Items - -```http -GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/issues/ -POST /api/v1/workspaces/:workspace-slug/customers/:customer_id/issues/ -DELETE /api/v1/workspaces/:workspace-slug/customers/:customer_id/issues/:issue_id/ -``` - -### Customer Properties - -```http -GET /api/v1/workspaces/:workspace-slug/customer-properties/ -POST /api/v1/workspaces/:workspace-slug/customer-properties/ -GET /api/v1/workspaces/:workspace-slug/customer-properties/:property_id/ -PATCH /api/v1/workspaces/:workspace-slug/customer-properties/:property_id/ -DELETE /api/v1/workspaces/:workspace-slug/customer-properties/:property_id/ -GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/property-values/ -GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/property-values/:property_id/ -PATCH /api/v1/workspaces/:workspace-slug/customers/:customer_id/property-values/:property_id/ -``` - -### Customer Requests - -```http -GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/ -POST /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/ -GET /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/:request_id/ -PATCH /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/:request_id/ -DELETE /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/:request_id/ -``` - -### Customer Object +## The Customer object **Attributes** @@ -84,7 +43,7 @@ DELETE /api/v1/workspaces/:workspace-slug/customers/:customer_id/requests/:reque ID of the user who last updated the customer -```json JSON +```json CUSTOMER OBJECT { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "created_at": "2023-11-19T11:56:55.176802Z", diff --git a/api-reference/customer/unlink-work-item-from-customer.mdx b/api-reference/customer/unlink-work-item-from-customer.mdx index 9dfe921..a66579b 100644 --- a/api-reference/customer/unlink-work-item-from-customer.mdx +++ b/api-reference/customer/unlink-work-item-from-customer.mdx @@ -1,14 +1,20 @@ --- title: Unlink work item from customer -description: Unlinks a work item (issue) from a customer -api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/issues/{issue_id}/ +description: Removes the association between a work item and a customer. +api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/work-items/{work_item_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + - + +The unique identifier for the work item. + diff --git a/api-reference/customer/update-customer-detail.mdx b/api-reference/customer/update-customer-detail.mdx index 788efbc..2b69996 100644 --- a/api-reference/customer/update-customer-detail.mdx +++ b/api-reference/customer/update-customer-detail.mdx @@ -1,22 +1,27 @@ --- -title: Update customer details -description: Updates the details of a customer -api: PATCH /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/ +title: Update a customer +description: Updates an existing customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier for the customer. + - -### Body +## Body parameters -Name of the customer +Name of the customer. -Email address of the customer +Email address of the customer. diff --git a/api-reference/customer/update-customer-property-detail.mdx b/api-reference/customer/update-customer-property-detail.mdx index 6cca0b4..c9a7f8f 100644 --- a/api-reference/customer/update-customer-property-detail.mdx +++ b/api-reference/customer/update-customer-property-detail.mdx @@ -1,74 +1,78 @@ --- -title: Update customer property details -description: Updates the details of a customer property definition -api: PATCH /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/ +title: Update a customer property +description: Updates an existing customer property definition by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer property. + -### Body +## Body parameters -Name of the property +Name of the property. -Display name of the property +Display name of the property. -Description of the property +Description of the property. -Type of the property +Type of the property. -Relation type of the property +Relation type of the property. -Whether the property is required +Whether the property is required. -Whether the property supports multiple values +Whether the property supports multiple values. -Whether the property is active +Whether the property is active. -Sort order for the property +Sort order for the property. -Default values for the property +Default values for the property. -Settings for the property +Settings for the property. -Validation rules for the property +Validation rules for the property. -Logo properties for the property +Logo properties for the property. -External source identifier +External source identifier. -External ID from the external source +External ID from the external source. diff --git a/api-reference/customer/update-customer-property-value.mdx b/api-reference/customer/update-customer-property-value.mdx index c1c5be4..cd28c1d 100644 --- a/api-reference/customer/update-customer-property-value.mdx +++ b/api-reference/customer/update-customer-property-value.mdx @@ -1,20 +1,26 @@ --- -title: Update customer property value -description: Updates a property value for a customer -api: PATCH /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/property-values/{property_id}/ +title: Update a customer property value +description: Updates a property value for a customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/property-values/{property_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + - + +The unique identifier for the customer property. + -### Body +## Body parameters -Array of values for the property +Array of values to set for the property. diff --git a/api-reference/customer/update-customer-request-detail.mdx b/api-reference/customer/update-customer-request-detail.mdx index 77bbef4..9b03747 100644 --- a/api-reference/customer/update-customer-request-detail.mdx +++ b/api-reference/customer/update-customer-request-detail.mdx @@ -1,24 +1,30 @@ --- -title: Update customer request details -description: Updates the details of a customer request -api: PATCH /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/{request_id}/ +title: Update a customer request +description: Updates an existing customer request by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the customer. + - + +The unique identifier for the request. + -### Body +## Body parameters -Title of the request +Title of the request. -Description of the request +Description of the request. diff --git a/api-reference/cycle/add-cycle-work-items.mdx b/api-reference/cycle/add-cycle-work-items.mdx index add6a4b..1859235 100644 --- a/api-reference/cycle/add-cycle-work-items.mdx +++ b/api-reference/cycle/add-cycle-work-items.mdx @@ -1,20 +1,22 @@ --- -title: Add cycle work items +title: Add work items to cycle description: Adds work items (issues) to a cycle -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the cycle. -### Body +## Body parameters -List of work item (issue) IDs to add to the cycle +Array of work item IDs to add to the cycle. diff --git a/api-reference/cycle/add-cycle.mdx b/api-reference/cycle/add-cycle.mdx index 520c70d..2401370 100644 --- a/api-reference/cycle/add-cycle.mdx +++ b/api-reference/cycle/add-cycle.mdx @@ -1,49 +1,51 @@ --- -title: Add cycle -description: Adds a cycle in a project -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/ +title: Create a cycle +description: Creates a new cycle in a project. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. -### Body +## Body parameters -Name of the cycle +Name of the cycle. -Description of the cycle +Description of the cycle. -Start date of the cycle in YYYY-MM-DD format +Start date of the cycle in YYYY-MM-DD format. -End date of the cycle in YYYY-MM-DD format +End date of the cycle in YYYY-MM-DD format. -User ID of the cycle owner +ID of the user who owns the cycle. -External source identifier +External source identifier. -External ID from the external source +External ID from the external source. -Timezone for the cycle +Timezone for the cycle. -Project ID for the cycle +ID of the project for the cycle. diff --git a/api-reference/cycle/archive-cycle.mdx b/api-reference/cycle/archive-cycle.mdx index 9003827..92d2dc7 100644 --- a/api-reference/cycle/archive-cycle.mdx +++ b/api-reference/cycle/archive-cycle.mdx @@ -1,14 +1,17 @@ --- -title: Archive cycle -description: Archives a cycle -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/archived-cycles/{cycle_id}/archive/ +title: Archive a cycle +description: Archives a cycle, while preserving its data. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/archived-cycles/{cycle_id}/archive/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. + +The unique identifier for the cycle. - diff --git a/api-reference/cycle/delete-cycle.mdx b/api-reference/cycle/delete-cycle.mdx index f287b52..73e7350 100644 --- a/api-reference/cycle/delete-cycle.mdx +++ b/api-reference/cycle/delete-cycle.mdx @@ -1,13 +1,15 @@ --- -title: Delete cycle -description: Deletes a cycle -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/ +title: Delete a cycle +description: Permanently deletes a cycle from a project. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the cycle. diff --git a/api-reference/cycle/get-cycle-detail.mdx b/api-reference/cycle/get-cycle-detail.mdx index c329674..21bc5d2 100644 --- a/api-reference/cycle/get-cycle-detail.mdx +++ b/api-reference/cycle/get-cycle-detail.mdx @@ -1,13 +1,15 @@ --- -title: Get cycle details -description: Gets the details of a cycle -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/ +title: Retrieve a cycle +description: Retrieves the details of an existing cycle by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the cycle. diff --git a/api-reference/cycle/list-archived-cycles.mdx b/api-reference/cycle/list-archived-cycles.mdx index 2b8e476..c37e73a 100644 --- a/api-reference/cycle/list-archived-cycles.mdx +++ b/api-reference/cycle/list-archived-cycles.mdx @@ -1,12 +1,14 @@ --- -title: List archived cycles -description: Gets all the archived cycles in a project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/archived-cycles/ +title: List all archived cycles +description: Returns a list of all archived cycles in a project. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/archived-cycles/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. diff --git a/api-reference/cycle/list-cycle-work-items.mdx b/api-reference/cycle/list-cycle-work-items.mdx index cdcb804..26941b8 100644 --- a/api-reference/cycle/list-cycle-work-items.mdx +++ b/api-reference/cycle/list-cycle-work-items.mdx @@ -1,14 +1,16 @@ --- -title: List cycle work items -description: Gets all the work items (issues) in a cycle -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ +title: List all work items in a cycle +description: Returns a list of all work items in a cycle. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the cycle. diff --git a/api-reference/cycle/list-cycles.mdx b/api-reference/cycle/list-cycles.mdx index dcaa6a4..4af59da 100644 --- a/api-reference/cycle/list-cycles.mdx +++ b/api-reference/cycle/list-cycles.mdx @@ -1,11 +1,13 @@ --- -title: List cycles -description: Gets all the cycles in a project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/ +title: List all cycles +description: Returns a list of all cycles in a project. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. diff --git a/api-reference/cycle/overview.mdx b/api-reference/cycle/overview.mdx index 1ee7169..6710a84 100644 --- a/api-reference/cycle/overview.mdx +++ b/api-reference/cycle/overview.mdx @@ -2,26 +2,11 @@ title: Overview --- -Cycles is a custom time period in which a team works to complete items on their backlog. At the end of the sprint, the team will usually have finished building and implementing a new version of their project or product. - -## APIs - -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/archived-cycles/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/archived-cycles/:cycle_id/archive/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/archived-cycles/:cycle_id/unarchive/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/:issue_id/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/transfer-issues/ -``` +Cycles are custom time periods in which a team works to complete items from their backlog. At the end of a cycle, the team typically has a new version of their project or product ready. + +[Learn more about Cycles →](https://docs.plane.so/core-concepts/cycles) -### Cycle Object +## The Cycles object **Attributes** @@ -86,7 +71,7 @@ POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/ Version number of the cycle -```json JSON +```json CYCLES OBJECT { "id": "50ebc791-65e4-4b4d-a164-3b4e529e55a5", "created_at": "2023-11-19T12:18:14.900078Z", diff --git a/api-reference/cycle/remove-cycle-work-item.mdx b/api-reference/cycle/remove-cycle-work-item.mdx index 0547d76..542e139 100644 --- a/api-reference/cycle/remove-cycle-work-item.mdx +++ b/api-reference/cycle/remove-cycle-work-item.mdx @@ -1,16 +1,18 @@ --- -title: Remove cycle work item -description: Removes a work item (issue) from a cycle -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ +title: Remove work item from cycle +description: Removes a work item from a cycle. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the cycle. - +The unique identifier for the work item. diff --git a/api-reference/cycle/transfer-cycle-work-items.mdx b/api-reference/cycle/transfer-cycle-work-items.mdx index c3a6eaa..8d9294e 100644 --- a/api-reference/cycle/transfer-cycle-work-items.mdx +++ b/api-reference/cycle/transfer-cycle-work-items.mdx @@ -1,20 +1,22 @@ --- title: Transfer cycle work items -description: Transfers work items (issues) from one cycle to another -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ +description: Transfers all work items from one cycle to another. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the cycle. -### Body +## Body parameters -ID of the target cycle to transfer work items to +ID of the target cycle to transfer work items to. diff --git a/api-reference/cycle/unarchive-cycle.mdx b/api-reference/cycle/unarchive-cycle.mdx index d895b1b..b27857c 100644 --- a/api-reference/cycle/unarchive-cycle.mdx +++ b/api-reference/cycle/unarchive-cycle.mdx @@ -1,14 +1,16 @@ --- -title: Unarchive cycle -description: Unarchives a cycle -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/archived-cycles/{cycle_id}/unarchive/ +title: Restore a cycle +description: Restores an archived cycle back to the active cycles list. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/archived-cycles/{cycle_id}/unarchive/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the cycle. diff --git a/api-reference/cycle/update-cycle-detail.mdx b/api-reference/cycle/update-cycle-detail.mdx index eaf7561..279b825 100644 --- a/api-reference/cycle/update-cycle-detail.mdx +++ b/api-reference/cycle/update-cycle-detail.mdx @@ -1,47 +1,49 @@ --- -title: Update cycle details -description: Updates the details of a cycle -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/ +title: Update a cycle +description: Updates an existing cycle by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the cycle. -### Body +## Body parameters -Name of the cycle +Name of the cycle. -Description of the cycle +Description of the cycle. -Start date of the cycle in YYYY-MM-DD format +Start date of the cycle in YYYY-MM-DD format. -End date of the cycle in YYYY-MM-DD format +End date of the cycle in YYYY-MM-DD format. -User ID of the cycle owner +ID of the user who owns the cycle. -External source identifier +External source identifier. -External ID from the external source +External ID from the external source. -Timezone for the cycle +Timezone for the cycle. \ No newline at end of file diff --git a/api-reference/inbox-issue/add-inbox-issue.mdx b/api-reference/inbox-issue/add-inbox-issue.mdx index 2164402..a16805e 100644 --- a/api-reference/inbox-issue/add-inbox-issue.mdx +++ b/api-reference/inbox-issue/add-inbox-issue.mdx @@ -1,12 +1,12 @@ --- title: Add intake issue description: Adds an intake issue in a project -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/ +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/ --- ### Path parameters - + diff --git a/api-reference/inbox-issue/delete-inbox-issue.mdx b/api-reference/inbox-issue/delete-inbox-issue.mdx index 7000185..fe62cb8 100644 --- a/api-reference/inbox-issue/delete-inbox-issue.mdx +++ b/api-reference/inbox-issue/delete-inbox-issue.mdx @@ -1,15 +1,15 @@ --- title: Delete intake issue description: Deletes an intake issue -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/{issue_id} +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/{issue_id} --- ### Path parameters - + - + diff --git a/api-reference/inbox-issue/get-inbox-issue-detail.mdx b/api-reference/inbox-issue/get-inbox-issue-detail.mdx index 0250d65..6257039 100644 --- a/api-reference/inbox-issue/get-inbox-issue-detail.mdx +++ b/api-reference/inbox-issue/get-inbox-issue-detail.mdx @@ -1,13 +1,13 @@ --- title: Get intake issue detail description: Gets the details of an intake issue -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/{issue_id} +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/{issue_id} --- ### Path parameters - + - + diff --git a/api-reference/inbox-issue/list-inbox-issues.mdx b/api-reference/inbox-issue/list-inbox-issues.mdx index e0aa6bb..80101d1 100644 --- a/api-reference/inbox-issue/list-inbox-issues.mdx +++ b/api-reference/inbox-issue/list-inbox-issues.mdx @@ -1,11 +1,11 @@ --- title: List intake issues description: Gets all the intake issue of a project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/ +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/ --- ### Path parameters - + diff --git a/api-reference/inbox-issue/overview.mdx b/api-reference/inbox-issue/overview.mdx index 5afc1f8..247213a 100644 --- a/api-reference/inbox-issue/overview.mdx +++ b/api-reference/inbox-issue/overview.mdx @@ -17,11 +17,11 @@ To ensure uninterrupted service, replace all `/inbox-issues/` references with `/ To enable the Intake feature, the user can hit a PATCH request on the project api with the body as ```http -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/:issue_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/:issue_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/:issue_id/ +GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/ +POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/ +GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/{work_item_id}/ +PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/{work_item_id}/ +DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/{work_item_id}/ ``` ``` diff --git a/api-reference/inbox-issue/update-inbox-issue-detail.mdx b/api-reference/inbox-issue/update-inbox-issue-detail.mdx index 6843abd..9358a27 100644 --- a/api-reference/inbox-issue/update-inbox-issue-detail.mdx +++ b/api-reference/inbox-issue/update-inbox-issue-detail.mdx @@ -1,16 +1,16 @@ --- title: Update intake issue detail description: Updates the details of an intake issue -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/{issue_id} +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/inbox-issues/{issue_id} --- ### Path parameters - + - + ### Body diff --git a/api-reference/initiative/add-epics-to-initiative.mdx b/api-reference/initiative/add-epics-to-initiative.mdx index 4663dbe..c15346b 100644 --- a/api-reference/initiative/add-epics-to-initiative.mdx +++ b/api-reference/initiative/add-epics-to-initiative.mdx @@ -1,18 +1,22 @@ --- title: Add epics to initiative -description: Adds epics to an initiative -api: POST /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/epics/ +description: Adds one or more epics to an initiative. +api: POST /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/epics/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Body +## Body parameters -Array of epic IDs to add to the initiative +Array of epic IDs to add to the initiative. diff --git a/api-reference/initiative/add-initiative-label.mdx b/api-reference/initiative/add-initiative-label.mdx index 6455b9f..b775aab 100644 --- a/api-reference/initiative/add-initiative-label.mdx +++ b/api-reference/initiative/add-initiative-label.mdx @@ -1,28 +1,30 @@ --- -title: Add initiative label -description: Creates a new initiative label in a workspace -api: POST /api/v1/workspaces/{workspace-slug}/initiatives/labels/ +title: Create an initiative label +description: Creates a new label for categorizing initiatives in a workspace. +api: POST /api/v1/workspaces/{workspace_slug}/initiatives/labels/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body +## Body parameters -Name of the initiative label +Name of the initiative label. -Description of the initiative label +Description of the initiative label. -Color code for the initiative label +Hex color code for the initiative label (e.g., "#eb5757"). -Sort order for the initiative label +Sort order for display purposes. diff --git a/api-reference/initiative/add-initiative.mdx b/api-reference/initiative/add-initiative.mdx index 3240df6..5605014 100644 --- a/api-reference/initiative/add-initiative.mdx +++ b/api-reference/initiative/add-initiative.mdx @@ -1,45 +1,47 @@ --- -title: Add initiative -description: Creates a new initiative in a workspace -api: POST /api/v1/workspaces/{workspace-slug}/initiatives/ +title: Create an initiative +description: Creates a new initiative in a workspace. +api: POST /api/v1/workspaces/{workspace_slug}/initiatives/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body +## Body parameters -Name of the initiative +Name of the initiative. -Plain text description of the initiative +Plain text description of the initiative. -HTML description of the initiative +HTML-formatted description of the initiative. -Stripped version of the HTML description +Stripped version of the HTML description. -Binary description of the initiative +Binary representation of the description. -User ID of the initiative lead +ID of the user who leads the initiative. -Start date of the initiative in YYYY-MM-DD format +Start date in YYYY-MM-DD format. -End date of the initiative in YYYY-MM-DD format +End date in YYYY-MM-DD format. @@ -47,6 +49,6 @@ Logo properties for the initiative -State of the initiative. Can be: DRAFT, PLANNED, ACTIVE, COMPLETED, CLOSED +Current state of the initiative. Possible values: `DRAFT`, `PLANNED`, `ACTIVE`, `COMPLETED`, `CLOSED`. diff --git a/api-reference/initiative/add-labels-to-initiative.mdx b/api-reference/initiative/add-labels-to-initiative.mdx index 1282b48..679dde4 100644 --- a/api-reference/initiative/add-labels-to-initiative.mdx +++ b/api-reference/initiative/add-labels-to-initiative.mdx @@ -1,18 +1,22 @@ --- title: Add labels to initiative -description: Adds labels to an initiative -api: POST /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/labels/ +description: Adds one or more labels to an initiative. +api: POST /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/labels/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Body +## Body parameters -Array of initiative label IDs to add to the initiative +Array of initiative label IDs to add to the initiative. diff --git a/api-reference/initiative/add-projects-to-initiative.mdx b/api-reference/initiative/add-projects-to-initiative.mdx index 0512933..baefa86 100644 --- a/api-reference/initiative/add-projects-to-initiative.mdx +++ b/api-reference/initiative/add-projects-to-initiative.mdx @@ -1,18 +1,22 @@ --- title: Add projects to initiative -description: Adds projects to an initiative -api: POST /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/projects/ +description: Adds one or more projects to an initiative. +api: POST /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/projects/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Body +## Body parameters -Array of project IDs to add to the initiative +Array of project IDs to add to the initiative. diff --git a/api-reference/initiative/delete-initiative-label.mdx b/api-reference/initiative/delete-initiative-label.mdx index d7ef6bd..01ebfb1 100644 --- a/api-reference/initiative/delete-initiative-label.mdx +++ b/api-reference/initiative/delete-initiative-label.mdx @@ -1,12 +1,17 @@ --- -title: Delete initiative label -description: Deletes an initiative label -api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/labels/{label_id}/ +title: Delete an initiative label +description: Permanently deletes an initiative label from a workspace. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/initiatives/labels/{label_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier for the initiative label. + - diff --git a/api-reference/initiative/delete-initiative.mdx b/api-reference/initiative/delete-initiative.mdx index d7d47a1..6df0736 100644 --- a/api-reference/initiative/delete-initiative.mdx +++ b/api-reference/initiative/delete-initiative.mdx @@ -1,12 +1,16 @@ --- -title: Delete initiative -description: Deletes an initiative -api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/ +title: Delete an initiative +description: Permanently deletes an initiative from a workspace. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + diff --git a/api-reference/initiative/get-initiative-detail.mdx b/api-reference/initiative/get-initiative-detail.mdx index 690522a..e8c139a 100644 --- a/api-reference/initiative/get-initiative-detail.mdx +++ b/api-reference/initiative/get-initiative-detail.mdx @@ -1,12 +1,16 @@ --- -title: Get initiative details -description: Gets the details of an initiative -api: GET /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/ +title: Retrieve an initiative +description: Retrieves the details of an existing initiative by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + diff --git a/api-reference/initiative/get-initiative-label-detail.mdx b/api-reference/initiative/get-initiative-label-detail.mdx index 719e771..9cedebf 100644 --- a/api-reference/initiative/get-initiative-label-detail.mdx +++ b/api-reference/initiative/get-initiative-label-detail.mdx @@ -1,12 +1,16 @@ --- -title: Get initiative label details -description: Gets the details of an initiative label -api: GET /api/v1/workspaces/{workspace-slug}/initiatives/labels/{label_id}/ +title: Retrieve an initiative label +description: Retrieves the details of an existing initiative label by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/initiatives/labels/{label_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative label. + diff --git a/api-reference/initiative/list-initiative-epics.mdx b/api-reference/initiative/list-initiative-epics.mdx index 9e047d7..1b9538e 100644 --- a/api-reference/initiative/list-initiative-epics.mdx +++ b/api-reference/initiative/list-initiative-epics.mdx @@ -1,22 +1,26 @@ --- -title: List initiative epics -description: Gets all the epics associated with an initiative -api: GET /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/epics/ +title: List all epics for an initiative +description: Returns a list of all epics associated with an initiative. +api: GET /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/epics/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Query parameters +## Query parameters -Number of results to return +Number of results to return per page. - -Number of results to skip + +Number of results to skip for pagination. diff --git a/api-reference/initiative/list-initiative-labels-for-initiative.mdx b/api-reference/initiative/list-initiative-labels-for-initiative.mdx index 8e9626b..6beaf0e 100644 --- a/api-reference/initiative/list-initiative-labels-for-initiative.mdx +++ b/api-reference/initiative/list-initiative-labels-for-initiative.mdx @@ -1,22 +1,26 @@ --- -title: List initiative labels for initiative -description: Gets all the labels associated with an initiative -api: GET /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/labels/ +title: List all labels for an initiative +description: Returns a list of all labels associated with an initiative. +api: GET /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/labels/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Query parameters +## Query parameters -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/initiative/list-initiative-labels.mdx b/api-reference/initiative/list-initiative-labels.mdx index 64a15b5..21c448b 100644 --- a/api-reference/initiative/list-initiative-labels.mdx +++ b/api-reference/initiative/list-initiative-labels.mdx @@ -1,20 +1,22 @@ --- -title: List initiative labels -description: Gets all the initiative labels in a workspace -api: GET /api/v1/workspaces/{workspace-slug}/initiatives/labels/ +title: List all initiative labels +description: Returns a list of all initiative labels in a workspace. +api: GET /api/v1/workspaces/{workspace_slug}/initiatives/labels/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Query parameters +## Query parameters -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/initiative/list-initiative-projects.mdx b/api-reference/initiative/list-initiative-projects.mdx index 15b0856..98bf0d2 100644 --- a/api-reference/initiative/list-initiative-projects.mdx +++ b/api-reference/initiative/list-initiative-projects.mdx @@ -1,22 +1,26 @@ --- -title: List initiative projects -description: Gets all the projects associated with an initiative -api: GET /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/projects/ +title: List all projects in an initiative +description: Returns a list of all projects associated with an initiative. +api: GET /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/projects/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Query parameters +## Query parameters -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/initiative/list-initiatives.mdx b/api-reference/initiative/list-initiatives.mdx index 6adcb64..5f1aca4 100644 --- a/api-reference/initiative/list-initiatives.mdx +++ b/api-reference/initiative/list-initiatives.mdx @@ -1,20 +1,22 @@ --- -title: List initiatives -description: Gets all the initiatives in a workspace -api: GET /api/v1/workspaces/{workspace-slug}/initiatives/ +title: List all initiatives +description: Returns a list of all initiatives in a workspace. +api: GET /api/v1/workspaces/{workspace_slug}/initiatives/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Query parameters +## Query parameters -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/initiative/overview.mdx b/api-reference/initiative/overview.mdx index a0ba14c..a721134 100644 --- a/api-reference/initiative/overview.mdx +++ b/api-reference/initiative/overview.mdx @@ -2,50 +2,11 @@ title: Overview --- -Initiatives are high-level strategic goals that help organize and track work across multiple projects, epics, and work items. They provide a way to group related work and measure progress toward larger objectives. +Initiatives are high-level strategic goals that help organize and track work across multiple projects, epics, and work items, providing a way to group related work and measure progress toward larger objectives. -## APIs +[Learn more about Initiatives](https://docs.plane.so/core-concepts/projects/initiatives) -### Initiative Management - -```http -POST /api/v1/workspaces/:workspace-slug/initiatives/ -GET /api/v1/workspaces/:workspace-slug/initiatives/ -GET /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/ -PATCH /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/ -DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/ -``` - -### Initiative Labels - -```http -POST /api/v1/workspaces/:workspace-slug/initiatives/labels/ -GET /api/v1/workspaces/:workspace-slug/initiatives/labels/ -GET /api/v1/workspaces/:workspace-slug/initiatives/labels/:label_id/ -PATCH /api/v1/workspaces/:workspace-slug/initiatives/labels/:label_id/ -DELETE /api/v1/workspaces/:workspace-slug/initiatives/labels/:label_id/ -GET /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/labels/ -POST /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/labels/ -DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/labels/ -``` - -### Initiative Projects - -```http -GET /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/projects/ -POST /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/projects/ -DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/projects/ -``` - -### Initiative Epics - -```http -GET /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/epics/ -POST /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/epics/ -DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/epics/ -``` - -### Initiative Object +## The Initiative object **Attributes** @@ -114,7 +75,7 @@ DELETE /api/v1/workspaces/:workspace-slug/initiatives/:initiative_id/epics/ ID of the user who last updated the initiative -```json JSON +```json INITIATIVES OBJECT { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "created_at": "2023-11-19T11:56:55.176802Z", diff --git a/api-reference/initiative/remove-epics-from-initiative.mdx b/api-reference/initiative/remove-epics-from-initiative.mdx index 65fd2a7..638ce11 100644 --- a/api-reference/initiative/remove-epics-from-initiative.mdx +++ b/api-reference/initiative/remove-epics-from-initiative.mdx @@ -1,18 +1,22 @@ --- title: Remove epics from initiative -description: Removes epics from an initiative -api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/epics/ +description: Removes one or more epics from an initiative. +api: DELETE /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/epics/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Body +## Body parameters -Array of epic IDs to remove from the initiative +Array of epic IDs to remove from the initiative. diff --git a/api-reference/initiative/remove-labels-from-initiative.mdx b/api-reference/initiative/remove-labels-from-initiative.mdx index 7d64660..cbd19c2 100644 --- a/api-reference/initiative/remove-labels-from-initiative.mdx +++ b/api-reference/initiative/remove-labels-from-initiative.mdx @@ -1,18 +1,22 @@ --- title: Remove labels from initiative -description: Removes labels from an initiative -api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/labels/ +description: Removes one or more labels from an initiative. +api: DELETE /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/labels/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Body +## Body parameters -Array of initiative label IDs to remove from the initiative +Array of initiative label IDs to remove from the initiative. diff --git a/api-reference/initiative/remove-projects-from-initiative.mdx b/api-reference/initiative/remove-projects-from-initiative.mdx index c6c87e5..95b93be 100644 --- a/api-reference/initiative/remove-projects-from-initiative.mdx +++ b/api-reference/initiative/remove-projects-from-initiative.mdx @@ -1,18 +1,22 @@ --- title: Remove projects from initiative -description: Removes projects from an initiative -api: DELETE /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/projects/ +description: Removes one or more projects from an initiative. +api: DELETE /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/projects/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Body +## Body parameters -Array of project IDs to remove from the initiative +Array of project IDs to remove from the initiative. diff --git a/api-reference/initiative/update-initiative-detail.mdx b/api-reference/initiative/update-initiative-detail.mdx index ed294a0..55068eb 100644 --- a/api-reference/initiative/update-initiative-detail.mdx +++ b/api-reference/initiative/update-initiative-detail.mdx @@ -1,47 +1,51 @@ --- -title: Update initiative details -description: Updates the details of an initiative -api: PATCH /api/v1/workspaces/{workspace-slug}/initiatives/{initiative_id}/ +title: Update an initiative +description: Updates an existing initiative by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative. + -### Body +## Body parameters - -Name of the initiative + +Name of the initiative. -Plain text description of the initiative +Plain text description of the initiative. -HTML description of the initiative +HTML-formatted description of the initiative. -Stripped version of the HTML description +Stripped version of the HTML description. -Binary description of the initiative +Binary representation of the description. -User ID of the initiative lead +ID of the user who leads the initiative. -Start date of the initiative in YYYY-MM-DD format +Start date in YYYY-MM-DD format. -End date of the initiative in YYYY-MM-DD format +End date in YYYY-MM-DD format. @@ -49,6 +53,6 @@ Logo properties for the initiative -State of the initiative. Can be: DRAFT, PLANNED, ACTIVE, COMPLETED, CLOSED +Current state of the initiative. Possible values: `DRAFT`, `PLANNED`, `ACTIVE`, `COMPLETED`, `CLOSED`. diff --git a/api-reference/initiative/update-initiative-label-detail.mdx b/api-reference/initiative/update-initiative-label-detail.mdx index 22c7730..3513a2d 100644 --- a/api-reference/initiative/update-initiative-label-detail.mdx +++ b/api-reference/initiative/update-initiative-label-detail.mdx @@ -1,30 +1,34 @@ --- -title: Update initiative label details -description: Updates the details of an initiative label -api: PATCH /api/v1/workspaces/{workspace-slug}/initiatives/labels/{label_id}/ +title: Update an initiative label +description: Updates an existing initiative label by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/initiatives/labels/{label_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the initiative label. + -### Body +## Body parameters -Name of the initiative label +Name of the initiative label. -Description of the initiative label +Description of the initiative label. -Color code for the initiative label +Hex color code for the initiative label (e.g., "#eb5757"). -Sort order for the initiative label +Sort order for display purposes. diff --git a/api-reference/intake-issue/add-intake-issue.mdx b/api-reference/intake-issue/add-intake-issue.mdx index fd75958..c2fd4e4 100644 --- a/api-reference/intake-issue/add-intake-issue.mdx +++ b/api-reference/intake-issue/add-intake-issue.mdx @@ -1,17 +1,19 @@ --- -title: Add intake issue -description: Adds an intake issue in a project -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/ +title: Create an intake work item +description: Creates a new intake work item in a project. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/intake-issues/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. -### Body +## Body parameters - - + Name of the intake issue. + \ No newline at end of file diff --git a/api-reference/intake-issue/delete-intake-issue.mdx b/api-reference/intake-issue/delete-intake-issue.mdx index 9083012..bb1c157 100644 --- a/api-reference/intake-issue/delete-intake-issue.mdx +++ b/api-reference/intake-issue/delete-intake-issue.mdx @@ -1,15 +1,16 @@ --- -title: Delete intake issue -description: Deletes an intake issue -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id} +title: Delete an intake work item +description: Permanently deletes an intake work item from a project. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/intake-issues/{issue_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. - + +The unique identifier of the project +The unique identifier of the work item - - - +The unique identifier for the intake work item. diff --git a/api-reference/intake-issue/get-intake-issue-detail.mdx b/api-reference/intake-issue/get-intake-issue-detail.mdx index eb488b2..2441a0a 100644 --- a/api-reference/intake-issue/get-intake-issue-detail.mdx +++ b/api-reference/intake-issue/get-intake-issue-detail.mdx @@ -1,13 +1,14 @@ --- -title: Get intake issue detail -description: Gets the details of an intake issue -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id} +title: Retrieve an intake work item +description: Retrieves the details of an existing intake work item by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/intake-issues/{issue_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. - - - + +The unique identifier of the project +The unique identifier of the work item diff --git a/api-reference/intake-issue/list-intake-issues.mdx b/api-reference/intake-issue/list-intake-issues.mdx index 6c553c2..1ec1afe 100644 --- a/api-reference/intake-issue/list-intake-issues.mdx +++ b/api-reference/intake-issue/list-intake-issues.mdx @@ -1,11 +1,12 @@ --- -title: List intake issues -description: Gets all the intake issue of a project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/ +title: List all intake work items +description: Returns a list of all intake work items in a project. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/intake-issues/ --- -### Path parameters +## Path parameters - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The unique identifier of the project diff --git a/api-reference/intake-issue/overview.mdx b/api-reference/intake-issue/overview.mdx index 1ba8a9f..4ff6297 100644 --- a/api-reference/intake-issue/overview.mdx +++ b/api-reference/intake-issue/overview.mdx @@ -1,6 +1,9 @@ --- title: Overview --- +Intake allows guests to create work items that admins and members can review and move into a project. + +[Learn more about Intake →](https://docs.plane.so/core-concepts/intake) **Deprecation notice** @@ -14,15 +17,9 @@ We are deprecating all `/api/v1/.../inbox-issues/` endpoints in favor of `/api/v To ensure uninterrupted service, replace all `/inbox-issues/` references with `/intake-issues/` in your codebase before the support end date. -To enable the Intake feature, the user can hit a PATCH request on the project api with the body as +## Enable Intake -```http -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/:issue_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/:issue_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/:issue_id/ -``` +To enable the Intake feature, the user can hit a PATCH request on the project api with the body as ``` { @@ -30,18 +27,18 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/:is } ``` -To create an Intake issue, the payload should be sent in the below format +To create an Intake work item, the payload should be sent in the below format ```json { "issue": { - "name": "Snoozed Issue 2", + "name": "Snoozed task 2", "priority": "high" } } ``` -### Intake issue object +### The Intake object **Attribute** @@ -55,7 +52,7 @@ To create an Intake issue, the payload should be sent in the below format - `status` - the status of the issue can be in above mentioned status + the status of the work item can be in above mentioned status - \-2 - Pending - \-1 - Rejected @@ -65,11 +62,11 @@ To create an Intake issue, the payload should be sent in the below format - `snoozed_till` - The time untill the issue is snoozed. + The time untill the work item is snoozed. - `source` - The source describes the type intake issue from + The source describes the type of intake from - `created_by` , `updated_by` _uuid_ @@ -85,18 +82,18 @@ To create an Intake issue, the payload should be sent in the below format - `inbox` - intake id of the issue + intake id of the work item - `issue` - issue id of the issue + work item id of the work item - `duplicate_to` - Id of the issue of which the current issue is duplicate of. + Id of the work item of which the current work item is duplicate of. -```json JSON +```json INTAKE OBJECT { "id": "0de4d6d1-fdc7-4849-8080-dc379ab210e3", "pending_issue_count": 0, diff --git a/api-reference/intake-issue/update-intake-issue-detail.mdx b/api-reference/intake-issue/update-intake-issue-detail.mdx index 40dccf9..174b4de 100644 --- a/api-reference/intake-issue/update-intake-issue-detail.mdx +++ b/api-reference/intake-issue/update-intake-issue-detail.mdx @@ -1,19 +1,20 @@ --- -title: Update intake issue detail -description: Updates the details of an intake issue -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id} +title: Update an intake work item +description: Updates an existing intake work item by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/intake-issues/{issue_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. - - - + +The unique identifier of the project +The unique identifier of the work item -### Body +## Body parameters - + Name of the intake work item. diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 3818074..a186eee 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -4,6 +4,18 @@ sidebarTitle: Introduction description: 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. --- + +**Deprecation notice** + +We are deprecating all `/api/v1/.../issues/` endpoints in favor of `/api/v1/.../work-items/`. + +**End of support** +31st March 2026 + +**What you need to do** +To ensure uninterrupted service, replace all `/issues/` references with `/work-items/` in your codebase before the support end date. + + ### Base URL All requests to the Plane Cloud API must be made to the following base URL: ``` @@ -13,7 +25,7 @@ This URL should be prefixed to all endpoint paths. For example, to retrieve all projects in a workspace: ``` - GET https://api.plane.so/api/v1/workspaces/:workspace-slug/projects/ + GET https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/ ``` 💡 If you're using a self-hosted instance of Plane, your API base URL will differ based on your custom domain and setup. @@ -52,7 +64,7 @@ Here's an example of making a GET request to the API with the API key: ### Request ``` -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/ +GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/ Headers: X-API-Key: plane_api_ @@ -160,7 +172,7 @@ The paginated response includes the following fields: ### Request: Fetching the First Page ``` -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/?per_page=20 +GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/?per_page=20 ``` @@ -186,7 +198,7 @@ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/?per_page=20 ### Request: Fetching the Next Page ``` -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues?per_page=20&cursor=20:1:0 +GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items?per_page=20&cursor=20:1:0 ``` @@ -258,7 +270,7 @@ The fields parameter enables clients to selectively retrieve only a subset of fi * Syntax: **`?fields=field1,field2,field3`** ``` -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/?fields=id,name,description +GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/?fields=id,name,description ``` @@ -279,7 +291,7 @@ The expand parameter allows clients to request additional related information to ## Example ``` -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/?expand=assignees,state +GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/?expand=assignees,state ``` diff --git a/api-reference/issue-activity/get-issue-activity-detail.mdx b/api-reference/issue-activity/get-issue-activity-detail.mdx index cedfe13..f00226b 100644 --- a/api-reference/issue-activity/get-issue-activity-detail.mdx +++ b/api-reference/issue-activity/get-issue-activity-detail.mdx @@ -1,15 +1,23 @@ --- -title: Get work item activity details -description: Gets the details of a work item activity -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/activities/{activity_id}/ +title: Retrieve a work item activity +description: Retrieves the details of an existing work item activity by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/activities/{activity_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + - + +The unique identifier for the activity. + diff --git a/api-reference/issue-activity/list-issue-activities.mdx b/api-reference/issue-activity/list-issue-activities.mdx index 4e6bee3..00fa1c4 100644 --- a/api-reference/issue-activity/list-issue-activities.mdx +++ b/api-reference/issue-activity/list-issue-activities.mdx @@ -1,13 +1,19 @@ --- -title: List work item activities -description: Gets the activities of a work item -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/activities/ +title: List all work item activity +description: Returns a list of all activities for a work item, ordered chronologically. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/activities/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + diff --git a/api-reference/issue-activity/overview.mdx b/api-reference/issue-activity/overview.mdx index be43278..50b72a2 100644 --- a/api-reference/issue-activity/overview.mdx +++ b/api-reference/issue-activity/overview.mdx @@ -2,16 +2,21 @@ title: Overview --- -Work item activities are the history of all the changes that happened to the work item like property changes etc. +Work item activity represents the history of all changes made to a work item, including property changes, comments, and other modifications. -## APIs + +**Deprecation notice** -```http -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/activities/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/activities/:activity_id/ -``` +We are deprecating all `/api/v1/.../issues/` endpoints in favor of `/api/v1/.../work-items/`. + +**End of support** +31st March 2026 + +**What you need to do** +To ensure uninterrupted service, replace all `/issues/` references with `/work-items/` in your codebase before the support end date. + -### Work Item Activity Object +## The Activity object **Attributes** @@ -88,7 +93,7 @@ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ The actor who triggered this activity -```json JSON +```json THE ACTIVITY OBJECT { "id": "35612f5b-3eff-4130-b91c-c976ff887a20", "created_at": "2023-11-19T11:56:55.452555Z", diff --git a/api-reference/issue-attachments/complete-upload.mdx b/api-reference/issue-attachments/complete-upload.mdx index 341e280..645097e 100644 --- a/api-reference/issue-attachments/complete-upload.mdx +++ b/api-reference/issue-attachments/complete-upload.mdx @@ -1,19 +1,19 @@ --- title: Complete upload description: 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). -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{asset_id}/ +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{asset_id}/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. The unique identifier of the project -The unique identifier of the work item +The unique identifier of the work item -The unique identifier of the attachment generated by the [Get upload credentials](/api-reference/issue-attachments/get-upload-credentials#response) endpoint. +The unique identifier of the attachment generated by the [Get upload credentials](/api-reference/attachments/get-upload-credentials#response) endpoint. diff --git a/api-reference/issue-attachments/delete-attachment.mdx b/api-reference/issue-attachments/delete-attachment.mdx index 5a186c5..8d96f9c 100644 --- a/api-reference/issue-attachments/delete-attachment.mdx +++ b/api-reference/issue-attachments/delete-attachment.mdx @@ -1,18 +1,18 @@ --- -title: Delete attachment -description: Deletes an attachment from a work item -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{attachment_id}/ +title: Delete an attachment +description: Permanently deletes an attachment from a work item. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{attachment_id}/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. -The unique identifier of the project +The unique identifier of the project. -The unique identifier of the work item +The unique identifier of the work item. -The unique identifier of the attachment +The unique identifier of the attachment. diff --git a/api-reference/issue-attachments/get-attachment-detail.mdx b/api-reference/issue-attachments/get-attachment-detail.mdx index 2fd6235..14fe95b 100644 --- a/api-reference/issue-attachments/get-attachment-detail.mdx +++ b/api-reference/issue-attachments/get-attachment-detail.mdx @@ -1,18 +1,18 @@ --- -title: Get attachment details -description: Gets the details of a specific attachment -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{attachment_id}/ +title: Retrieve an attachment +description: Retrieves the details of an existing attachment by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{attachment_id}/ --- ### Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. The unique identifier of the project -The unique identifier of the work item +The unique identifier of the work item The unique identifier of the attachment diff --git a/api-reference/issue-attachments/get-attachments.mdx b/api-reference/issue-attachments/get-attachments.mdx index 76fa376..a66222b 100644 --- a/api-reference/issue-attachments/get-attachments.mdx +++ b/api-reference/issue-attachments/get-attachments.mdx @@ -1,41 +1,41 @@ --- -title: Get attachments -description: Gets all the attachments in the work item. -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/ +title: List all attachments +description: Returns a list of all attachments for a work item. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/ --- -### Path parameters - - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. +## Path parameters + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. The unique identifier of the project -The unique identifier of the work item +The unique identifier of the work item -### Query parameters +## Query parameters -Filter by work item UUID +Filter by work item ID. -Filter by project UUID +Filter by project ID. -Filter by workspace UUID +Filter by workspace ID. -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. ### Response +Returns an array of work item attachment objects. ```json { diff --git a/api-reference/issue-attachments/get-upload-credentials.mdx b/api-reference/issue-attachments/get-upload-credentials.mdx index 8575025..eb02c29 100644 --- a/api-reference/issue-attachments/get-upload-credentials.mdx +++ b/api-reference/issue-attachments/get-upload-credentials.mdx @@ -1,37 +1,37 @@ --- title: Get upload credentials description: 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. -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/ +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. -The unique identifier of the project -The unique identifier of the work item +The unique identifier of the project. +The unique identifier of the work item. -### Body +## Body parameters -Original filename of the attachment +Original filename of the attachment. -MIME type of the file (e.g., `image/png`, `application/pdf`) +MIME type of the file (e.g., `image/png`, `application/pdf`). -Size of the file in bytes +Size of the file in bytes. -External identifier for the asset (for integration tracking) +External identifier for the asset (for integration tracking). -External source system (for integration tracking) +External source system (for integration tracking). -### Response +## Response Returns an object containing the S3 pre-signed POST data for direct upload. ```json @@ -74,6 +74,6 @@ Returns an object containing the S3 pre-signed POST data for direct upload. "project": "", "issue": "", }, - "asset_url": "/api/assets/v2/workspaces//projects//issues//attachments//" + "asset_url": "/api/assets/v2/workspaces//projects//work-items//attachments//" } ``` \ No newline at end of file diff --git a/api-reference/issue-attachments/overview.mdx b/api-reference/issue-attachments/overview.mdx index e4fe10e..c254dd3 100644 --- a/api-reference/issue-attachments/overview.mdx +++ b/api-reference/issue-attachments/overview.mdx @@ -4,23 +4,27 @@ title: Overview Allows you to manage file attachments associated with work items and Intake issues. You can upload new attachments and retrieve existing attachments for a specific work item. -## APIs - -```http -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/:attachment_id/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/:attachment_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-attachments/:attachment_id/ -``` +[Learn more about Attachments →](https://docs.plane.so/core-concepts/issues/overview#add-links-and-attachments) + + +**Deprecation notice** + +We are deprecating all `/api/v1/.../issues/` endpoints in favor of `/api/v1/.../work-items/`. + +**End of support** +31st March 2026 + +**What you need to do** +To ensure uninterrupted service, replace all `/issues/` references with `/work-items/` in your codebase before the support end date. + -## Upload Process +## Upload process 1. Get the [upload credentials](/api-reference/issue-attachments/get-upload-credentials). 2. [Upload the file](/api-reference/issue-attachments/upload-file) to storage. 3. [Complete attachment upload](/api-reference/issue-attachments/complete-upload) to notify server. -## Work Item Attachment Object +## The Attachment object **Attributes** @@ -150,7 +154,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ -```json JSON +```json THE ATTACHMENT OBJECT { "id": "8caf3ed5-4f57-9674-76c4fce146b2", "created_at": "2024-10-30T09:32:32.815273Z", diff --git a/api-reference/issue-attachments/update-attachment.mdx b/api-reference/issue-attachments/update-attachment.mdx index 76cec2a..fa121e5 100644 --- a/api-reference/issue-attachments/update-attachment.mdx +++ b/api-reference/issue-attachments/update-attachment.mdx @@ -1,64 +1,64 @@ --- -title: Update attachment -description: Updates the details of an attachment -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/issue-attachments/{attachment_id}/ +title: Update an attachment +description: Updates an existing attachment by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{attachment_id}/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. -The unique identifier of the project +The unique identifier of the project. -The unique identifier of the work item +The unique identifier of the work item. -The unique identifier of the attachment +The unique identifier of the attachment. -### Body +## Body parameters -File metadata object containing name, size, and type +File metadata object containing name, size, and type. -Storage path/identifier for the attachment file +Storage path/identifier for the attachment file. -Entity type of the attachment +Entity type of the attachment. -Entity identifier for the attachment +Entity identifier for the attachment. -Whether the attachment has been deleted +Whether the attachment has been deleted. -Whether the attachment has been archived +Whether the attachment has been archived. -External identifier if the attachment is imported to Plane +External identifier if the attachment is imported to Plane. -Name of the source if the attachment is imported to Plane +Name of the source if the attachment is imported to Plane. -File size in bytes +File size in bytes. -Whether the file has been successfully uploaded +Whether the file has been successfully uploaded. -Cloud storage metadata +Cloud storage metadata. diff --git a/api-reference/issue-attachments/upload-file.mdx b/api-reference/issue-attachments/upload-file.mdx index a978141..ab3858e 100644 --- a/api-reference/issue-attachments/upload-file.mdx +++ b/api-reference/issue-attachments/upload-file.mdx @@ -11,7 +11,7 @@ Use the upload URL returned by the [Get upload credentials](/api-reference/issue -### Body +## Body parameters The MIME type of the file The target path/filename in S3 diff --git a/api-reference/issue-comment/add-issue-comment.mdx b/api-reference/issue-comment/add-issue-comment.mdx index cbbc1cb..9869df7 100644 --- a/api-reference/issue-comment/add-issue-comment.mdx +++ b/api-reference/issue-comment/add-issue-comment.mdx @@ -1,35 +1,41 @@ --- -title: Add work item comment -description: Adds a comment to a work item -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/ +title: Create a work item comment +description: Creates a new comment on a work item. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + -### Body +## Body parameters -HTML string version of the comment +HTML-formatted version of the comment. -JSON object version of the comment +JSON representation of the comment structure. -Access level of the comment. Can be: INTERNAL, EXTERNAL +Visibility level of the comment. Possible values: `INTERNAL`, `EXTERNAL`. -External source identifier +Identifier for the external source. -External ID from the external source +ID from the external source. diff --git a/api-reference/issue-comment/delete-issue-comment.mdx b/api-reference/issue-comment/delete-issue-comment.mdx index 895732a..6d75c75 100644 --- a/api-reference/issue-comment/delete-issue-comment.mdx +++ b/api-reference/issue-comment/delete-issue-comment.mdx @@ -1,15 +1,23 @@ --- -title: Delete work item comment -description: Deletes a comment of a work item -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id}/ +title: Delete a work item comment +description: Permanently deletes a comment from a work item. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/{comment_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + - + +The unique identifier for the comment. + diff --git a/api-reference/issue-comment/get-issue-comment-detail.mdx b/api-reference/issue-comment/get-issue-comment-detail.mdx index adf2a9d..6c7f32c 100644 --- a/api-reference/issue-comment/get-issue-comment-detail.mdx +++ b/api-reference/issue-comment/get-issue-comment-detail.mdx @@ -1,15 +1,23 @@ --- -title: Get work item comment details -description: Gets the details of a comment of a work item -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id}/ +title: Retrieve a work item comment +description: Retrieves the details of an existing work item comment by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/{comment_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + - + +The unique identifier for the comment. + diff --git a/api-reference/issue-comment/list-issue-comments.mdx b/api-reference/issue-comment/list-issue-comments.mdx index 6874f0f..51152f6 100644 --- a/api-reference/issue-comment/list-issue-comments.mdx +++ b/api-reference/issue-comment/list-issue-comments.mdx @@ -1,35 +1,41 @@ --- -title: List work item comments -description: Gets all the comments of a work item -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/ +title: List all work item comments +description: Returns a list of all comments on a work item, ordered chronologically. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + -### Query parameters +## Query parameters -Filter by work item UUID +Filter by work item ID. -Filter by project UUID +Filter by project ID. -Filter by workspace UUID +Filter by workspace ID. -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. \ No newline at end of file diff --git a/api-reference/issue-comment/overview.mdx b/api-reference/issue-comment/overview.mdx index 7a7300f..762ca4c 100644 --- a/api-reference/issue-comment/overview.mdx +++ b/api-reference/issue-comment/overview.mdx @@ -2,19 +2,23 @@ title: Overview --- -The comments that are added to the work item. +Comments allow team members to discuss and collaborate on work items by adding text, mentions, and attachments. -## APIs +[Learn more about Work Item Comments →](https://docs.plane.so/core-concepts/issues/overview#comment-on-work-items) -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/comments/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/comments/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/comments/:comment_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/comments/:comment_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/comments/:comment_id/ -``` + +**Deprecation notice** + +We are deprecating all `/api/v1/.../issues/` endpoints in favor of `/api/v1/.../work-items/`. + +**End of support** +31st March 2026 + +**What you need to do** +To ensure uninterrupted service, replace all `/issues/` references with `/work-items/` in your codebase before the support end date. + -### Work Item Comment Object +## The Comments object **Attributes** @@ -94,7 +98,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ UUID of the user who commented. -```json JSON +```json THE COMMENTS OBJECT { "id": "f3e29f26-708d-40f0-9209-7e0de44abc49", "created_at": "2023-11-20T09:26:10.383129Z", diff --git a/api-reference/issue-comment/update-issue-comment-detail.mdx b/api-reference/issue-comment/update-issue-comment-detail.mdx index f75e79b..662c5a5 100644 --- a/api-reference/issue-comment/update-issue-comment-detail.mdx +++ b/api-reference/issue-comment/update-issue-comment-detail.mdx @@ -1,37 +1,45 @@ --- -title: Update work item comment details -description: Updates the details of a comment of a work item -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/comments/{comment_id}/ +title: Update a work item comment +description: Updates an existing work item comment by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/{comment_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + - + +The unique identifier for the comment. + -### Body +## Body parameters -HTML string version of the comment +HTML-formatted version of the comment. -JSON object version of the comment +JSON representation of the comment structure. -Access level of the comment. Can be: INTERNAL, EXTERNAL +Visibility level of the comment. Possible values: `INTERNAL`, `EXTERNAL`. -External source identifier +Identifier for the external source. -External ID from the external source +ID from the external source. diff --git a/api-reference/issue-types/options/add-dropdown-options.mdx b/api-reference/issue-types/options/add-dropdown-options.mdx index 79a53b5..294615b 100644 --- a/api-reference/issue-types/options/add-dropdown-options.mdx +++ b/api-reference/issue-types/options/add-dropdown-options.mdx @@ -1,19 +1,25 @@ --- title: Add dropdown options description: Allows you to define a list of options for the dropdown property type. -api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-properties/{property_id}/options/ +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/ --- -### Path parameters +## Path parameters - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body + +The unique identifier of the project. + - - - - +The unique identifier for the custom property. + +## Body parameters + +Name of the option. +Description of the option. +Whether this is the default option for the property. +Whether this option is currently active. diff --git a/api-reference/issue-types/options/delete-dropdown-options.mdx b/api-reference/issue-types/options/delete-dropdown-options.mdx index f0e466a..a690be4 100644 --- a/api-reference/issue-types/options/delete-dropdown-options.mdx +++ b/api-reference/issue-types/options/delete-dropdown-options.mdx @@ -1,12 +1,19 @@ --- -title: Delete property options +title: Delete dropdown options description: Enables you to remove specific options from a dropdown custom property. -api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/ --- -### Path parameters +## Path parameters - - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + + +The unique identifier for the custom property. + +The unique identifier for the option. diff --git a/api-reference/issue-types/options/get-option-details.mdx b/api-reference/issue-types/options/get-option-details.mdx index d414fa3..4b0bbc0 100644 --- a/api-reference/issue-types/options/get-option-details.mdx +++ b/api-reference/issue-types/options/get-option-details.mdx @@ -1,12 +1,19 @@ --- -title: Get option details +title: Retrieve option details description: Retrieves information about a specific option within a dropdown property. -api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/ --- -### Path parameters +## Path parameters - - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + + +The unique identifier for the custom property. + +The unique identifier for the option. diff --git a/api-reference/issue-types/options/list-dropdown-options.mdx b/api-reference/issue-types/options/list-dropdown-options.mdx index e3a11a4..f054229 100644 --- a/api-reference/issue-types/options/list-dropdown-options.mdx +++ b/api-reference/issue-types/options/list-dropdown-options.mdx @@ -1,11 +1,17 @@ --- -title: List property options +title: List all dropdown options description: Retrieves all available options for a specific dropdown custom property. -api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-properties/{property_id}/options/ +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/ --- -### Path parameters +## Path parameters - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + + +The unique identifier for the custom property. diff --git a/api-reference/issue-types/options/overview.mdx b/api-reference/issue-types/options/overview.mdx index 0167516..5d3ceb6 100644 --- a/api-reference/issue-types/options/overview.mdx +++ b/api-reference/issue-types/options/overview.mdx @@ -1,17 +1,22 @@ --- title: Overview -description: Provides a set of endpoints for adding, modifying, and deleting options within the dropdown custom property types. --- -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/:option_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/:option_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/:option_id/ -``` +Custom property options define the available choices for dropdown-style custom properties on work items. + + +**Deprecation notice** + +We are deprecating all `/api/v1/.../issue-properties/` endpoints in favor of `/api/v1/.../work-item-properties/`. + +**End of support** +31st March 2026 + +**What you need to do** +To ensure uninterrupted service, replace all `/issue-properties/` references with `/work-item-properties/` in your codebase before the support end date. + -### Issue Property Options Object +## The Options object - `workspace` _uuid_ @@ -35,7 +40,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/ -```json JSON +```json THE OPTIONS OBJECT { "id": "51a869d1-f612-4315-ac91-ffef3e96c20e", "created_at": "2024-10-23T07:44:42.883820Z", diff --git a/api-reference/issue-types/options/update-dropdown-options.mdx b/api-reference/issue-types/options/update-dropdown-options.mdx index 2b24a8a..cfd28a5 100644 --- a/api-reference/issue-types/options/update-dropdown-options.mdx +++ b/api-reference/issue-types/options/update-dropdown-options.mdx @@ -1,20 +1,27 @@ --- -title: Update property options +title: Update dropdown options description: Lets you modify existing options within a dropdown property. -api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/ +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/ --- -### Path parameters +## Path parameters - - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body + +The unique identifier of the project. + - - - - +The unique identifier for the custom property. + +The unique identifier for the option. + +## Body parameter + +Name of the option. +Description of the option. +Whether this is the default option for the property. +Whether this option is currently active. diff --git a/api-reference/issue-types/properties/add-property.mdx b/api-reference/issue-types/properties/add-property.mdx index 6266fbc..900c4b1 100644 --- a/api-reference/issue-types/properties/add-property.mdx +++ b/api-reference/issue-types/properties/add-property.mdx @@ -1,27 +1,35 @@ --- -title: Add issue properties -description: Define additional attributes for an issue type in your project. -api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/ +title: Create a custom property +description: Creates a new custom property for a work item type. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/ --- -### Path parameters +## Path parameters - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + -### Body +The unique identifier for the work item type. - - +## Body parameters + +Display name shown in the UI. +Description of the custom property. -TEXT | DATETIME | DECIMAL | BOOLEAN | OPTION | RELATION +Type of the property. Possible values: `TEXT`, `DATETIME`, `DECIMAL`, `BOOLEAN`, `OPTION`, `RELATION`. -null | USER +Relation type if the property links to other entities. Possible values: `null`, `USER`. + + +Default value(s) for the property. - - - - - +Validation rules applied to property values. +Whether this property is required when creating work items. +Whether this property is currently active. +Whether this property allows multiple values. diff --git a/api-reference/issue-types/properties/delete-property.mdx b/api-reference/issue-types/properties/delete-property.mdx index 062d057..78ba452 100644 --- a/api-reference/issue-types/properties/delete-property.mdx +++ b/api-reference/issue-types/properties/delete-property.mdx @@ -1,12 +1,19 @@ --- -title: Delete issue properties -description: Remove specific custom properties from an issue type in your project. -api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ +title: Delete a custom property +description: Permanently deletes a custom property from a work item type. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/ --- -### Path parameters +## Path parameters - - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + + +The unique identifier for the work item type. + +The unique identifier for the custom property. diff --git a/api-reference/issue-types/properties/get-property-details.mdx b/api-reference/issue-types/properties/get-property-details.mdx index fa1aa58..d170da5 100644 --- a/api-reference/issue-types/properties/get-property-details.mdx +++ b/api-reference/issue-types/properties/get-property-details.mdx @@ -1,12 +1,19 @@ --- -title: Get property details -description: Retrieves detailed information about a specific custom property for an issue type in your project. -api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ +title: Retrieve a custom property +description: Retrieves the details of an existing custom property by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/ --- -### Path parameters +## Path parameters - - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + + +The unique identifier for the work item type. + +The unique identifier for the custom property. diff --git a/api-reference/issue-types/properties/list-properties.mdx b/api-reference/issue-types/properties/list-properties.mdx index c58c25b..d0af746 100644 --- a/api-reference/issue-types/properties/list-properties.mdx +++ b/api-reference/issue-types/properties/list-properties.mdx @@ -1,11 +1,17 @@ --- -title: List issue properties -description: Fetches all custom properties associated with a specific issue type in your project. -api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/ +title: List custom properties +description: Returns a list of all custom properties for a work item type. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/ --- -### Path parameters +## Path parameters - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + + +The unique identifier for the work item type. diff --git a/api-reference/issue-types/properties/overview.mdx b/api-reference/issue-types/properties/overview.mdx index 6157067..bc05650 100644 --- a/api-reference/issue-types/properties/overview.mdx +++ b/api-reference/issue-types/properties/overview.mdx @@ -1,17 +1,24 @@ --- title: Overview -description: Offers a set of endpoints designed for adding, modifying, and deleting custom properties associated with issue types in your project. --- +Custom properties allow you to extend work items with additional fields specific to your workflow and processes. + +[Learn more about Custom properties →](https://docs.plane.so/core-concepts/issues/work-item-types#add-custom-properties) + + +**Deprecation notice** + +We are deprecating all `/api/v1/.../issue-types/` endpoints in favor of `/api/v1/.../work-item-types/`. + +**End of support** +31st March 2026 + +**What you need to do** +To ensure uninterrupted service, replace all `/issue-types/` references with `/work-item-types/` in your codebase before the support end date. + -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type_id/issue-properties/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type_id/issue-properties/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type_id/issue-properties/:property_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type_id/issue-properties/:property_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type_id/issue-properties/:property_id/ -``` -### Issue Properties Object +## The Properties object - `workspace` _uuid_ @@ -35,7 +42,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-types/:type -```json JSON +```json THE PROPERTIES OBJECT { "id": "f962febb-98bc-43ca-8bfb-8012e4d54dae", "created_at": "2024-10-23T07:38:58.231897Z", diff --git a/api-reference/issue-types/properties/update-property.mdx b/api-reference/issue-types/properties/update-property.mdx index 0b794d0..e7411ba 100644 --- a/api-reference/issue-types/properties/update-property.mdx +++ b/api-reference/issue-types/properties/update-property.mdx @@ -1,28 +1,34 @@ --- -title: Update issue properties -description: Lets you modify existing properties for an issue type in your project. -api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/ +title: Update a custom property +description: Updates an existing custom property by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/ --- -### Path parameters +## Path parameters - - - - - -### Body + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - - - -TEXT | DATETIME | DECIMAL | BOOLEAN | OPTION | RELATION + +The unique identifier of the project. - -null | USER + +The unique identifier for the work item type. + +The unique identifier for the custom property. + + +## Body parameters + + +Display name shown in the UI. - - - - - +Description of the custom property. +Type of the property. Possible values: `TEXT`, `DATETIME`, `DECIMAL`, `BOOLEAN`, `OPTION`, `RELATION`. +Relation type if the property links to other entities. Possible values: `null`, `USER`. +Default value(s) for the property. +Validation rules applied to property values. +Whether this property is required when creating work items. +Whether this property is currently active. +Whether this property allows multiple values. diff --git a/api-reference/issue-types/types/add-issue-type.mdx b/api-reference/issue-types/types/add-issue-type.mdx index 4fa7b3d..89814dd 100644 --- a/api-reference/issue-types/types/add-issue-type.mdx +++ b/api-reference/issue-types/types/add-issue-type.mdx @@ -1,41 +1,45 @@ --- -title: Add work item type -description: Creates a new work item type in your project -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/ +title: Create a work item type +description: Creates a new work item type in a project. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + -### Body +## Body parameters -Name of the work item type +Name of the work item type. -Description of the work item type +Description of the work item type. -Logo properties for the work item type +Logo properties for the work item type. -Whether this work item type is an epic +Whether this work item type is an epic. -Whether this is the default work item type +Whether this is the default work item type. -Whether this work item type is active +Whether this work item type is active. -Level of the work item type +Hierarchical level of the work item type. diff --git a/api-reference/issue-types/types/delete-issue-type.mdx b/api-reference/issue-types/types/delete-issue-type.mdx index b51082a..85d82a4 100644 --- a/api-reference/issue-types/types/delete-issue-type.mdx +++ b/api-reference/issue-types/types/delete-issue-type.mdx @@ -1,13 +1,21 @@ --- -title: Delete work item type -description: Deletes a work item type from your project -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/{work_item_type_id}/ +title: Delete a work item type +description: Permanently deletes a work item type from a project. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/ --- -### Path parameters +## Path parameters - +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + + + +The unique identifier for the work item type. + diff --git a/api-reference/issue-types/types/get-issue-type-details.mdx b/api-reference/issue-types/types/get-issue-type-details.mdx index ca7eac0..0b30e9d 100644 --- a/api-reference/issue-types/types/get-issue-type-details.mdx +++ b/api-reference/issue-types/types/get-issue-type-details.mdx @@ -1,13 +1,19 @@ --- -title: Get work item type details -description: Retrieves details for a specific work item type using its unique ID -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/{work_item_type_id}/ +title: Retrieve a work item type +description: Retrieves the details of an existing work item type by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item type. + diff --git a/api-reference/issue-types/types/list-issue-types.mdx b/api-reference/issue-types/types/list-issue-types.mdx index b8d99a6..d864428 100644 --- a/api-reference/issue-types/types/list-issue-types.mdx +++ b/api-reference/issue-types/types/list-issue-types.mdx @@ -1,25 +1,29 @@ --- -title: List work item types -description: Fetches all available work item types in your project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/ +title: List all work item types +description: Returns a list of all work item types in a project. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + -### Query parameters +## Query parameters -Project UUID to filter work item types +Filter by project ID. -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/issue-types/types/overview.mdx b/api-reference/issue-types/types/overview.mdx index 50a6a11..a4b33c5 100644 --- a/api-reference/issue-types/types/overview.mdx +++ b/api-reference/issue-types/types/overview.mdx @@ -1,19 +1,23 @@ --- title: Overview -description: Provides a comprehensive suite of endpoints for adding, modifying, and deleting work item types within your project. --- +Work item types categorize different kinds of work in your project (e.g., "Task", "Bug", "Feature"). -## APIs +[Learn more about Work Item Types →](https://docs.plane.so/core-concepts/issues/work-item-types) -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/:work_item_type_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/:work_item_type_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/:work_item_type_id/ -``` + +**Deprecation notice** + +We are deprecating all `/api/v1/.../issue-types/` endpoints in favor of `/api/v1/.../work-item-types/`. + +**End of support** +31st March 2026 + +**What you need to do** +To ensure uninterrupted service, replace all `/issue-types/` references with `/work-item-types/` in your codebase before the support end date. + -### Work Item Type Object +## The Work Item Type object **Attributes** @@ -86,7 +90,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/work-item-types/: External source for the work item type (auto saved) -```json JSON +```json WORK ITEM TYPE OBJECT { "id": "d6af3c13-3459-43ab-b91c-c33ef2fd7131", "name": "Postman work item type", diff --git a/api-reference/issue-types/types/update-issue-types.mdx b/api-reference/issue-types/types/update-issue-types.mdx index 4025d6d..2022477 100644 --- a/api-reference/issue-types/types/update-issue-types.mdx +++ b/api-reference/issue-types/types/update-issue-types.mdx @@ -1,43 +1,49 @@ --- -title: Update work item type -description: Updates the details of a work item type -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/work-item-types/{work_item_type_id}/ +title: Update a work item type +description: Updates an existing work item type by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item type. + -### Body +## Body parameters Name of the work item type -Description of the work item type +Description of the work item type. -Logo properties for the work item type +Logo properties for the work item type. -Whether this work item type is an epic +Whether this work item type is an epic. -Whether this is the default work item type +Whether this is the default work item type. -Whether this work item type is active +Whether this work item type is active. -Level of the work item type +Hierarchical level of the work item type. diff --git a/api-reference/issue-types/values/add-property-values.mdx b/api-reference/issue-types/values/add-property-values.mdx index 725e4d0..de2af0a 100644 --- a/api-reference/issue-types/values/add-property-values.mdx +++ b/api-reference/issue-types/values/add-property-values.mdx @@ -1,18 +1,27 @@ --- -title: Add property values +title: Add custom property values description: Allows you to specify the values for a custom property. -api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issues/{issue_id}/issue-properties/{property_id}/values/ +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/ --- -### Path parameters +## Path parameters - - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + + + +The unique identifier for the work item. + + +The unique identifier for the custom property. -### Body +## Body parameters - + diff --git a/api-reference/issue-types/values/list-property-values.mdx b/api-reference/issue-types/values/list-property-values.mdx index a063130..11282a2 100644 --- a/api-reference/issue-types/values/list-property-values.mdx +++ b/api-reference/issue-types/values/list-property-values.mdx @@ -1,12 +1,21 @@ --- -title: List property values -description: Fetches the values of the custom property. -api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issues/{issue_id}/issue-properties/{property_id}/values/ +title: List all custom property values +description: Returns a list of all values for a custom property on a work item. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/ --- -### Path parameters +## Path parameters - - - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +The unique identifier of the project. + + + +The unique identifier for the work item. + + +The unique identifier for the custom property. diff --git a/api-reference/issue-types/values/overview.mdx b/api-reference/issue-types/values/overview.mdx index ebc581d..373f5f3 100644 --- a/api-reference/issue-types/values/overview.mdx +++ b/api-reference/issue-types/values/overview.mdx @@ -1,14 +1,21 @@ --- title: Overview -description: Provides a set of endpoints for adding, modifying, and deleting values within the Number custom property types. --- +Custom property values store the actual data entered into custom properties for specific work items. -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-properties/:property_id/values/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/issue-properties/:property_id/values/ -``` + +**Deprecation notice** + +We are deprecating all `/api/v1/.../issues/` endpoints in favor of `/api/v1/.../work-items/`. + +**End of support** +31st March 2026 + +**What you need to do** +To ensure uninterrupted service, replace all `/issues/` references with `/work-items/` in your codebase before the support end date. + -### Issue Property Values Object +## The Values object - `workspace` _uuid_ @@ -32,7 +39,7 @@ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ -```json JSON +```json THE VALUES OBJECT { "id": "51a869d1-f612-4315-ac91-ffef3e96c20e", "created_at": "2024-10-23T07:44:42.883820Z", diff --git a/api-reference/issue/add-issue.mdx b/api-reference/issue/add-issue.mdx index 96efb4f..36f4c8f 100644 --- a/api-reference/issue/add-issue.mdx +++ b/api-reference/issue/add-issue.mdx @@ -1,61 +1,66 @@ --- -title: Add work item -description: Adds a work item to a project -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/ +title: Create a work item +description: Creates a new work item in a project. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + -### Body +## Body parameters -Name of the work item +Name of the work item. -HTML description of the work item +HTML-formatted description of the work item. -UUID of the state for the work item +ID of the state for the work item. -Array of user UUIDs assigned to the work item +Array of user IDs to assign to the work item. + + + +Priority level. Possible values: `none`, `urgent`, `high`, `medium`, `low`. -Array of label UUIDs for the work item +Array of label IDs to apply to the work item. -UUID of the parent work item +ID of the parent work item. -Estimate point for the work item (value between 0-7) +Estimate points for the work item (0-7). -UUID of the work item type +ID of the work item type. -UUID of the module the work item belongs to - - - -Target date of the work item in YYYY-MM-DD format +ID of the module the work item belongs to. -Start date of the work item in YYYY-MM-DD format +Start date in YYYY-MM-DD format. - -Priority of the work item. Can be: none, urgent, high, medium, low + +Target completion date in YYYY-MM-DD format. + diff --git a/api-reference/issue/delete-issue.mdx b/api-reference/issue/delete-issue.mdx index 376861c..1b89464 100644 --- a/api-reference/issue/delete-issue.mdx +++ b/api-reference/issue/delete-issue.mdx @@ -1,13 +1,19 @@ --- -title: Delete work item -description: Deletes a work item in a project -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/ +title: Delete a work item +description: Permanently deletes a work item from a project. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + diff --git a/api-reference/issue/get-issue-detail.mdx b/api-reference/issue/get-issue-detail.mdx index b67dfcf..a3413c4 100644 --- a/api-reference/issue/get-issue-detail.mdx +++ b/api-reference/issue/get-issue-detail.mdx @@ -1,19 +1,25 @@ --- -title: Get work item by UUID -description: Gets the details of a work item using the UUID -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/ +title: Retrieve a work item by ID +description: Retrieves the details of an existing work item by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + -### Query parameters +## Query parameters -Comma-separated list of fields to expand. Can include: type, module, labels, assignees, state, project +Comma-separated list of fields to expand. Possible values: `type`, `module`, `labels`, `assignees`, `state`, `project`. diff --git a/api-reference/issue/get-issue-sequence-id.mdx b/api-reference/issue/get-issue-sequence-id.mdx index d677c8f..5e40a02 100644 --- a/api-reference/issue/get-issue-sequence-id.mdx +++ b/api-reference/issue/get-issue-sequence-id.mdx @@ -1,19 +1,21 @@ --- -title: Get work item by identifier -description: Gets the details of a work item using the identifier (e.g., PROJ-123) -api: GET /api/v1/workspaces/{workspace-slug}/issues/{identifier}/ +title: Retrieve a work item by identifier +description: Retrieves the details of a work item using its readable identifier (e.g., PROJ-123). +api: GET /api/v1/workspaces/{workspace_slug}/work-items/{identifier}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -Work item identifier in the format PROJECT-123 (e.g., PROJ-123) +Work item identifier in the format PROJECT-123 (e.g., ENG-123) -### Query parameters +## Query parameters -Comma-separated list of fields to expand. Can include: type, module, labels, assignees, state, project +Comma-separated list of fields to expand. Possible values: `type`, `module`, `labels`, `assignees`, `state`, `project`. diff --git a/api-reference/issue/list-issues.mdx b/api-reference/issue/list-issues.mdx index a76c51b..d633efb 100644 --- a/api-reference/issue/list-issues.mdx +++ b/api-reference/issue/list-issues.mdx @@ -1,36 +1,40 @@ --- -title: List work items -description: Gets all the work items of a project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/ +title: List all work items +description: Returns a list of all work items in a project. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/ --- -### Path parameters +## Path parameters - - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + +The unique identifier of the project. + -### Query parameters +## Query parameters -Filter by project UUID +Filter by project ID. -Filter by state UUID +Filter by state ID. -Filter by assignee user UUID +Filter by assignee user ID. -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. -Comma-separated list of fields to expand. Can include: type, module, labels, assignees, state, project +Comma-separated list of fields to expand. Possible values: `type`, `module`, `labels`, `assignees`, `state`, `project`. \ No newline at end of file diff --git a/api-reference/issue/overview.mdx b/api-reference/issue/overview.mdx index 10bbec8..599b591 100644 --- a/api-reference/issue/overview.mdx +++ b/api-reference/issue/overview.mdx @@ -2,22 +2,23 @@ title: Overview --- -Inside a work item, you can add as many details as you like to get your work done. - -## APIs - -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ -GET /api/v1/workspaces/:workspace-slug/issues/:identifier/ -GET /api/v1/workspaces/:workspace-slug/issues/search/ -``` +Work items are the fundamental unit of work in Plane. They represent tasks that need to be accomplished — assignable, trackable, and actionable to-dos in your project management workflow. + +[Learn more about Work Items →](https://docs.plane.so/core-concepts/issues/overview) + + +**Deprecation notice** + +We are deprecating all `/api/v1/.../issues/` endpoints in favor of `/api/v1/.../work-items/`. + +**End of support** +31st March 2026 +**What you need to do** +To ensure uninterrupted service, replace all `/issues/` references with `/work-items/` in your codebase before the support end date. + -### Work Item Object +## The Work Item object **Attributes** @@ -129,7 +130,7 @@ The following fields can be expanded when retrieving a work item by including th - `project` - Expands to full Project object -```json JSON +```json WORK ITEM OBJECT { "id": "e1c25c66-5bb8-465e-a818-92a483423443", "created_at": "2023-11-19T11:56:55.176802Z", diff --git a/api-reference/issue/search-issues.mdx b/api-reference/issue/search-issues.mdx index 29a270a..6e5edf9 100644 --- a/api-reference/issue/search-issues.mdx +++ b/api-reference/issue/search-issues.mdx @@ -1,20 +1,22 @@ --- title: Search work items -description: Searches for work items across a workspace -api: GET /api/v1/workspaces/{workspace-slug}/issues/search/ +description: Searches for work items across a workspace by text query. +api: GET /api/v1/workspaces/{workspace_slug}/work-items/search/ --- ### Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + ### Query parameters -Search query string +Text query to search for in work item names and descriptions. -Filter by project UUID +Filter results to a specific project by ID. diff --git a/api-reference/issue/update-issue-detail.mdx b/api-reference/issue/update-issue-detail.mdx index 0c7983b..2bf90b6 100644 --- a/api-reference/issue/update-issue-detail.mdx +++ b/api-reference/issue/update-issue-detail.mdx @@ -1,63 +1,69 @@ --- -title: Update work item details -description: Updates the details of a work item -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/ +title: Update a work item +description: Updates an existing work item by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + -### Body +## Body parameters -Name of the work item +Name of the work item. -HTML description of the work item +HTML-formatted description of the work item. -UUID of the state for the work item +ID of the state for the work item. + + + +Priority level. Possible values: `none`, `urgent`, `high`, `medium`, `low`. -Array of user UUIDs assigned to the work item +Array of user IDs to assign to the work item. -Array of label UUIDs for the work item +Array of label IDs to apply to the work item. -UUID of the parent work item +ID of the parent work item. -Estimate point for the work item (value between 0-7) +Estimate points for the work item (0-7). -UUID of the work item type +ID of the work item type. -UUID of the module the work item belongs to - - - -Target date of the work item in YYYY-MM-DD format +ID of the module the work item belongs to. -Start date of the work item in YYYY-MM-DD format +Start date in YYYY-MM-DD format. - -Priority of the work item. Can be: none, urgent, high, medium, low - \ No newline at end of file + +Target completion date in YYYY-MM-DD format. + diff --git a/api-reference/label/add-label.mdx b/api-reference/label/add-label.mdx index ab53484..5da3e5e 100644 --- a/api-reference/label/add-label.mdx +++ b/api-reference/label/add-label.mdx @@ -1,15 +1,21 @@ --- -title: Add label -description: Adds a label in the current project -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/labels/ +title: Create a label +description: Creates a new label in a project. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + -### Body +## Body parameters - + +Name of the label. + diff --git a/api-reference/label/delete-label.mdx b/api-reference/label/delete-label.mdx index cac4ed3..52d238e 100644 --- a/api-reference/label/delete-label.mdx +++ b/api-reference/label/delete-label.mdx @@ -1,13 +1,19 @@ --- -title: Delete label -description: Deletes a label in the current project -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/labels/{label_id} +title: Delete a label +description: Permanently deletes a label from a project. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/{label_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the label. + diff --git a/api-reference/label/get-label-detail.mdx b/api-reference/label/get-label-detail.mdx index 7e6521e..47d86b3 100644 --- a/api-reference/label/get-label-detail.mdx +++ b/api-reference/label/get-label-detail.mdx @@ -1,13 +1,19 @@ --- -title: Get label details -description: Gets the details of a label -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/labels/{label_id} +title: Retrieve a label +description: Retrieves the details of an existing label by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/{label_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the label. + diff --git a/api-reference/label/list-labels.mdx b/api-reference/label/list-labels.mdx index c074949..0d1c14d 100644 --- a/api-reference/label/list-labels.mdx +++ b/api-reference/label/list-labels.mdx @@ -1,11 +1,15 @@ --- -title: List labels -description: Gets all the labels in project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/labels/ +title: List all labels +description: Returns a list of all labels in a project. Labels are returned in sort order. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/ --- ### Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + diff --git a/api-reference/label/overview.mdx b/api-reference/label/overview.mdx index c38f8b3..d3aa3e1 100644 --- a/api-reference/label/overview.mdx +++ b/api-reference/label/overview.mdx @@ -1,17 +1,12 @@ --- title: Overview -description: Labels are tags that can be assigned to --- -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/labels/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/labels/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/labels/:label_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/labels/:label_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/labels/:label_id/ -``` +Labels are tags that help you categorize and organize work items in your project. + +[Learn more about Labels →](https://docs.plane.so/core-concepts/work-items/labels) -### Label Object +## The Label object - `name` _string_ **(required)** @@ -50,7 +45,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/labels/:label_id/ Parent of the label which is also a Label -```json JSON +```json THE LABEL OBJECT { "id": "c7146baf-7058-496b-aa3a-df6c25a7e929", "created_at": "2023-11-20T06:01:03.538675Z", diff --git a/api-reference/label/update-label-detail.mdx b/api-reference/label/update-label-detail.mdx index bdc1ba9..ea67357 100644 --- a/api-reference/label/update-label-detail.mdx +++ b/api-reference/label/update-label-detail.mdx @@ -1,17 +1,25 @@ --- -title: Update label details -description: Updates the details of a label -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/labels/{label_id} +title: Update a label +description: Updates an existing label by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/{label_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the label. + -### Body +## Body parameters - + +Name of the label. + diff --git a/api-reference/link/add-link.mdx b/api-reference/link/add-link.mdx index 60ffb65..30a4bbb 100644 --- a/api-reference/link/add-link.mdx +++ b/api-reference/link/add-link.mdx @@ -1,19 +1,29 @@ --- -title: Add link -description: Adds a link in an issue -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/links/ +title: Create a link +description: Creates a new link attached to a work item. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + -### Body +## Body parameters - + +Title or description of the link. + - + +URL of the external resource. + diff --git a/api-reference/link/delete-link.mdx b/api-reference/link/delete-link.mdx index 33222bb..f3a1025 100644 --- a/api-reference/link/delete-link.mdx +++ b/api-reference/link/delete-link.mdx @@ -1,15 +1,23 @@ --- -title: Delete link -description: Deletes a link in an issue -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/links/{link_id} +title: Delete a link +description: Permanently deletes a link from a work item. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/{link_id} --- ### Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + - \ No newline at end of file + +The unique identifier for the link. + \ No newline at end of file diff --git a/api-reference/link/get-link-detail.mdx b/api-reference/link/get-link-detail.mdx index ddfc781..9890575 100644 --- a/api-reference/link/get-link-detail.mdx +++ b/api-reference/link/get-link-detail.mdx @@ -1,15 +1,23 @@ --- -title: Get link details -description: Gets the details of a link -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/links/{link_id} +title: Retrieve a link +description: Retrieves the details of an existing link by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/{link_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + - + +The unique identifier for the link. + diff --git a/api-reference/link/list-links.mdx b/api-reference/link/list-links.mdx index 735c86a..302b7be 100644 --- a/api-reference/link/list-links.mdx +++ b/api-reference/link/list-links.mdx @@ -1,13 +1,19 @@ --- -title: List links -description: Gets all the links in an issue -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/links/ +title: List all links +description: Returns a list of all links attached to a work item. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + diff --git a/api-reference/link/overview.mdx b/api-reference/link/overview.mdx index 7b7defc..1bbdfbf 100644 --- a/api-reference/link/overview.mdx +++ b/api-reference/link/overview.mdx @@ -1,17 +1,12 @@ --- title: Overview -description: Links can be added to an issue to point to some external resources --- -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/links/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/links/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/links/:link_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/links/:link_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/links/:link_id/ -``` +Links attach external resources to work items, allowing you to reference documentation, designs, or other relevant URLs. -### Link object +[Learn more about Links →](https://docs.plane.so/core-concepts/work-items/overview#add-links-and-attachments) + +## The Link object - `title` _string_ @@ -46,7 +41,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/ The issue which the link is attached to -```json JSON +```json THE LINK OBJECT { "id": "662dd6b2-2b01-4315-955f-480eb51baa14", "created_at": "2023-11-20T06:23:10.270664Z", diff --git a/api-reference/link/update-link-detail.mdx b/api-reference/link/update-link-detail.mdx index 4ceeecf..d60f848 100644 --- a/api-reference/link/update-link-detail.mdx +++ b/api-reference/link/update-link-detail.mdx @@ -1,21 +1,33 @@ --- -title: Update link details -description: Updates the details of a link -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}/links/{link_id} +title: Update a link +description: Updates an existing link by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/{link_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the work item. + - + +The unique identifier for the link. + -### Body +## Body parameters - + +Title or description of the link. + - + +URL of the external resource. + diff --git a/api-reference/members/get-project-members.mdx b/api-reference/members/get-project-members.mdx index b36d671..811163d 100644 --- a/api-reference/members/get-project-members.mdx +++ b/api-reference/members/get-project-members.mdx @@ -1,19 +1,18 @@ --- -title: Get project members -sidebarTitle: Project members -description: Retrieve the list of all members in a project. -api: GET /api/v1/workspaces/:workspace-slug/projects/:project_id/members/ +title: List all project members +description: Returns a list of all members in a project. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/members/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. The unique identifier of the project -### Response +## Response ```json [ diff --git a/api-reference/members/get-workspace-members.mdx b/api-reference/members/get-workspace-members.mdx index 4c39b39..567cdff 100644 --- a/api-reference/members/get-workspace-members.mdx +++ b/api-reference/members/get-workspace-members.mdx @@ -1,18 +1,16 @@ --- -title: Get workspace members -sidebarTitle: Workspace members -description: Retrieve the list of all members in a workspace. -api: GET /api/v1/workspaces/:workspace-slug/members/ +title: Get all workspace members +description: Returns a list of all members in a workspace. +api: GET /api/v1/workspaces/{workspace_slug}/members/ --- -### Path parameters - - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. +## Path parameters + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. -### Response +## Response ```json [ diff --git a/api-reference/members/overview.mdx b/api-reference/members/overview.mdx index abad097..21b05fc 100644 --- a/api-reference/members/overview.mdx +++ b/api-reference/members/overview.mdx @@ -1,14 +1,11 @@ --- title: Overview -description: APIs to retrieve members of a workspace and the individual projects within it. --- +Members represent users who belong to a workspace or project. The Members API allows you to retrieve information about workspace and project members. -```http -GET /api/v1/workspaces/:workspace-slug/members/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/members/ -``` +[Learn more about Members →](https://docs.plane.so/core-concepts/workspaces/members) -## Member object +## The Members object **Attributes** * `id` _string_ @@ -37,7 +34,7 @@ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/members/ -```json JSON +```json MEMBERS OBJECT { "id": "00000000-0000-0000-0000-000000000001", "first_name": "User", diff --git a/api-reference/module/add-module-work-items.mdx b/api-reference/module/add-module-work-items.mdx index 9b22d72..28547e3 100644 --- a/api-reference/module/add-module-work-items.mdx +++ b/api-reference/module/add-module-work-items.mdx @@ -1,20 +1,22 @@ --- -title: Add module work items -description: Adds work items (issues) to a module -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/module-issues/ +title: Add work items to module +description: Adds one or more work items to a module. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/module-issues/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the module. -### Body +## Body parameters -List of work item (issue) IDs to add to the module +Array of work item IDs to add to the module. diff --git a/api-reference/module/add-module.mdx b/api-reference/module/add-module.mdx index 94f502c..f147789 100644 --- a/api-reference/module/add-module.mdx +++ b/api-reference/module/add-module.mdx @@ -1,49 +1,51 @@ --- -title: Add module -description: Adds a module in a project -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/ +title: Create a module +description: Creates a new module in a project. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. -### Body +## Body parameters -Name of the module +Name of the module. -Description of the module +Description of the module. -Start date of the module in YYYY-MM-DD format +Start date of the module in YYYY-MM-DD format. -Target date of the module in YYYY-MM-DD format +Target date of the module in YYYY-MM-DD format. -Status of the module. Can be: backlog, planned, in-progress, paused, completed, cancelled +Status of the module. Possible values: `backlog`, `planned`, `in-progress`, `paused`, `completed`, `cancelled`. -User ID of the module lead +ID of the user who leads the module. -List of member user IDs assigned to the module +Array of member user IDs to assign to the module. -External source identifier +External source identifier. -External ID from the external source +External ID from the external source. diff --git a/api-reference/module/archive-module.mdx b/api-reference/module/archive-module.mdx index 08936e2..6ec18a1 100644 --- a/api-reference/module/archive-module.mdx +++ b/api-reference/module/archive-module.mdx @@ -1,14 +1,16 @@ --- -title: Archive module -description: Archives a module -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/archive/ +title: Archive a module +description: Archives a module, while preserving its data. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/archive/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the module. diff --git a/api-reference/module/delete-module.mdx b/api-reference/module/delete-module.mdx index b46d5a4..ce8867a 100644 --- a/api-reference/module/delete-module.mdx +++ b/api-reference/module/delete-module.mdx @@ -1,13 +1,15 @@ --- -title: Delete module -description: Deletes a module -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/ +title: Delete a module +description: Permanently deletes a module from a project. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the module. diff --git a/api-reference/module/get-module-detail.mdx b/api-reference/module/get-module-detail.mdx index ede72ed..7036773 100644 --- a/api-reference/module/get-module-detail.mdx +++ b/api-reference/module/get-module-detail.mdx @@ -1,13 +1,15 @@ --- -title: Get module details -description: Gets the details of a module -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/ +title: Retrieve a module +description: Retrieves the details of an existing module by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/ --- ### Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the module. \ No newline at end of file diff --git a/api-reference/module/list-archived-modules.mdx b/api-reference/module/list-archived-modules.mdx index 5c1b546..7a791d9 100644 --- a/api-reference/module/list-archived-modules.mdx +++ b/api-reference/module/list-archived-modules.mdx @@ -1,12 +1,14 @@ --- -title: List archived modules -description: Gets all the archived modules in a project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/archived/ +title: List all archived modules +description: Returns a list of all archived modules in a project. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/archived/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. diff --git a/api-reference/module/list-module-work-items.mdx b/api-reference/module/list-module-work-items.mdx index b8ec9ae..62f0779 100644 --- a/api-reference/module/list-module-work-items.mdx +++ b/api-reference/module/list-module-work-items.mdx @@ -1,14 +1,15 @@ --- -title: List module work items -description: Gets all the work items (issues) in a module -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/module-issues/ +title: List all work items in a module +description: Returns a list of all work items in a module. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/module-issues/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - - - +The unique identifier of the project. +The unique identifier for the module. diff --git a/api-reference/module/list-modules.mdx b/api-reference/module/list-modules.mdx index b8f9416..c260492 100644 --- a/api-reference/module/list-modules.mdx +++ b/api-reference/module/list-modules.mdx @@ -1,11 +1,13 @@ --- -title: List modules -description: Gets all the modules in a project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/ +title: List all modules +description: Returns a list of all modules in a project. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. diff --git a/api-reference/module/overview.mdx b/api-reference/module/overview.mdx index c16fd65..33dea41 100644 --- a/api-reference/module/overview.mdx +++ b/api-reference/module/overview.mdx @@ -4,23 +4,9 @@ title: Overview Modules are smaller, focused projects that help you group and organize issues within a specific time frame. They allow you to break down your work into manageable chunks and track progress towards specific goals or objectives. -## APIs - -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/archived/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/archive/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/unarchive/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_id/module-issues/:issue_id/ -``` +[Learn more about Modules →](https://docs.plane.so/core-concepts/modules) -### Module Object +## The Module object **Attributes** @@ -106,7 +92,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/modules/:module_i Description in plain text format -```json JSON +```json MODULE OBJECT { "id": "b69b19ae-261f-428c-899f-dd58efaa36c0", "created_at": "2023-11-19T11:48:21.130161Z", diff --git a/api-reference/module/remove-module-work-item.mdx b/api-reference/module/remove-module-work-item.mdx index 6fd3d63..2bdac40 100644 --- a/api-reference/module/remove-module-work-item.mdx +++ b/api-reference/module/remove-module-work-item.mdx @@ -1,16 +1,18 @@ --- -title: Remove module work item -description: Removes a work item (issue) from a module -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/module-issues/{issue_id}/ +title: Remove work item from module +description: Removes a work item from a module. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/module-issues/{issue_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the module. - +The unique identifier for the work item. diff --git a/api-reference/module/unarchive-module.mdx b/api-reference/module/unarchive-module.mdx index e7434e8..523e65e 100644 --- a/api-reference/module/unarchive-module.mdx +++ b/api-reference/module/unarchive-module.mdx @@ -1,14 +1,15 @@ --- -title: Unarchive module -description: Unarchives a module -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/unarchive/ +title: Restore a module +description: Restores an archived module back to the modules list. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/unarchive/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - - - +The unique identifier of the project. +The unique identifier for the module. diff --git a/api-reference/module/update-module-detail.mdx b/api-reference/module/update-module-detail.mdx index 3d784ce..f74d7d4 100644 --- a/api-reference/module/update-module-detail.mdx +++ b/api-reference/module/update-module-detail.mdx @@ -1,51 +1,53 @@ --- title: Update module details description: Updates the details of a module -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/modules/{module_id}/ +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +The unique identifier of the project. - +The unique identifier for the module. -### Body +## Body parameters -Name of the module +Name of the module. -Description of the module +Description of the module. -Start date of the module in YYYY-MM-DD format +Start date of the module in YYYY-MM-DD format. -Target date of the module in YYYY-MM-DD format +Target date of the module in YYYY-MM-DD format. -Status of the module. Can be: backlog, planned, in-progress, paused, completed, cancelled +Current status of the module. Possible values: `backlog`, `planned`, `in-progress`, `paused`, `completed`, `cancelled`. -User ID of the module lead +ID of the user who leads the module. -List of member user IDs assigned to the module +Array of member user IDs assigned to the module. -External source identifier +External source identifier. -External ID from the external source +External ID from the external source. \ No newline at end of file diff --git a/api-reference/page/add-project-page.mdx b/api-reference/page/add-project-page.mdx index 30a754b..18930bc 100644 --- a/api-reference/page/add-project-page.mdx +++ b/api-reference/page/add-project-page.mdx @@ -1,22 +1,26 @@ --- -title: Add project page -description: Creates a new page at the project level -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/pages/ +title: Create a project page +description: Creates a new page at the project level, specific to a single project. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/pages/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the project. + -### Body +## Body parameters -Name of the page +Name of the page. -HTML description/content of the page +HTML-formatted content of the page. diff --git a/api-reference/page/add-workspace-page.mdx b/api-reference/page/add-workspace-page.mdx index 94e91d6..d335527 100644 --- a/api-reference/page/add-workspace-page.mdx +++ b/api-reference/page/add-workspace-page.mdx @@ -1,20 +1,22 @@ --- -title: Add workspace page -description: Creates a new page at the workspace level -api: POST /api/v1/workspaces/{workspace-slug}/pages/ +title: Create a wiki page +description: Creates a new page at the workspace level. +api: POST /api/v1/workspaces/{workspace_slug}/pages/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body +## Body parameters -Name of the page +Name of the page. -HTML description/content of the page +HTML-formatted content of the page. diff --git a/api-reference/page/get-project-page.mdx b/api-reference/page/get-project-page.mdx index 9bcfd72..d8a035d 100644 --- a/api-reference/page/get-project-page.mdx +++ b/api-reference/page/get-project-page.mdx @@ -1,14 +1,20 @@ --- -title: Get project page -description: Gets the details of a project page by ID -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/pages/{page_id}/ +title: Retrieve a project page +description: Retrieves the details of an existing project page by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/pages/{page_id}/ --- ### Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the project. + - + +The unique identifier for the page. + diff --git a/api-reference/page/get-workspace-page.mdx b/api-reference/page/get-workspace-page.mdx index 14ec9d7..90a8a22 100644 --- a/api-reference/page/get-workspace-page.mdx +++ b/api-reference/page/get-workspace-page.mdx @@ -1,12 +1,16 @@ --- -title: Get workspace page -description: Gets the details of a workspace page by ID -api: GET /api/v1/workspaces/{workspace-slug}/pages/{page_id}/ +title: Retrieve a wiki page +description: Retrieves the details of an existing workspace page by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/pages/{page_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the page. + diff --git a/api-reference/page/overview.mdx b/api-reference/page/overview.mdx index 21885ac..388d303 100644 --- a/api-reference/page/overview.mdx +++ b/api-reference/page/overview.mdx @@ -2,25 +2,11 @@ title: Overview --- -Pages allow you to create and manage documentation pages at both workspace and project levels. Workspace pages are accessible across all projects in a workspace, while project pages are specific to a particular project. +Pages allow you to create and manage documentation at both workspace and project levels. Workspace pages are accessible across all projects, while project pages are specific to individual projects. -## APIs +**Documentation**: [Wiki](https://docs.plane.so/core-concepts/pages/wiki), [Pages](https://docs.plane.so/core-concepts/pages/overview) -### Workspace Pages - -```http -POST /api/v1/workspaces/:workspace-slug/pages/ -GET /api/v1/workspaces/:workspace-slug/pages/:page_id/ -``` - -### Project Pages - -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/pages/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/pages/:page_id/ -``` - -### Page Object +## The Pages object **Attributes** @@ -53,7 +39,7 @@ GET /api/v1/workspaces/:workspace-slug/projects/:project_id/pages/:page_id/ ID of the user who last updated the page -```json JSON +```json PAGES OBJECT { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "created_at": "2023-11-19T11:56:55.176802Z", diff --git a/api-reference/project/add-project.mdx b/api-reference/project/add-project.mdx index 76ea167..715060a 100644 --- a/api-reference/project/add-project.mdx +++ b/api-reference/project/add-project.mdx @@ -1,15 +1,23 @@ --- -title: Add project -description: Projects let you manage teams and tasks within your Workspace. -api: POST /api/v1/workspaces/{workspace-slug}/projects/ +title: Create a project +description: Creates a new project in a workspace. +api: POST /api/v1/workspaces/{workspace_slug}/projects/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - +## Body parameters - + +Name of the project. + - + +Short identifier used in work item IDs. + + +Description of the project. diff --git a/api-reference/project/delete-project.mdx b/api-reference/project/delete-project.mdx index ef6b435..65ab55e 100644 --- a/api-reference/project/delete-project.mdx +++ b/api-reference/project/delete-project.mdx @@ -1,11 +1,15 @@ --- -title: Delete project -description: Projects let you manage teams and tasks within your Workspace. -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id} +title: Delete a project +description: Permanently deletes a project and all its associated data. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project + diff --git a/api-reference/project/get-project-detail.mdx b/api-reference/project/get-project-detail.mdx index 14f1b36..987d56e 100644 --- a/api-reference/project/get-project-detail.mdx +++ b/api-reference/project/get-project-detail.mdx @@ -1,11 +1,15 @@ --- -title: Get project details -description: Projects let you manage teams and tasks within your Workspace. -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/ +title: Retrieve a project +description: Retrieves the details of an existing project +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project + diff --git a/api-reference/project/list-projects.mdx b/api-reference/project/list-projects.mdx index 6a9399d..a7faf97 100644 --- a/api-reference/project/list-projects.mdx +++ b/api-reference/project/list-projects.mdx @@ -1,9 +1,11 @@ --- -title: List projects -description: Gets all the projects in a workspace. -api: GET /api/v1/workspaces/{workspace-slug}/projects/ +title: List all projects +description: Returns a list of all projects in a workspace. Projects are returned in order of creation, with the most recently created projects appearing first. +api: GET /api/v1/workspaces/{workspace_slug}/projects/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + diff --git a/api-reference/project/overview.mdx b/api-reference/project/overview.mdx index 529cfd5..0d81e6b 100644 --- a/api-reference/project/overview.mdx +++ b/api-reference/project/overview.mdx @@ -1,26 +1,13 @@ --- title: Overview -description: Projects let you manage teams and tasks within your Workspace. --- -**Endpoints** +Projects organize your team's work within a workspace. Each project contains work items, cycles, modules, and other resources. -```http -POST /api/v1/workspaces/:workspace-slug/projects/ -GET /api/v1/workspaces/:workspace-slug/projects/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/ -``` - -The `workspace-slug` represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL: +[Learn more about Projects →](https://docs.plane.so/core-concepts/projects/overview) -``` -https://app.plane.so/my-team/projects/ -``` -The workspace slug is `my-team`. -### Project Object +### The Project object **Attributes** @@ -139,11 +126,9 @@ The workspace slug is `my-team`. Default state which will be used when the issues will be auto closed -**Response Object** - -```json JSON +```json THE PROJECT OBJECT { "id": "00918ea1-52f7-48bd-abe3-d3efe76ff7dd", "total_members": 1, diff --git a/api-reference/project/update-project-detail.mdx b/api-reference/project/update-project-detail.mdx index 9d3b2ee..883d1bb 100644 --- a/api-reference/project/update-project-detail.mdx +++ b/api-reference/project/update-project-detail.mdx @@ -1,17 +1,25 @@ --- -title: Update project details -description: Projects let you manage teams and tasks within your Workspace. -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id} +title: Update a project +description: Updates an existing project by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id} --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - +## Body parameters -### Body + +Name of the project. + - + +Description of the project. + diff --git a/api-reference/state/add-state.mdx b/api-reference/state/add-state.mdx index 9e6f4b4..e09db1d 100644 --- a/api-reference/state/add-state.mdx +++ b/api-reference/state/add-state.mdx @@ -1,17 +1,21 @@ --- -title: Add state -description: Add a state to the project -api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/states/ +title: Create a state +description: Creates a new state in a project. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + -### Body +### Body parameters - +Name of the state. - +Hex color code for the state (e.g., "#eb5757"). diff --git a/api-reference/state/delete-state.mdx b/api-reference/state/delete-state.mdx index 597fc32..9b6510d 100644 --- a/api-reference/state/delete-state.mdx +++ b/api-reference/state/delete-state.mdx @@ -1,13 +1,19 @@ --- -title: Delete state -description: Deletes a state in a project -api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/states/{state_id}/ +title: Delete a state +description: Permanently deletes a state from a project. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/{state_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the state. + diff --git a/api-reference/state/get-state-detail.mdx b/api-reference/state/get-state-detail.mdx index 0514b13..18c4586 100644 --- a/api-reference/state/get-state-detail.mdx +++ b/api-reference/state/get-state-detail.mdx @@ -1,13 +1,19 @@ --- -title: Get state details -description: Gets the details of a state -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/states/{state_id}/ +title: Retrieve a state +description: Retrieves the details of an existing state by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/{state_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the state. + diff --git a/api-reference/state/list-states.mdx b/api-reference/state/list-states.mdx index 3881289..8db4e5f 100644 --- a/api-reference/state/list-states.mdx +++ b/api-reference/state/list-states.mdx @@ -1,11 +1,15 @@ --- -title: List states -description: Gets all the states in a project -api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/states/ +title: List all states +description: Returns a list of all states in a project. States are returned in sequence order within their state groups. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + diff --git a/api-reference/state/overview.mdx b/api-reference/state/overview.mdx index b67c6b7..840966a 100644 --- a/api-reference/state/overview.mdx +++ b/api-reference/state/overview.mdx @@ -1,17 +1,12 @@ --- title: Overview -description: State is the current status of the issue --- -```http -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/states/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/states/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/states/:state_id/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/states/:state_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/states/:state_id/ -``` +States represent the current status of a work item in your project workflow. + +[Learn more about States →](https://docs.plane.so/core-concepts/work-items/states) -## State Object +## The State object **Attributes** @@ -31,7 +26,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/states/:state_id/ String code of the color -- `workspace-slug` _string_ +- `workspace_slug` _string_ Slugified name of the state auto generated from the system @@ -66,7 +61,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/states/:state_id/ The workspace which the issue is part of auto generated from backend -```json JSON +```json THE STATE OBJECT { "id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f", "created_at": "2023-11-19T17:41:45.478363Z", @@ -74,7 +69,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/states/:state_id/ "name": "Ideation", "description": "", "color": "#eb5757", - "workspace-slug": "ideation", + "workspace_slug": "ideation", "sequence": 130000.0, "group": "unstarted", "default": false, diff --git a/api-reference/state/update-state-detail.mdx b/api-reference/state/update-state-detail.mdx index 53964ba..0d7b6d7 100644 --- a/api-reference/state/update-state-detail.mdx +++ b/api-reference/state/update-state-detail.mdx @@ -1,17 +1,23 @@ --- -title: Update state details -description: Updates the details of a state -api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/states/{state_id}/ +title: Update a state +description: Updates an existing state by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/{state_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier of the project. + - + +The unique identifier for the state. + -### Body +## Body parameters - +Name of the state. diff --git a/api-reference/sticky/add-sticky.mdx b/api-reference/sticky/add-sticky.mdx index e893a12..ee9d2cf 100644 --- a/api-reference/sticky/add-sticky.mdx +++ b/api-reference/sticky/add-sticky.mdx @@ -1,32 +1,34 @@ --- -title: Add sticky -description: Creates a new sticky in a workspace -api: POST /api/v1/workspaces/{workspace-slug}/stickies/ +title: Create a sticky +description: Creates a new sticky note in a workspace. +api: POST /api/v1/workspaces/{workspace_slug}/stickies/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body +## Body parameters -Name of the sticky +Name of the sticky. -HTML description of the sticky +HTML-formatted content of the sticky. -Logo properties for the sticky +Logo properties and visual configuration. -Color of the sticky +Text color for the sticky (hex code). -Background color of the sticky +Background color for the sticky (hex code). diff --git a/api-reference/sticky/delete-sticky.mdx b/api-reference/sticky/delete-sticky.mdx index 7df37f8..05dc73f 100644 --- a/api-reference/sticky/delete-sticky.mdx +++ b/api-reference/sticky/delete-sticky.mdx @@ -1,12 +1,16 @@ --- -title: Delete sticky -description: Deletes a sticky -api: DELETE /api/v1/workspaces/{workspace-slug}/stickies/{sticky_id}/ +title: Delete a sticky +description: Permanently deletes a sticky from a workspace. This action cannot be undone. +api: DELETE /api/v1/workspaces/{workspace_slug}/stickies/{sticky_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the sticky. + diff --git a/api-reference/sticky/get-sticky-detail.mdx b/api-reference/sticky/get-sticky-detail.mdx index 53dac8d..43bfbd8 100644 --- a/api-reference/sticky/get-sticky-detail.mdx +++ b/api-reference/sticky/get-sticky-detail.mdx @@ -1,12 +1,16 @@ --- -title: Get sticky details -description: Gets the details of a sticky -api: GET /api/v1/workspaces/{workspace-slug}/stickies/{sticky_id}/ +title: Retrieve a sticky +description: Retrieves the details of an existing sticky by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/stickies/{sticky_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the sticky. + diff --git a/api-reference/sticky/list-stickies.mdx b/api-reference/sticky/list-stickies.mdx index 419439a..842824b 100644 --- a/api-reference/sticky/list-stickies.mdx +++ b/api-reference/sticky/list-stickies.mdx @@ -1,20 +1,22 @@ --- -title: List stickies -description: Gets all the stickies in a workspace -api: GET /api/v1/workspaces/{workspace-slug}/stickies/ +title: List all stickies +description: Returns a list of all stickies in a workspace. +api: GET /api/v1/workspaces/{workspace_slug}/stickies/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Query parameters +## Query parameters -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/sticky/overview.mdx b/api-reference/sticky/overview.mdx index c45cb75..b82197c 100644 --- a/api-reference/sticky/overview.mdx +++ b/api-reference/sticky/overview.mdx @@ -2,19 +2,11 @@ title: Overview --- -Stickies are workspace-level notes or reminders that can be used to capture quick thoughts, ideas, or important information. +Stickies are workspace-level notes that allow you to capture quick thoughts, ideas, or important reminders. -## APIs +[Learn more about Stickies →](https://docs.plane.so/core-concepts/stickies) -```http -POST /api/v1/workspaces/:workspace-slug/stickies/ -GET /api/v1/workspaces/:workspace-slug/stickies/ -GET /api/v1/workspaces/:workspace-slug/stickies/:sticky_id/ -PATCH /api/v1/workspaces/:workspace-slug/stickies/:sticky_id/ -DELETE /api/v1/workspaces/:workspace-slug/stickies/:sticky_id/ -``` - -### Sticky Object +## The Sticky object **Attributes** @@ -83,7 +75,7 @@ DELETE /api/v1/workspaces/:workspace-slug/stickies/:sticky_id/ ID of the user who last updated the sticky -```json JSON +```json STICKIES OBJECT { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "created_at": "2023-11-19T11:56:55.176802Z", diff --git a/api-reference/sticky/update-sticky-detail.mdx b/api-reference/sticky/update-sticky-detail.mdx index be78dbd..05946c5 100644 --- a/api-reference/sticky/update-sticky-detail.mdx +++ b/api-reference/sticky/update-sticky-detail.mdx @@ -1,34 +1,38 @@ --- -title: Update sticky details -description: Updates the details of a sticky -api: PATCH /api/v1/workspaces/{workspace-slug}/stickies/{sticky_id}/ +title: Update a sticky +description: Updates an existing sticky by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/stickies/{sticky_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the sticky. + -### Body +## Body parameters -Name of the sticky +Name of the sticky. -HTML description of the sticky +HTML-formatted content of the sticky. -Logo properties for the sticky +Logo properties and visual configuration. -Color of the sticky +Text color for the sticky (hex code). -Background color of the sticky +Background color for the sticky (hex code). diff --git a/api-reference/teamspace/add-projects-to-teamspace.mdx b/api-reference/teamspace/add-projects-to-teamspace.mdx index 0c139d8..dc482b3 100644 --- a/api-reference/teamspace/add-projects-to-teamspace.mdx +++ b/api-reference/teamspace/add-projects-to-teamspace.mdx @@ -1,12 +1,12 @@ --- title: Add projects to teamspace description: Adds projects to a teamspace -api: POST /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/projects/ +api: POST /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/projects/ --- ### Path parameters - + diff --git a/api-reference/teamspace/add-teamspace-members.mdx b/api-reference/teamspace/add-teamspace-members.mdx index 08bb982..785ffe6 100644 --- a/api-reference/teamspace/add-teamspace-members.mdx +++ b/api-reference/teamspace/add-teamspace-members.mdx @@ -1,18 +1,22 @@ --- title: Add members to teamspace description: Adds members to a teamspace -api: POST /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/members/ +api: POST /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/members/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the teamspace. + -### Body +## Body parameters -Array of user IDs to add to the teamspace +Array of user IDs to add to the teamspace. diff --git a/api-reference/teamspace/add-teamspace.mdx b/api-reference/teamspace/add-teamspace.mdx index 25db7d8..52fd6ba 100644 --- a/api-reference/teamspace/add-teamspace.mdx +++ b/api-reference/teamspace/add-teamspace.mdx @@ -1,40 +1,42 @@ --- -title: Add teamspace -description: Creates a new teamspace in a workspace -api: POST /api/v1/workspaces/{workspace-slug}/teamspaces/ +title: Create a teamspace +description: Creates a new teamspace in a workspace. +api: POST /api/v1/workspaces/{workspace_slug}/teamspaces/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Body +## Body parameters -Name of the teamspace +Name of the teamspace. -JSON description of the teamspace +JSON representation of the teamspace description. -HTML description of the teamspace +HTML-formatted description of the teamspace. -Stripped version of the HTML description +Stripped version of the HTML description. -Binary description of the teamspace +Binary representation of the description. -Logo properties for the teamspace +Logo properties for the teamspace. -User ID of the teamspace lead +ID of the user who leads the teamspace. diff --git a/api-reference/teamspace/delete-teamspace.mdx b/api-reference/teamspace/delete-teamspace.mdx index 3392d06..1f557b8 100644 --- a/api-reference/teamspace/delete-teamspace.mdx +++ b/api-reference/teamspace/delete-teamspace.mdx @@ -1,12 +1,16 @@ --- -title: Delete teamspace +title: Delete a teamspace description: Deletes a teamspace -api: DELETE /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/ +api: DELETE /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the teamspace. + diff --git a/api-reference/teamspace/get-teamspace-detail.mdx b/api-reference/teamspace/get-teamspace-detail.mdx index c98ce55..6fd070c 100644 --- a/api-reference/teamspace/get-teamspace-detail.mdx +++ b/api-reference/teamspace/get-teamspace-detail.mdx @@ -1,12 +1,16 @@ --- -title: Get teamspace details -description: Gets the details of a teamspace -api: GET /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/ +title: Retrieve a teamspace +description: Retrieves the details of an existing teamspace by its ID. +api: GET /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the teamspace. + diff --git a/api-reference/teamspace/list-teamspace-members.mdx b/api-reference/teamspace/list-teamspace-members.mdx index 128865b..bc0d66d 100644 --- a/api-reference/teamspace/list-teamspace-members.mdx +++ b/api-reference/teamspace/list-teamspace-members.mdx @@ -1,22 +1,26 @@ --- -title: List teamspace members -description: Gets all the members associated with a teamspace -api: GET /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/members/ +title: List all teamspace members +description: Returns a list of all members associated with a teamspace. +api: GET /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/members/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the teamspace. + -### Query parameters +## Query parameters -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/teamspace/list-teamspace-projects.mdx b/api-reference/teamspace/list-teamspace-projects.mdx index fd0614e..5366738 100644 --- a/api-reference/teamspace/list-teamspace-projects.mdx +++ b/api-reference/teamspace/list-teamspace-projects.mdx @@ -1,22 +1,22 @@ --- title: List teamspace projects description: Gets all the projects associated with a teamspace -api: GET /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/projects/ +api: GET /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/projects/ --- ### Path parameters - + ### Query parameters -Number of results to return +Number of results to return per page. - -Number of results to skip + +Number of results to skip for pagination. diff --git a/api-reference/teamspace/list-teamspaces.mdx b/api-reference/teamspace/list-teamspaces.mdx index c444530..36895aa 100644 --- a/api-reference/teamspace/list-teamspaces.mdx +++ b/api-reference/teamspace/list-teamspaces.mdx @@ -1,20 +1,22 @@ --- -title: List teamspaces -description: Gets all the teamspaces in a workspace -api: GET /api/v1/workspaces/{workspace-slug}/teamspaces/ +title: List all teamspaces +description: Returns a list of all teamspaces in a workspace. +api: GET /api/v1/workspaces/{workspace_slug}/teamspaces/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + -### Query parameters +## Query parameters -Number of results to return +Number of results to return per page. -Number of results to skip +Number of results to skip for pagination. diff --git a/api-reference/teamspace/overview.mdx b/api-reference/teamspace/overview.mdx index e5956b4..20803c3 100644 --- a/api-reference/teamspace/overview.mdx +++ b/api-reference/teamspace/overview.mdx @@ -2,94 +2,68 @@ title: Overview --- -Teamspaces allow you to organize teams, projects, and members within a workspace. They provide a way to group related work and manage access at a team level. +Teamspaces allow you to organize teams, projects, and members within a workspace, providing a way to group related work and manage access at a team level. -## APIs +[Learn more about Teamspaces →](https://docs.plane.so/core-concepts/workspaces/teamspaces) -### Teamspace Management - -```http -POST /api/v1/workspaces/:workspace-slug/teamspaces/ -GET /api/v1/workspaces/:workspace-slug/teamspaces/ -GET /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/ -PATCH /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/ -DELETE /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/ -``` - -### Teamspace Members - -```http -GET /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/members/ -POST /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/members/ -DELETE /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/members/ -``` - -### Teamspace Projects - -```http -GET /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/projects/ -POST /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/projects/ -DELETE /api/v1/workspaces/:workspace-slug/teamspaces/:teamspace_id/projects/ -``` - -### Teamspace Object +## The Teamspace object **Attributes** - `id` _uuid_ - Unique identifier for the teamspace + Unique identifier for the teamspace. - `name` _string_ **(required)** - Name of the teamspace + Name of the teamspace. - `description_json` _object_ - JSON description of the teamspace + JSON representation of the teamspace description. - `description_html` _string_ - HTML description of the teamspace + HTML-formatted description of the teamspace. - `description_stripped` _string_ - Stripped version of the HTML description + Stripped version of the HTML description. - `description_binary` _string_ - Binary description of the teamspace + Binary representation of the description. - `logo_props` _object_ - Logo properties for the teamspace + Logo properties for the teamspace. - `lead` _uuid_ - User ID of the teamspace lead + ID of the user who leads the teamspace. - `workspace` _uuid_ - - Workspace UUID which is automatically saved + + ID of the workspace containing the teamspace. - `created_at` _timestamp_ - The timestamp when the teamspace was created + Time at which the teamspace was created. - `updated_at` _timestamp_ - The timestamp when the teamspace was last updated + Time at which the teamspace was last updated. - `created_by` _uuid_ - ID of the user who created the teamspace + ID of the user who created the teamspace. - `updated_by` _uuid_ - ID of the user who last updated the teamspace + ID of the user who last updated the teamspace. -```json JSON +```json TEAMSPACE OBJECT { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "created_at": "2023-11-19T11:56:55.176802Z", diff --git a/api-reference/teamspace/remove-projects-from-teamspace.mdx b/api-reference/teamspace/remove-projects-from-teamspace.mdx index 640640f..8e5a706 100644 --- a/api-reference/teamspace/remove-projects-from-teamspace.mdx +++ b/api-reference/teamspace/remove-projects-from-teamspace.mdx @@ -1,18 +1,22 @@ --- title: Remove projects from teamspace -description: Removes projects from a teamspace -api: DELETE /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/projects/ +description: Removes one or more projects from a teamspace. +api: DELETE /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/projects/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the teamspace. + -### Body +## Body parameters -Array of project IDs to remove from the teamspace +Array of project IDs to remove from the teamspace. diff --git a/api-reference/teamspace/remove-teamspace-members.mdx b/api-reference/teamspace/remove-teamspace-members.mdx index be48a07..7d9660e 100644 --- a/api-reference/teamspace/remove-teamspace-members.mdx +++ b/api-reference/teamspace/remove-teamspace-members.mdx @@ -1,18 +1,22 @@ --- title: Remove members from teamspace description: Removes members from a teamspace -api: DELETE /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/members/ +api: DELETE /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/members/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the teamspace. + -### Body +## Body parameters -Array of user IDs to remove from the teamspace +Array of user IDs to remove from the teamspace. diff --git a/api-reference/teamspace/update-teamspace-detail.mdx b/api-reference/teamspace/update-teamspace-detail.mdx index 93bc922..23b3135 100644 --- a/api-reference/teamspace/update-teamspace-detail.mdx +++ b/api-reference/teamspace/update-teamspace-detail.mdx @@ -1,35 +1,39 @@ --- -title: Update teamspace details -description: Updates the details of a teamspace -api: PATCH /api/v1/workspaces/{workspace-slug}/teamspaces/{teamspace_id}/ +title: Update a teamspace +description: Updates an existing teamspace by setting the values of the parameters passed. Any parameters not provided will be left unchanged. +api: PATCH /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/ --- -### Path parameters +## Path parameters - + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + - + +The unique identifier for the teamspace. + -### Body +## Body parameters -Name of the teamspace +Name of the teamspace. -JSON description of the teamspace +JSON representation of the teamspace description. -HTML description of the teamspace +HTML-formatted description of the teamspace. -Stripped version of the HTML description +Stripped version of the HTML description. -Binary description of the teamspace +Binary representation of the description. @@ -37,6 +41,6 @@ Logo properties for the teamspace -User ID of the teamspace lead +ID of the user who leads the teamspace. diff --git a/api-reference/user/get-current-user.mdx b/api-reference/user/get-current-user.mdx index 005d24c..ed95179 100644 --- a/api-reference/user/get-current-user.mdx +++ b/api-reference/user/get-current-user.mdx @@ -1,10 +1,10 @@ --- -title: Get current user -description: Gets the information of the currently authenticated user +title: Retrieve current user +description: Retrieves information about the currently authenticated user. api: GET /api/v1/users/me/ --- -### Response +## Response -Returns the user object for the currently authenticated user based on the authentication token provided in the request. +Returns the user object for the authenticated user based on the provided authentication token. diff --git a/api-reference/user/overview.mdx b/api-reference/user/overview.mdx index 5dc09cd..8ad48e2 100644 --- a/api-reference/user/overview.mdx +++ b/api-reference/user/overview.mdx @@ -4,13 +4,7 @@ title: Overview Users represent the people who use Plane. The Users API allows you to retrieve information about the current authenticated user. -## APIs - -```http -GET /api/v1/users/me/ -``` - -### User Object +## The User object **Attributes** @@ -43,7 +37,7 @@ GET /api/v1/users/me/ Display name of the user -```json JSON +```json USER OBJECT { "id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430", "first_name": "John", diff --git a/api-reference/worklogs/create-worklog.mdx b/api-reference/worklogs/create-worklog.mdx index 9c43db8..db99ecf 100644 --- a/api-reference/worklogs/create-worklog.mdx +++ b/api-reference/worklogs/create-worklog.mdx @@ -1,25 +1,25 @@ --- -title: Create Worklog -sidebarTitle: Create Worklog -description: Add a new worklog entry for a specific issue. -api: POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/worklogs/ +title: Create a worklog +description: Creates a new worklog entry for a work item. +api: POST /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/worklogs/ --- -### Path parameters - - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. +## Path parameters + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + The unique identifier of the project -The unique identifier of the issue -### Body +The unique identifier of the work item + +## Body parameters -Description of the work done during the worklog -Time spent on the issue in minutes +Description of the work done during the worklog. +Time spent on the issue in minutes. -### Response +## Response ```json { diff --git a/api-reference/worklogs/delete-worklog.mdx b/api-reference/worklogs/delete-worklog.mdx index 9cf09e7..42cbe2e 100644 --- a/api-reference/worklogs/delete-worklog.mdx +++ b/api-reference/worklogs/delete-worklog.mdx @@ -1,16 +1,15 @@ --- -title: Delete Worklog -sidebarTitle: Delete Worklog +title: Delete a worklog description: Delete a specific worklog entry from an issue. -api: DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/worklogs/:worklog_id/ +api: DELETE /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/worklogs/{worklog_id}/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. The unique identifier of the project -The unique identifier of the issue +The unique identifier of the work item The unique identifier of the worklog \ No newline at end of file diff --git a/api-reference/worklogs/get-total-time.mdx b/api-reference/worklogs/get-total-time.mdx index f49dc90..5b4d7c0 100644 --- a/api-reference/worklogs/get-total-time.mdx +++ b/api-reference/worklogs/get-total-time.mdx @@ -1,19 +1,19 @@ --- -title: Get total time for each issue -sidebarTitle: Total logged time +title: Get total time for each work item +sidebarTitle: Get total logged time description: Aggregates the worklogs and provides the total time spent on each issue in the project. -api: GET /api/v1/workspaces/:workspace-slug/projects/:project_id/total-worklogs/ +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/total-worklogs/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. The unique identifier of the project -### Response +## Response ```json [ diff --git a/api-reference/worklogs/get-worklogs-for-issue.mdx b/api-reference/worklogs/get-worklogs-for-issue.mdx index 6655152..ae08eaa 100644 --- a/api-reference/worklogs/get-worklogs-for-issue.mdx +++ b/api-reference/worklogs/get-worklogs-for-issue.mdx @@ -1,20 +1,20 @@ --- -title: Get worklogs for a specific issue -sidebarTitle: Worklogs for an issue -description: Retrieve a list of worklogs for a specific issue. -api: GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/worklogs/ +title: List all worklogs for a work item +sidebarTitle: List all worklogs +description: Returns a list of all worklogs for a specific work item. +api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/worklogs/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. The unique identifier of the project -The unique identifier of the issue +The unique identifier of the work item -### Response +## Response ```json { diff --git a/api-reference/worklogs/overview.mdx b/api-reference/worklogs/overview.mdx index 3f0d927..4908ebc 100644 --- a/api-reference/worklogs/overview.mdx +++ b/api-reference/worklogs/overview.mdx @@ -1,17 +1,11 @@ --- title: Overview -description: Enables you to track time spent on issues within a project. Worklogs track duration in minutes and include details like description, timestamps, and user information. --- +Worklogs enable time tracking for work items within a project, recording time spent in minutes along with descriptions and user information. -```http -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/worklogs/ -GET /api/v1/workspaces/:workspace-slug/projects/:project_id/total-worklogs/ -POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/worklogs/ -PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/worklogs/:worklog_id/ -DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/worklogs/:worklog_id/ -``` +[Learn more about Time tracking →](https://docs.plane.so/core-concepts/issues/time-tracking) -## Worklogs object +## The Worklogs object **Attributes** @@ -61,7 +55,7 @@ DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id -```json JSON +```json WORKLOGS OBJECT { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "created_at": "2025-01-29T21:27:54.197306+05:30", diff --git a/api-reference/worklogs/update-worklog.mdx b/api-reference/worklogs/update-worklog.mdx index 99d381e..8f78757 100644 --- a/api-reference/worklogs/update-worklog.mdx +++ b/api-reference/worklogs/update-worklog.mdx @@ -1,26 +1,25 @@ --- -title: Update Worklog -sidebarTitle: Update Worklog +title: Update a worklog description: Update an existing worklog entry. You can change the description or duration of the worklog. -api: PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issues/:issue_id/worklogs/:worklog_id/ +api: PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/worklogs/{worklog_id}/ --- -### Path parameters +## Path parameters - -The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. The unique identifier of the project -The unique identifier of the issue +The unique identifier of the work item The unique identifier of the worklog -### Body +## Body parameters Description of the work done during the worklog Time spent on the issue in minutes -### Response +## Response ```json { diff --git a/mint.json b/mint.json index 9e695f9..347ea44 100644 --- a/mint.json +++ b/mint.json @@ -18,6 +18,9 @@ "auth": { "method": "key", "name": "x-api-key" + }, + "playground": { + "display": "interactive" } }, "topbarCtaButton": { @@ -210,99 +213,99 @@ "api-reference/issue/list-issues", "api-reference/issue/get-issue-detail", "api-reference/issue/get-issue-sequence-id", - "api-reference/issue/update-issue-detail", - "api-reference/issue/delete-issue", "api-reference/issue/search-issues", - { - "group": "Work Item activity", - "pages": [ - "api-reference/issue-activity/overview", - "api-reference/issue-activity/list-issue-activities", - "api-reference/issue-activity/get-issue-activity-detail" - ] - }, - { - "group": "Work Item comment", - "pages": [ - "api-reference/issue-comment/overview", - "api-reference/issue-comment/add-issue-comment", - "api-reference/issue-comment/list-issue-comments", - "api-reference/issue-comment/get-issue-comment-detail", - "api-reference/issue-comment/update-issue-comment-detail", - "api-reference/issue-comment/delete-issue-comment" - ] - }, - { - "group": "Work Item attachments", - "pages": [ - "api-reference/issue-attachments/overview", - "api-reference/issue-attachments/get-attachments", - "api-reference/issue-attachments/get-attachment-detail", - "api-reference/issue-attachments/get-upload-credentials", - "api-reference/issue-attachments/upload-file", - "api-reference/issue-attachments/complete-upload", - "api-reference/issue-attachments/update-attachment", - "api-reference/issue-attachments/delete-attachment" - ] - } + "api-reference/issue/update-issue-detail", + "api-reference/issue/delete-issue" ] }, { - "group": "Work Item types", + "group": "Work Item Activity", + "pages": [ + "api-reference/issue-activity/overview", + "api-reference/issue-activity/list-issue-activities", + "api-reference/issue-activity/get-issue-activity-detail" + ] + }, + { + "group": "Work Item Comments", + "pages": [ + "api-reference/issue-comment/overview", + "api-reference/issue-comment/add-issue-comment", + "api-reference/issue-comment/list-issue-comments", + "api-reference/issue-comment/get-issue-comment-detail", + "api-reference/issue-comment/update-issue-comment-detail", + "api-reference/issue-comment/delete-issue-comment" + ] + }, + { + "group": "Work Item Attachments", + "pages": [ + "api-reference/issue-attachments/overview", + "api-reference/issue-attachments/get-attachments", + "api-reference/issue-attachments/get-attachment-detail", + "api-reference/issue-attachments/get-upload-credentials", + "api-reference/issue-attachments/upload-file", + "api-reference/issue-attachments/complete-upload", + "api-reference/issue-attachments/update-attachment", + "api-reference/issue-attachments/delete-attachment" + ] + }, + { + "group": "Work Item Types", "pages": [ "api-reference/issue-types/types/overview", "api-reference/issue-types/types/add-issue-type", "api-reference/issue-types/types/list-issue-types", "api-reference/issue-types/types/get-issue-type-details", "api-reference/issue-types/types/update-issue-types", - "api-reference/issue-types/types/delete-issue-type", - { - "group": "Work Item Properties", - "pages": [ - "api-reference/issue-types/properties/overview", - "api-reference/issue-types/properties/add-property", - "api-reference/issue-types/properties/list-properties", - "api-reference/issue-types/properties/get-property-details", - "api-reference/issue-types/properties/update-property", - "api-reference/issue-types/properties/delete-property" - ] - }, - { - "group": "Work Item property options", - "pages": [ - "api-reference/issue-types/options/overview", - "api-reference/issue-types/options/add-dropdown-options", - "api-reference/issue-types/options/list-dropdown-options", - "api-reference/issue-types/options/get-option-details", - "api-reference/issue-types/options/update-dropdown-options", - "api-reference/issue-types/options/delete-dropdown-options" - ] - }, - { - "group": "Work Item property values", - "pages": [ - "api-reference/issue-types/values/overview", - "api-reference/issue-types/values/add-property-values", - "api-reference/issue-types/values/list-property-values" - ] - } + "api-reference/issue-types/types/delete-issue-type" + ] + }, + { + "group": "Custom Properties", + "pages": [ + "api-reference/issue-types/properties/overview", + "api-reference/issue-types/properties/add-property", + "api-reference/issue-types/properties/list-properties", + "api-reference/issue-types/properties/get-property-details", + "api-reference/issue-types/properties/update-property", + "api-reference/issue-types/properties/delete-property" + ] + }, + { + "group": "Custom Property Values", + "pages": [ + "api-reference/issue-types/values/overview", + "api-reference/issue-types/values/add-property-values", + "api-reference/issue-types/values/list-property-values" ] }, { - "group": "Module", + "group": "Custom Property Dropdown Options", + "pages": [ + "api-reference/issue-types/options/overview", + "api-reference/issue-types/options/add-dropdown-options", + "api-reference/issue-types/options/list-dropdown-options", + "api-reference/issue-types/options/get-option-details", + "api-reference/issue-types/options/update-dropdown-options", + "api-reference/issue-types/options/delete-dropdown-options" + ] + }, + { + "group": "Modules", "pages": [ "api-reference/module/overview", "api-reference/module/add-module", + "api-reference/module/add-module-work-items", + "api-reference/module/archive-module", "api-reference/module/list-modules", "api-reference/module/get-module-detail", - "api-reference/module/update-module-detail", - "api-reference/module/delete-module", + "api-reference/module/list-module-work-items", "api-reference/module/list-archived-modules", - "api-reference/module/archive-module", + "api-reference/module/update-module-detail", "api-reference/module/unarchive-module", - "api-reference/module/list-module-work-items", - "api-reference/module/add-module-work-items", - "api-reference/module/remove-module-work-item" + "api-reference/module/remove-module-work-item", + "api-reference/module/delete-module" ] }, { @@ -310,21 +313,21 @@ "pages": [ "api-reference/cycle/overview", "api-reference/cycle/add-cycle", + "api-reference/cycle/add-cycle-work-items", + "api-reference/cycle/transfer-cycle-work-items", + "api-reference/cycle/archive-cycle", "api-reference/cycle/list-cycles", "api-reference/cycle/get-cycle-detail", - "api-reference/cycle/update-cycle-detail", - "api-reference/cycle/delete-cycle", + "api-reference/cycle/list-cycle-work-items", "api-reference/cycle/list-archived-cycles", - "api-reference/cycle/archive-cycle", + "api-reference/cycle/update-cycle-detail", "api-reference/cycle/unarchive-cycle", - "api-reference/cycle/list-cycle-work-items", - "api-reference/cycle/add-cycle-work-items", "api-reference/cycle/remove-cycle-work-item", - "api-reference/cycle/transfer-cycle-work-items" + "api-reference/cycle/delete-cycle" ] }, { - "group": "Intake issue", + "group": "Intake", "pages": [ "api-reference/intake-issue/overview", "api-reference/intake-issue/add-intake-issue", @@ -335,12 +338,12 @@ ] }, { - "group": "Worklogs", + "group": "Time Tracking", "pages": [ "api-reference/worklogs/overview", + "api-reference/worklogs/create-worklog", "api-reference/worklogs/get-worklogs-for-issue", "api-reference/worklogs/get-total-time", - "api-reference/worklogs/create-worklog", "api-reference/worklogs/update-worklog", "api-reference/worklogs/delete-worklog" ] @@ -354,121 +357,121 @@ ] }, { - "group": "Initiative", + "group": "Initiatives", "pages": [ "api-reference/initiative/overview", "api-reference/initiative/add-initiative", "api-reference/initiative/list-initiatives", "api-reference/initiative/get-initiative-detail", "api-reference/initiative/update-initiative-detail", - "api-reference/initiative/delete-initiative", - { + "api-reference/initiative/delete-initiative" + ] + }, + { "group": "Initiative Labels", "pages": [ "api-reference/initiative/add-initiative-label", + "api-reference/initiative/add-labels-to-initiative", "api-reference/initiative/list-initiative-labels", "api-reference/initiative/get-initiative-label-detail", - "api-reference/initiative/update-initiative-label-detail", - "api-reference/initiative/delete-initiative-label", "api-reference/initiative/list-initiative-labels-for-initiative", - "api-reference/initiative/add-labels-to-initiative", - "api-reference/initiative/remove-labels-from-initiative" + "api-reference/initiative/update-initiative-label-detail", + "api-reference/initiative/remove-labels-from-initiative", + "api-reference/initiative/delete-initiative-label" ] }, { "group": "Initiative Projects", "pages": [ - "api-reference/initiative/list-initiative-projects", "api-reference/initiative/add-projects-to-initiative", + "api-reference/initiative/list-initiative-projects", "api-reference/initiative/remove-projects-from-initiative" ] }, { "group": "Initiative Epics", "pages": [ - "api-reference/initiative/list-initiative-epics", "api-reference/initiative/add-epics-to-initiative", + "api-reference/initiative/list-initiative-epics", "api-reference/initiative/remove-epics-from-initiative" ] - } - ] - }, + }, { - "group": "Page", + "group": "Pages", "pages": [ "api-reference/page/overview", "api-reference/page/add-workspace-page", - "api-reference/page/get-workspace-page", "api-reference/page/add-project-page", + "api-reference/page/get-workspace-page", "api-reference/page/get-project-page" ] }, { - "group": "Customer", + "group": "Customers", "pages": [ "api-reference/customer/overview", "api-reference/customer/add-customer", + "api-reference/customer/link-work-items-to-customer", "api-reference/customer/list-customers", "api-reference/customer/get-customer-detail", - "api-reference/customer/update-customer-detail", - "api-reference/customer/delete-customer", "api-reference/customer/list-customer-work-items", - "api-reference/customer/link-work-items-to-customer", + "api-reference/customer/update-customer-detail", "api-reference/customer/unlink-work-item-from-customer", - { + "api-reference/customer/delete-customer" + ] + }, + { "group": "Customer Properties", "pages": [ - "api-reference/customer/list-customer-properties", "api-reference/customer/add-customer-property", + "api-reference/customer/list-customer-properties", "api-reference/customer/get-customer-property-detail", - "api-reference/customer/update-customer-property-detail", - "api-reference/customer/delete-customer-property", "api-reference/customer/list-customer-property-values", "api-reference/customer/get-customer-property-value", - "api-reference/customer/update-customer-property-value" + "api-reference/customer/update-customer-property-detail", + "api-reference/customer/update-customer-property-value", + "api-reference/customer/delete-customer-property" ] }, { "group": "Customer Requests", "pages": [ - "api-reference/customer/list-customer-requests", "api-reference/customer/add-customer-request", + "api-reference/customer/list-customer-requests", "api-reference/customer/get-customer-request-detail", "api-reference/customer/update-customer-request-detail", "api-reference/customer/delete-customer-request" ] - } - ] - }, + }, { - "group": "Teamspace", + "group": "Teamspaces", "pages": [ "api-reference/teamspace/overview", "api-reference/teamspace/add-teamspace", "api-reference/teamspace/list-teamspaces", "api-reference/teamspace/get-teamspace-detail", "api-reference/teamspace/update-teamspace-detail", - "api-reference/teamspace/delete-teamspace", - { + "api-reference/teamspace/delete-teamspace" + ] + }, + { "group": "Teamspace Members", "pages": [ "api-reference/teamspace/list-teamspace-members", "api-reference/teamspace/add-teamspace-members", "api-reference/teamspace/remove-teamspace-members" ] - }, - { + }, + { "group": "Teamspace Projects", "pages": [ "api-reference/teamspace/list-teamspace-projects", "api-reference/teamspace/add-projects-to-teamspace", "api-reference/teamspace/remove-projects-from-teamspace" ] - } - ] }, { - "group": "Sticky", + "group": "Stickies", "pages": [ "api-reference/sticky/overview", "api-reference/sticky/add-sticky", @@ -513,6 +516,38 @@ { "source": "/webhooks/intro-webhooks", "destination": "/dev-tools/intro-webhooks" + }, + { + "source": "/api-reference/cycle-issue/overview", + "destination": "/api-reference/cycle/overview" + }, + { + "source": "/api-reference/cycle-issue/add-cycle-issue", + "destination": "/api-reference/cycle/add-cycle-work-items" + }, + { + "source": "/api-reference/cycle-issue/list-cycle-issues", + "destination": "/api-reference/cycle/list-cycle-work-items" + }, + { + "source": "/api-reference/cycle-issue/delete-cycle-issue", + "destination": "/api-reference/cycle/remove-cycle-work-item" + }, + { + "source": "/api-reference/module-issue/overview", + "destination": "/api-reference/module/overview" + }, + { + "source": "/api-reference/module-issue/add-module-issue", + "destination": "/api-reference/module/add-module-work-items" + }, + { + "source": "/api-reference/module-issue/list-module-issues", + "destination": "/api-reference/module/list-module-work-items" + }, + { + "source": "/api-reference/module-issue/delete-module-issue", + "destination": "/api-reference/module/remove-module-work-item" } ] } From 2d3a0d6786f4cd9a3b52d8301b8a25f3af2282f7 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Wed, 26 Nov 2025 21:17:22 +0530 Subject: [PATCH 3/3] coderabbit fixes --- api-reference/issue-attachments/overview.mdx | 2 +- mint.json | 86 ++++++++++---------- 2 files changed, 44 insertions(+), 44 deletions(-) diff --git a/api-reference/issue-attachments/overview.mdx b/api-reference/issue-attachments/overview.mdx index c254dd3..902da32 100644 --- a/api-reference/issue-attachments/overview.mdx +++ b/api-reference/issue-attachments/overview.mdx @@ -2,7 +2,7 @@ title: Overview --- -Allows you to manage file attachments associated with work items and Intake issues. You can upload new attachments and retrieve existing attachments for a specific work item. +Allows you to manage file attachments associated with work items and Intake work items. You can upload new attachments and retrieve existing attachments for a specific work item. [Learn more about Attachments →](https://docs.plane.so/core-concepts/issues/overview#add-links-and-attachments) diff --git a/mint.json b/mint.json index 347ea44..0c9ebf9 100644 --- a/mint.json +++ b/mint.json @@ -194,17 +194,6 @@ "api-reference/label/delete-label" ] }, - { - "group": "Link", - "pages": [ - "api-reference/link/overview", - "api-reference/link/add-link", - "api-reference/link/list-links", - "api-reference/link/get-link-detail", - "api-reference/link/update-link-detail", - "api-reference/link/delete-link" - ] - }, { "group": "Work Item", "pages": [ @@ -218,6 +207,17 @@ "api-reference/issue/delete-issue" ] }, + { + "group": "Work Item Links", + "pages": [ + "api-reference/link/overview", + "api-reference/link/add-link", + "api-reference/link/list-links", + "api-reference/link/get-link-detail", + "api-reference/link/update-link-detail", + "api-reference/link/delete-link" + ] + }, { "group": "Work Item Activity", "pages": [ @@ -291,6 +291,24 @@ "api-reference/issue-types/options/delete-dropdown-options" ] }, + { + "group": "Cycle", + "pages": [ + "api-reference/cycle/overview", + "api-reference/cycle/add-cycle", + "api-reference/cycle/add-cycle-work-items", + "api-reference/cycle/transfer-cycle-work-items", + "api-reference/cycle/archive-cycle", + "api-reference/cycle/list-cycles", + "api-reference/cycle/get-cycle-detail", + "api-reference/cycle/list-cycle-work-items", + "api-reference/cycle/list-archived-cycles", + "api-reference/cycle/update-cycle-detail", + "api-reference/cycle/unarchive-cycle", + "api-reference/cycle/remove-cycle-work-item", + "api-reference/cycle/delete-cycle" + ] + }, { "group": "Modules", "pages": [ @@ -309,21 +327,13 @@ ] }, { - "group": "Cycle", + "group": "Pages", "pages": [ - "api-reference/cycle/overview", - "api-reference/cycle/add-cycle", - "api-reference/cycle/add-cycle-work-items", - "api-reference/cycle/transfer-cycle-work-items", - "api-reference/cycle/archive-cycle", - "api-reference/cycle/list-cycles", - "api-reference/cycle/get-cycle-detail", - "api-reference/cycle/list-cycle-work-items", - "api-reference/cycle/list-archived-cycles", - "api-reference/cycle/update-cycle-detail", - "api-reference/cycle/unarchive-cycle", - "api-reference/cycle/remove-cycle-work-item", - "api-reference/cycle/delete-cycle" + "api-reference/page/overview", + "api-reference/page/add-workspace-page", + "api-reference/page/add-project-page", + "api-reference/page/get-workspace-page", + "api-reference/page/get-project-page" ] }, { @@ -348,14 +358,6 @@ "api-reference/worklogs/delete-worklog" ] }, - { - "group": "Members", - "pages": [ - "api-reference/members/overview", - "api-reference/members/get-workspace-members", - "api-reference/members/get-project-members" - ] - }, { "group": "Initiatives", "pages": [ @@ -396,16 +398,6 @@ "api-reference/initiative/remove-epics-from-initiative" ] }, - { - "group": "Pages", - "pages": [ - "api-reference/page/overview", - "api-reference/page/add-workspace-page", - "api-reference/page/add-project-page", - "api-reference/page/get-workspace-page", - "api-reference/page/get-project-page" - ] - }, { "group": "Customers", "pages": [ @@ -481,6 +473,14 @@ "api-reference/sticky/delete-sticky" ] }, + { + "group": "Members", + "pages": [ + "api-reference/members/overview", + "api-reference/members/get-workspace-members", + "api-reference/members/get-project-members" + ] + }, { "group": "User", "pages": [