@@ -78,8 +77,8 @@ const response = await fetch(
{
method: "DELETE",
headers: {
- "X-API-Key": "your-api-key"
- }
+ "X-API-Key": "your-api-key",
+ },
}
);
const data = await response.json();
diff --git a/docs/api-reference/cycle/update-cycle-detail.md b/docs/api-reference/cycle/update-cycle-detail.md
index 6349c77a..cbb4fbfc 100644
--- a/docs/api-reference/cycle/update-cycle-detail.md
+++ b/docs/api-reference/cycle/update-cycle-detail.md
@@ -4,7 +4,6 @@ description: Update a cycle via Plane API. HTTP PATCH request format, editable f
keywords: plane, plane api, rest api, api integration, cycles, sprints, iterations
---
-
# Update a cycle
@@ -157,18 +156,18 @@ const response = await fetch(
method: "PATCH",
headers: {
"X-API-Key": "your-api-key",
- "Content-Type": "application/json"
+ "Content-Type": "application/json",
},
body: JSON.stringify({
- "name": "example-name",
- "description": "example-description",
- "start_date": "example-start_date",
- "end_date": "example-end_date",
- "owned_by": "example-owned_by",
- "external_source": "example-external_source",
- "external_id": "example-external_id",
- "timezone": "example-timezone"
-})
+ name: "example-name",
+ description: "example-description",
+ start_date: "example-start_date",
+ end_date: "example-end_date",
+ owned_by: "example-owned_by",
+ external_source: "example-external_source",
+ external_id: "example-external_id",
+ timezone: "example-timezone",
+ }),
}
);
const data = await response.json();
diff --git a/docs/api-reference/epics/get-epic-detail.md b/docs/api-reference/epics/get-epic-detail.md
index c16e86d6..681d5654 100644
--- a/docs/api-reference/epics/get-epic-detail.md
+++ b/docs/api-reference/epics/get-epic-detail.md
@@ -4,7 +4,6 @@ description: Get retrieve an epic details via Plane API. Retrieve complete infor
keywords: plane, plane api, rest api, api integration, epics, features, stories
---
-
# Retrieve an epic
@@ -78,8 +77,8 @@ const response = await fetch(
{
method: "GET",
headers: {
- "X-API-Key": "your-api-key"
- }
+ "X-API-Key": "your-api-key",
+ },
}
);
const data = await response.json();
diff --git a/docs/api-reference/epics/list-epics.md b/docs/api-reference/epics/list-epics.md
index d3860b76..27770c9d 100644
--- a/docs/api-reference/epics/list-epics.md
+++ b/docs/api-reference/epics/list-epics.md
@@ -4,7 +4,6 @@ description: List all epics via Plane API. HTTP GET request with pagination, fil
keywords: plane, plane api, rest api, api integration, epics, features, stories
---
-
# List all epics
@@ -88,15 +87,12 @@ print(response.json())
```javascript
-const response = await fetch(
- "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/epics/",
- {
- method: "GET",
- headers: {
- "X-API-Key": "your-api-key"
- }
- }
-);
+const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/epics/", {
+ method: "GET",
+ headers: {
+ "X-API-Key": "your-api-key",
+ },
+});
const data = await response.json();
```
diff --git a/docs/api-reference/epics/overview.md b/docs/api-reference/epics/overview.md
index c80814eb..e23287af 100644
--- a/docs/api-reference/epics/overview.md
+++ b/docs/api-reference/epics/overview.md
@@ -4,7 +4,6 @@ description: Plane Epics API overview. Learn about endpoints, request/response f
keywords: plane, plane api, rest api, api integration, epics, features, stories
---
-
# Overview
Epics help you group related tasks into a larger work item, providing a hierarchical structure for managing complex projects. Use epics to break down major objectives into smaller, manageable pieces while keeping everything organized.
@@ -14,127 +13,128 @@ Epics help you group related tasks into a larger work item, providing a hierarch
## The Epics Object
+
### Attributes
- `id` string
- Unique identifier for the epic.
+ Unique identifier for the epic.
- `name` string
- Name of the epic.
+ Name of the epic.
- `description` object
- JSON representation of the epic description.
+ JSON representation of the epic description.
- `description_html` string
- HTML-formatted description of the epic.
+ HTML-formatted description of the epic.
- `description_stripped` string
- Plain text version of the description.
+ Plain text version of the description.
- `description_binary` string
- Binary representation of the description.
+ Binary representation of the description.
- `state` string
- ID of the state (status) of the epic.
+ ID of the state (status) of the epic.
- `priority` string
- Priority level. Possible values: `none`, `urgent`, `high`, `medium`, `low`.
+ Priority level. Possible values: `none`, `urgent`, `high`, `medium`, `low`.
- `assignees` array
- Array of user IDs assigned to the epic.
+ Array of user IDs assigned to the epic.
- `labels` array
- Array of label IDs applied to the epic.
+ Array of label IDs applied to the epic.
- `type` string
- ID of the work item type for the epic.
+ ID of the work item type for the epic.
- `estimate_point` string
- ID of the estimate point, or null if not estimated.
+ ID of the estimate point, or null if not estimated.
- `point` integer
- Point value for the epic, or null.
+ Point value for the epic, or null.
- `start_date` string
- Start date of the epic in YYYY-MM-DD format.
+ Start date of the epic in YYYY-MM-DD format.
- `target_date` string
- Target completion date in YYYY-MM-DD format.
+ Target completion date in YYYY-MM-DD format.
- `parent` string
- ID of the parent work item, or null if no parent.
+ ID of the parent work item, or null if no parent.
- `sequence_id` integer
- Auto-generated sequential identifier for the epic within the project.
+ Auto-generated sequential identifier for the epic within the project.
- `sort_order` number
- Auto-generated sort order for display purposes.
+ Auto-generated sort order for display purposes.
- `is_draft` boolean
- Whether the epic is a draft.
+ Whether the epic is a draft.
- `completed_at` timestamp
- Time at which the epic was completed, or null if not completed.
+ Time at which the epic was completed, or null if not completed.
- `archived_at` timestamp
- Time at which the epic was archived, or null if not archived.
+ Time at which the epic was archived, or null if not archived.
- `project` string
- ID of the project containing this epic.
+ ID of the project containing this epic.
- `workspace` string
- ID of the workspace containing this epic.
+ ID of the workspace containing this epic.
- `external_id` string
- External identifier if imported from another system, or null.
+ External identifier if imported from another system, or null.
- `external_source` string
- Name of the source system if imported, or null.
+ Name of the source system if imported, or null.
- `deleted_at` timestamp
- Time at which the epic was deleted, or null if not deleted.
+ Time at which the epic was deleted, or null if not deleted.
- `created_at` timestamp
- Time at which the epic was created.
+ Time at which the epic was created.
- `updated_at` timestamp
- Time at which the epic was last updated.
+ Time at which the epic was last updated.
- `created_by` string
- ID of the user who created the epic.
+ ID of the user who created the epic.
- `updated_by` string
- ID of the user who last updated the epic.
+ ID of the user who last updated the epic.
@@ -152,10 +152,7 @@ Epics help you group related tasks into a larger work item, providing a hierarch
"state": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"priority": "medium",
"assignees": [],
- "labels": [
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
- "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- ],
+ "labels": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
"type": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"estimate_point": null,
"point": null,
@@ -182,4 +179,4 @@ Epics help you group related tasks into a larger work item, providing a hierarch
-
\ No newline at end of file
+
diff --git a/docs/api-reference/inbox-issue/add-inbox-issue.md b/docs/api-reference/inbox-issue/add-inbox-issue.md
index 27d0f42f..48690838 100644
--- a/docs/api-reference/inbox-issue/add-inbox-issue.md
+++ b/docs/api-reference/inbox-issue/add-inbox-issue.md
@@ -4,7 +4,6 @@ description: Create intake issue via Plane API. HTTP POST request format, requir
keywords: plane, plane api, rest api, api integration, work items, issues, tasks
---
-
# Add intake issue
@@ -25,14 +24,10 @@ Adds an intake issue in a project
-
-
-
-
@@ -95,11 +90,11 @@ const response = await fetch(
method: "POST",
headers: {
"X-API-Key": "your-api-key",
- "Content-Type": "application/json"
+ "Content-Type": "application/json",
},
body: JSON.stringify({
- "issue": "example-issue"
-})
+ issue: "example-issue",
+ }),
}
);
const data = await response.json();
diff --git a/docs/api-reference/inbox-issue/delete-inbox-issue.md b/docs/api-reference/inbox-issue/delete-inbox-issue.md
index ede0f218..9c0530d1 100644
--- a/docs/api-reference/inbox-issue/delete-inbox-issue.md
+++ b/docs/api-reference/inbox-issue/delete-inbox-issue.md
@@ -4,7 +4,6 @@ description: Delete intake issue via Plane API. HTTP DELETE request for removing
keywords: plane, plane api, rest api, api integration, work items, issues, tasks
---
-
# Delete intake issue
@@ -25,26 +24,18 @@ Deletes an intake issue
-
-
-
-
-
-
-
-
@@ -84,8 +75,8 @@ const response = await fetch(
{
method: "DELETE",
headers: {
- "X-API-Key": "your-api-key"
- }
+ "X-API-Key": "your-api-key",
+ },
}
);
const data = await response.json();
diff --git a/docs/api-reference/inbox-issue/get-inbox-issue-detail.md b/docs/api-reference/inbox-issue/get-inbox-issue-detail.md
index 89d0e615..9d95d57d 100644
--- a/docs/api-reference/inbox-issue/get-inbox-issue-detail.md
+++ b/docs/api-reference/inbox-issue/get-inbox-issue-detail.md
@@ -4,7 +4,6 @@ description: Get intake issue detail details via Plane API. Retrieve complete in
keywords: plane, plane api, rest api, api integration, work items, issues, tasks
---
-
# Get intake issue detail
@@ -25,20 +24,14 @@ Gets the details of an intake issue
-
-
-
-
-
-
@@ -78,8 +71,8 @@ const response = await fetch(
{
method: "GET",
headers: {
- "X-API-Key": "your-api-key"
- }
+ "X-API-Key": "your-api-key",
+ },
}
);
const data = await response.json();
diff --git a/docs/api-reference/inbox-issue/list-inbox-issues.md b/docs/api-reference/inbox-issue/list-inbox-issues.md
index 5903e102..892d442a 100644
--- a/docs/api-reference/inbox-issue/list-inbox-issues.md
+++ b/docs/api-reference/inbox-issue/list-inbox-issues.md
@@ -4,7 +4,6 @@ description: List intake issues via Plane API. HTTP GET request with pagination,
keywords: plane, plane api, rest api, api integration, work items, issues, tasks
---
-
# List intake issues
@@ -25,14 +24,10 @@ Gets all the intake issue of a project
-
-
-
-
@@ -72,8 +67,8 @@ const response = await fetch(
{
method: "GET",
headers: {
- "X-API-Key": "your-api-key"
- }
+ "X-API-Key": "your-api-key",
+ },
}
);
const data = await response.json();
diff --git a/docs/api-reference/inbox-issue/overview.md b/docs/api-reference/inbox-issue/overview.md
index 765f5f72..f621d3e3 100644
--- a/docs/api-reference/inbox-issue/overview.md
+++ b/docs/api-reference/inbox-issue/overview.md
@@ -4,7 +4,6 @@ description: Plane Inbox-Issue API overview. Learn about endpoints, request/resp
keywords: plane, plane api, rest api, api integration, work items, issues, tasks
---
-
# Overview
::: warning
@@ -64,7 +63,6 @@ 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
-
- \-2 - Pending
- \-1 - Rejected
- 0 - Snoozed
@@ -110,22 +108,22 @@ To create an Intake issue, the payload should be sent in the below format
```json
{
- "id": "0de4d6d1-fdc7-4849-8080-dc379ab210e3",
- "pending_issue_count": 0,
- "created_at": "2023-11-21T07:32:26.072634Z",
- "updated_at": "2023-11-21T07:32:26.072648Z",
- "name": "a dummy project with Intake",
- "description": "",
- "is_default": true,
- "view_props": {},
- "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"
+ "id": "0de4d6d1-fdc7-4849-8080-dc379ab210e3",
+ "pending_issue_count": 0,
+ "created_at": "2023-11-21T07:32:26.072634Z",
+ "updated_at": "2023-11-21T07:32:26.072648Z",
+ "name": "a dummy project with Intake",
+ "description": "",
+ "is_default": true,
+ "view_props": {},
+ "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"
}
```