diff --git a/docs/api-reference/assets/create-workspace-asset-upload.md b/docs/api-reference/assets/create-workspace-asset-upload.md index 472445a..f5e18f1 100644 --- a/docs/api-reference/assets/create-workspace-asset-upload.md +++ b/docs/api-reference/assets/create-workspace-asset-upload.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, assets, create workspace
POST - /api/v1/workspaces/{slug}/assets/ + /api/v1/workspaces/{workspace_slug}/assets/
@@ -22,9 +22,9 @@ Generate presigned URL for generic asset upload
- + -Workspace slug +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/docs/api-reference/assets/delete-user-asset.md b/docs/api-reference/assets/delete-user-asset.md index 1fdef24..4ef203b 100644 --- a/docs/api-reference/assets/delete-user-asset.md +++ b/docs/api-reference/assets/delete-user-asset.md @@ -51,9 +51,9 @@ Asset ID ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/" \ + "https://api.plane.so/api/v1/assets/user-assets/asset-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -63,7 +63,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/assets/user-assets/asset-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -73,7 +73,7 @@ print(response.status_code) @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +76,12 @@ print(response.json()) @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/property-values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/property-values/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -77,7 +77,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/property-values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/property-values/", { method: "GET", headers: { diff --git a/docs/api-reference/customer/list-customer-requests.md b/docs/api-reference/customer/list-customer-requests.md index ab8a9dc..d80fcef 100644 --- a/docs/api-reference/customer/list-customer-requests.md +++ b/docs/api-reference/customer/list-customer-requests.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, list all custom
GET - /api/v1/workspaces/{slug}/customers/{customer_id}/requests/ + /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/
@@ -24,13 +24,13 @@ List all requests for a customer with optional search filtering -Customer id. +The unique identifier of the customer. - + -Slug. +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`. @@ -54,9 +54,9 @@ Slug. ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/", + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +76,12 @@ print(response.json()) @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/issues/", + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/issues/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +76,12 @@ print(response.json()) diff --git a/docs/api-reference/customer/unlink-work-item-from-customer.md b/docs/api-reference/customer/unlink-work-item-from-customer.md index 5feb2f3..ad6c6c5 100644 --- a/docs/api-reference/customer/unlink-work-item-from-customer.md +++ b/docs/api-reference/customer/unlink-work-item-from-customer.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, unlink work ite
DELETE - /api/v1/workspaces/{slug}/customers/{customer_id}/issues/{issue_id}/ + /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/issues/{work_item_id}/
@@ -24,19 +24,19 @@ Remove the link between an issue and a customer/customer request. -Customer id. +The unique identifier of the customer. - + -Issue id. +The unique identifier of the work item. - + -Slug. +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`. @@ -60,9 +60,9 @@ Slug. ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/issues/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/issues/work-item-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/issues/work-item-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/issues/work-item-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/customer/update-customer-detail.md b/docs/api-reference/customer/update-customer-detail.md index 11d9c89..cf45ed6 100644 --- a/docs/api-reference/customer/update-customer-detail.md +++ b/docs/api-reference/customer/update-customer-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, update a custom
PATCH - /api/v1/workspaces/{slug}/customers/{pk}/ + /api/v1/workspaces/{workspace_slug}/customers/{resource_id}/
@@ -22,15 +22,15 @@ Update an existing customer with the provided fields.
- + -Pk. +The unique identifier of the resource. - + -Slug. +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`. @@ -159,7 +159,7 @@ Logo asset. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -190,7 +190,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/customers/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -218,34 +218,31 @@ print(response.json()) @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/resource-id-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/cycle/list-archived-cycles.md b/docs/api-reference/cycle/list-archived-cycles.md index a9ceb77..108becd 100644 --- a/docs/api-reference/cycle/list-archived-cycles.md +++ b/docs/api-reference/cycle/list-archived-cycles.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, cycle, list all archived
GET - /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/archived-cycles/
@@ -24,13 +24,13 @@ Retrieve all cycles that have been archived in the project. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -75,9 +75,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-cycles/?cursor=20:1:0&per_page=20" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-cycles/?cursor=20:1:0&per_page=20" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -87,7 +87,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-cycles/?cursor=20:1:0&per_page=20", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-cycles/?cursor=20:1:0&per_page=20", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -98,7 +98,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-cycles/?cursor=20:1:0&per_page=20", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-cycles/?cursor=20:1:0&per_page=20", { method: "GET", headers: { diff --git a/docs/api-reference/cycle/list-cycle-work-items.md b/docs/api-reference/cycle/list-cycle-work-items.md index baedbf5..9273c5e 100644 --- a/docs/api-reference/cycle/list-cycle-work-items.md +++ b/docs/api-reference/cycle/list-cycle-work-items.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, cycle, list all work item
GET - /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/
@@ -24,19 +24,19 @@ Retrieve all work items assigned to a cycle. -Cycle id. +The unique identifier of the cycle. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -81,9 +81,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/cycle-issues/?cursor=20:1:0&per_page=20" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/cycle-issues/?cursor=20:1:0&per_page=20" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -93,7 +93,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/cycle-issues/?cursor=20:1:0&per_page=20", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/cycle-issues/?cursor=20:1:0&per_page=20", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -104,7 +104,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/cycle-issues/?cursor=20:1:0&per_page=20", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/cycle-issues/?cursor=20:1:0&per_page=20", { method: "GET", headers: { diff --git a/docs/api-reference/cycle/list-cycles.md b/docs/api-reference/cycle/list-cycles.md index 978cf75..cc49c96 100644 --- a/docs/api-reference/cycle/list-cycles.md +++ b/docs/api-reference/cycle/list-cycles.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, cycle, list all cycles
GET - /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/
@@ -24,13 +24,13 @@ Retrieve all cycles in a project. Supports filtering by cycle status like curren -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,9 +99,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/?cursor=20:1:0&cycle_view=all" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/?cursor=20:1:0&cycle_view=all" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -111,7 +111,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/?cursor=20:1:0&cycle_view=all", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/?cursor=20:1:0&cycle_view=all", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -122,7 +122,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/?cursor=20:1:0&cycle_view=all", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/?cursor=20:1:0&cycle_view=all", { method: "GET", headers: { diff --git a/docs/api-reference/cycle/remove-cycle-work-item.md b/docs/api-reference/cycle/remove-cycle-work-item.md index 7dbd1f4..1f86caf 100644 --- a/docs/api-reference/cycle/remove-cycle-work-item.md +++ b/docs/api-reference/cycle/remove-cycle-work-item.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, cycle, remove work item f
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{work_item_id}/
@@ -24,25 +24,25 @@ Remove a work item from a cycle while keeping the work item in the project. -Cycle id. +The unique identifier of the cycle. - + -Issue id. +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/cycle-issues/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/cycle-issues/work-item-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/cycle-issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/cycle-issues/work-item-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/cycle-issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/cycle-issues/work-item-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/cycle/transfer-cycle-work-items.md b/docs/api-reference/cycle/transfer-cycle-work-items.md index 754f91d..9987cc9 100644 --- a/docs/api-reference/cycle/transfer-cycle-work-items.md +++ b/docs/api-reference/cycle/transfer-cycle-work-items.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, cycle, transfer cycle wor
POST - /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/
@@ -24,19 +24,19 @@ Move incomplete work items from the current cycle to a new target cycle. Capture -Cycle id. +The unique identifier of the cycle. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -75,7 +75,7 @@ ID of the target cycle to transfer issues to ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/transfer-issues/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/transfer-issues/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -91,7 +91,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/transfer-issues/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/transfer-issues/", headers={"X-API-Key": "your-api-key"}, json={ "new_cycle_id": "550e8400-e29b-41d4-a716-446655440000" @@ -105,7 +105,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440001/transfer-issues/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/cycle-uuid/transfer-issues/", { method: "POST", headers: { diff --git a/docs/api-reference/cycle/unarchive-cycle.md b/docs/api-reference/cycle/unarchive-cycle.md index 8ea4b33..1caa1c2 100644 --- a/docs/api-reference/cycle/unarchive-cycle.md +++ b/docs/api-reference/cycle/unarchive-cycle.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, cycle, restore a cycle
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/{cycle_id}/unarchive/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/archived-cycles/{cycle_id}/unarchive/
@@ -24,19 +24,19 @@ Restore an archived cycle to active status, making it available for regular use. -Cycle id. +The unique identifier of the cycle. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-cycles/550e8400-e29b-41d4-a716-446655440001/unarchive/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-cycles/cycle-uuid/unarchive/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-cycles/550e8400-e29b-41d4-a716-446655440001/unarchive/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-cycles/cycle-uuid/unarchive/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-cycles/550e8400-e29b-41d4-a716-446655440001/unarchive/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-cycles/cycle-uuid/unarchive/", { method: "DELETE", headers: { diff --git a/docs/api-reference/cycle/update-cycle-detail.md b/docs/api-reference/cycle/update-cycle-detail.md index ef789ea..0e38fc1 100644 --- a/docs/api-reference/cycle/update-cycle-detail.md +++ b/docs/api-reference/cycle/update-cycle-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, cycle, update a cycle
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/cycles/{resource_id}/
@@ -22,21 +22,21 @@ Modify an existing cycle's properties like name, description, or date range. Com
- + -Pk. +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -549,7 +549,7 @@ External id. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -570,7 +570,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -589,7 +589,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/cycles/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/cycles/resource-id-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/epics/get-epic-detail.md b/docs/api-reference/epics/get-epic-detail.md index c43d7e0..c9e4e55 100644 --- a/docs/api-reference/epics/get-epic-detail.md +++ b/docs/api-reference/epics/get-epic-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, epics, retrieve an epic
GET - /api/v1/workspaces/{slug}/projects/{project_id}/epics/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/epics/{resource_id}/
@@ -22,21 +22,21 @@ Retrieve an epic by id
- + -Pk. +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -75,9 +75,9 @@ Comma-separated list of fields to include in response ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/epics/550e8400-e29b-41d4-a716-446655440000/?fields=id,name,description" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/epics/resource-id-uuid/?fields=id,name,description" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -87,7 +87,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/epics/550e8400-e29b-41d4-a716-446655440000/?fields=id,name,description", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/epics/resource-id-uuid/?fields=id,name,description", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -98,7 +98,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/epics/550e8400-e29b-41d4-a716-446655440000/?fields=id,name,description", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/epics/resource-id-uuid/?fields=id,name,description", { method: "GET", headers: { diff --git a/docs/api-reference/epics/list-epics.md b/docs/api-reference/epics/list-epics.md index 12dca05..66fe0a3 100644 --- a/docs/api-reference/epics/list-epics.md +++ b/docs/api-reference/epics/list-epics.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, epics, list all epics
GET - /api/v1/workspaces/{slug}/projects/{project_id}/epics/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/epics/
@@ -24,13 +24,13 @@ List epics -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -75,9 +75,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/epics/?cursor=20:1:0&per_page=20" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/epics/?cursor=20:1:0&per_page=20" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -87,7 +87,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/epics/?cursor=20:1:0&per_page=20", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/epics/?cursor=20:1:0&per_page=20", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -98,7 +98,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/epics/?cursor=20:1:0&per_page=20", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/epics/?cursor=20:1:0&per_page=20", { method: "GET", headers: { diff --git a/docs/api-reference/estimate/add-estimate-points.md b/docs/api-reference/estimate/add-estimate-points.md index 75b35ad..bd3d6df 100644 --- a/docs/api-reference/estimate/add-estimate-points.md +++ b/docs/api-reference/estimate/add-estimate-points.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, estimate points, create e
POST - /api/v1/workspaces/{slug}/projects/{project_id}/estimates/{estimate_id}/estimate-points/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/estimates/{estimate_id}/estimate-points/
@@ -24,19 +24,19 @@ Create estimate points for a project estimate. You can send a JSON array directl -Estimate ID +The unique identifier of the estimate. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -76,7 +76,7 @@ Array of estimate point objects. Each object can include: `value` (string, requi ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/estimates/550e8400-e29b-41d4-a716-446655440000/estimate-points/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/estimates/estimate-uuid/estimate-points/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -101,7 +101,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/estimates/550e8400-e29b-41d4-a716-446655440000/estimate-points/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/estimates/estimate-uuid/estimate-points/", headers={"X-API-Key": "your-api-key"}, json=[ {"key": 1, "value": "1", "description": "Tiny"}, @@ -116,7 +116,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/estimates/550e8400-e29b-41d4-a716-446655440000/estimate-points/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/estimates/estimate-uuid/estimate-points/", { method: "POST", headers: { diff --git a/docs/api-reference/estimate/add-estimate.md b/docs/api-reference/estimate/add-estimate.md index 15bdeb1..3ba658d 100644 --- a/docs/api-reference/estimate/add-estimate.md +++ b/docs/api-reference/estimate/add-estimate.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, estimates, create an esti
POST - /api/v1/workspaces/{slug}/projects/{project_id}/estimates/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/estimates/
@@ -24,13 +24,13 @@ Create a new estimate for the project. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,7 +99,7 @@ External source identifier. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/estimates/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/estimates/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -117,7 +117,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/estimates/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/estimates/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Story Points", @@ -132,21 +132,18 @@ print(response.json()) diff --git a/docs/api-reference/initiative/remove-epics-from-initiative.md b/docs/api-reference/initiative/remove-epics-from-initiative.md index 3f8bd7b..f57559f 100644 --- a/docs/api-reference/initiative/remove-epics-from-initiative.md +++ b/docs/api-reference/initiative/remove-epics-from-initiative.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, initiative, remove epics
DELETE - /api/v1/workspaces/{slug}/initiatives/{initiative_id}/epics/ + /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/epics/
@@ -24,13 +24,13 @@ Remove epics from an initiative by its ID -Initiative ID +The unique identifier of the initiative. - + -Workspace slug +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`. @@ -54,9 +54,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440001/epics/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/epics/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440001/epics/", + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/epics/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -76,15 +76,12 @@ print(response.status_code) @@ -66,7 +66,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440001/labels/", + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/labels/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -77,7 +77,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440001/labels/", + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/labels/", { method: "DELETE", headers: { diff --git a/docs/api-reference/initiative/remove-projects-from-initiative.md b/docs/api-reference/initiative/remove-projects-from-initiative.md index c016eed..4c7f910 100644 --- a/docs/api-reference/initiative/remove-projects-from-initiative.md +++ b/docs/api-reference/initiative/remove-projects-from-initiative.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, initiative, remove projec
DELETE - /api/v1/workspaces/{slug}/initiatives/{initiative_id}/projects/ + /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/projects/
@@ -24,13 +24,13 @@ Remove projects from an initiative by its ID -Initiative ID +The unique identifier of the initiative. - + -Workspace slug +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`. @@ -54,9 +54,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440001/projects/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/projects/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440001/projects/", + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/projects/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -77,7 +77,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440001/projects/", + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/projects/", { method: "DELETE", headers: { diff --git a/docs/api-reference/initiative/update-initiative-detail.md b/docs/api-reference/initiative/update-initiative-detail.md index a232217..879c30f 100644 --- a/docs/api-reference/initiative/update-initiative-detail.md +++ b/docs/api-reference/initiative/update-initiative-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, initiative, update an ini
PATCH - /api/v1/workspaces/{slug}/initiatives/{pk}/ + /api/v1/workspaces/{workspace_slug}/initiatives/{initiative_id}/
@@ -24,19 +24,19 @@ Update an initiative by its ID -Initiative ID +The unique identifier of the initiative. - + -Pk. +The unique identifier of the initiative. - + -Workspace slug +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`. @@ -145,7 +145,7 @@ Lead. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -172,7 +172,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/initiatives/initiative-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -196,30 +196,27 @@ print(response.json()) @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/intake-issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/intake-issues/work-item-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/intake-issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/intake-issues/work-item-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/intake-issue/list-intake-issues.md b/docs/api-reference/intake-issue/list-intake-issues.md index b26c02c..5ebf8b3 100644 --- a/docs/api-reference/intake-issue/list-intake-issues.md +++ b/docs/api-reference/intake-issue/list-intake-issues.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, intake issue, list all in
GET - /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/intake-issues/
@@ -24,13 +24,13 @@ Retrieve all work items in the project's intake queue. Returns paginated results -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -87,9 +87,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/intake-issues/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/intake-issues/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -99,7 +99,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/intake-issues/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/intake-issues/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -110,7 +110,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/intake-issues/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/intake-issues/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/intake-issue/update-intake-issue-detail.md b/docs/api-reference/intake-issue/update-intake-issue-detail.md index 9709ca9..a1fc4d3 100644 --- a/docs/api-reference/intake-issue/update-intake-issue-detail.md +++ b/docs/api-reference/intake-issue/update-intake-issue-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, intake issue, update an i
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/intake-issues/{issue_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/intake-issues/{work_item_id}/
@@ -22,21 +22,21 @@ Modify an existing intake work item's properties or status for triage processing
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -109,7 +109,7 @@ Issue data to update in the intake issue ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/intake-issues/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/intake-issues/work-item-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -130,7 +130,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/intake-issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/intake-issues/work-item-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "status": 1, @@ -149,7 +149,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/intake-issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/intake-issues/work-item-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/issue-activity/get-issue-activity-detail.md b/docs/api-reference/issue-activity/get-issue-activity-detail.md index 45afdaf..fbeb1fb 100644 --- a/docs/api-reference/issue-activity/get-issue-activity-detail.md +++ b/docs/api-reference/issue-activity/get-issue-activity-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue activity, retrieve
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/activities/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/activities/{resource_id}/
@@ -22,27 +22,27 @@ Retrieve details of a specific activity.
- + -Issue ID +The unique identifier of the work item. - + -Activity ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -105,9 +105,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/activities/550e8400-e29b-41d4-a716-446655440000/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/activities/resource-id-uuid/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -117,7 +117,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/activities/550e8400-e29b-41d4-a716-446655440000/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/activities/resource-id-uuid/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -128,7 +128,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/activities/550e8400-e29b-41d4-a716-446655440000/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/activities/resource-id-uuid/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/issue-activity/list-issue-activities.md b/docs/api-reference/issue-activity/list-issue-activities.md index d00477c..5c699d0 100644 --- a/docs/api-reference/issue-activity/list-issue-activities.md +++ b/docs/api-reference/issue-activity/list-issue-activities.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue activity, list all
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/activities/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/activities/
@@ -22,21 +22,21 @@ Retrieve all activities for a work item. Supports filtering by activity type and
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,9 +99,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/activities/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/activities/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -111,7 +111,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/activities/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/activities/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -122,7 +122,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/activities/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/activities/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/issue-attachments/complete-upload.md b/docs/api-reference/issue-attachments/complete-upload.md index 2da081b..01976d8 100644 --- a/docs/api-reference/issue-attachments/complete-upload.md +++ b/docs/api-reference/issue-attachments/complete-upload.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue attachments, comple
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/attachments/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{resource_id}/
@@ -22,27 +22,27 @@ Mark an attachment as uploaded after successful file transfer to storage.
- + -Issue id. +The unique identifier of the work item. - + -Attachment ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -81,7 +81,7 @@ Mark attachment as uploaded ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -97,7 +97,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "is_uploaded": true @@ -111,7 +111,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/issue-attachments/delete-attachment.md b/docs/api-reference/issue-attachments/delete-attachment.md index ab49c32..34943c9 100644 --- a/docs/api-reference/issue-attachments/delete-attachment.md +++ b/docs/api-reference/issue-attachments/delete-attachment.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue attachments, delete
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/attachments/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{resource_id}/
@@ -22,27 +22,27 @@ Permanently remove an attachment from a work item. Records deletion activity for
- + -Issue id. +The unique identifier of the work item. - + -Attachment ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/issue-attachments/get-attachment-detail.md b/docs/api-reference/issue-attachments/get-attachment-detail.md index d641d69..d6993ad 100644 --- a/docs/api-reference/issue-attachments/get-attachment-detail.md +++ b/docs/api-reference/issue-attachments/get-attachment-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue attachments, retrie
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/attachments/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{resource_id}/
@@ -22,27 +22,27 @@ Download attachment file. Returns a redirect to the presigned download URL.
- + -Issue id. +The unique identifier of the work item. - + -Attachment ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -89,7 +89,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-attachments/get-attachments.md b/docs/api-reference/issue-attachments/get-attachments.md index 50fb9ac..10e0634 100644 --- a/docs/api-reference/issue-attachments/get-attachments.md +++ b/docs/api-reference/issue-attachments/get-attachments.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue attachments, list a
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/attachments/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/
@@ -22,21 +22,21 @@ Retrieve all attachments for a work item.
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-attachments/get-upload-credentials.md b/docs/api-reference/issue-attachments/get-upload-credentials.md index d63974f..53e85f4 100644 --- a/docs/api-reference/issue-attachments/get-upload-credentials.md +++ b/docs/api-reference/issue-attachments/get-upload-credentials.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue attachments, get up
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/attachments/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/
@@ -22,21 +22,21 @@ Generate presigned URL for uploading file attachments to a work item.
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,7 +99,7 @@ External source system (for integration tracking) ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -119,7 +119,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -137,7 +137,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/", { method: "POST", headers: { diff --git a/docs/api-reference/issue-attachments/update-attachment.md b/docs/api-reference/issue-attachments/update-attachment.md index 0018fdb..5ab8c20 100644 --- a/docs/api-reference/issue-attachments/update-attachment.md +++ b/docs/api-reference/issue-attachments/update-attachment.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue attachments, update
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/attachments/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/attachments/{resource_id}/
@@ -22,27 +22,27 @@ Mark an attachment as uploaded after successful file transfer to storage.
- + -Issue id. +The unique identifier of the work item. - + -Attachment ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -81,7 +81,7 @@ Mark attachment as uploaded ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -97,7 +97,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "is_uploaded": true @@ -111,7 +111,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/attachments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/attachments/resource-id-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/issue-comment/add-issue-comment.md b/docs/api-reference/issue-comment/add-issue-comment.md index 8a7f853..8e86833 100644 --- a/docs/api-reference/issue-comment/add-issue-comment.md +++ b/docs/api-reference/issue-comment/add-issue-comment.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue comment, create a w
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/comments/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/
@@ -22,21 +22,21 @@ Add a new comment to a work item with HTML content.
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -106,7 +106,7 @@ Parent. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -124,7 +124,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/", headers={"X-API-Key": "your-api-key"}, json={ "comment_html": "

Example content

", @@ -140,7 +140,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/", { method: "POST", headers: { diff --git a/docs/api-reference/issue-comment/delete-issue-comment.md b/docs/api-reference/issue-comment/delete-issue-comment.md index b4df58a..6e35d5e 100644 --- a/docs/api-reference/issue-comment/delete-issue-comment.md +++ b/docs/api-reference/issue-comment/delete-issue-comment.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue comment, delete a w
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/comments/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/{resource_id}/
@@ -22,27 +22,27 @@ Permanently remove a comment from a work item. Records deletion activity for aud
- + -Issue ID +The unique identifier of the work item. - + -Comment ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/issue-comment/get-issue-comment-detail.md b/docs/api-reference/issue-comment/get-issue-comment-detail.md index 6a31c87..dfa57c0 100644 --- a/docs/api-reference/issue-comment/get-issue-comment-detail.md +++ b/docs/api-reference/issue-comment/get-issue-comment-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue comment, retrieve a
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/comments/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/{resource_id}/
@@ -22,27 +22,27 @@ Retrieve details of a specific comment.
- + -Issue ID +The unique identifier of the work item. - + -Comment ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -89,7 +89,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-comment/list-issue-comments.md b/docs/api-reference/issue-comment/list-issue-comments.md index a4c0bc8..b2b37e1 100644 --- a/docs/api-reference/issue-comment/list-issue-comments.md +++ b/docs/api-reference/issue-comment/list-issue-comments.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue comment, list all w
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/comments/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/
@@ -22,21 +22,21 @@ Retrieve all comments for a work item.
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,9 +99,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -111,7 +111,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -122,7 +122,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/issue-comment/update-issue-comment-detail.md b/docs/api-reference/issue-comment/update-issue-comment-detail.md index f55ea72..83fb72b 100644 --- a/docs/api-reference/issue-comment/update-issue-comment-detail.md +++ b/docs/api-reference/issue-comment/update-issue-comment-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue comment, update a w
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/comments/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/{resource_id}/
@@ -22,27 +22,27 @@ Modify the content of an existing comment on a work item.
- + -Issue ID +The unique identifier of the work item. - + -Comment ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -112,7 +112,7 @@ Parent. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -130,7 +130,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "comment_html": "

Example content

", @@ -146,7 +146,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/comments/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/resource-id-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/issue-types/options/add-dropdown-options.md b/docs/api-reference/issue-types/options/add-dropdown-options.md index fad105a..e0a529e 100644 --- a/docs/api-reference/issue-types/options/add-dropdown-options.md +++ b/docs/api-reference/issue-types/options/add-dropdown-options.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, options, add
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-properties/{property_id}/options/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/
@@ -24,19 +24,19 @@ Create a new issue property option -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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`. @@ -111,7 +111,7 @@ Parent. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -130,7 +130,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -147,7 +147,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/", { method: "POST", headers: { diff --git a/docs/api-reference/issue-types/options/delete-dropdown-options.md b/docs/api-reference/issue-types/options/delete-dropdown-options.md index e05819a..67bb8ee 100644 --- a/docs/api-reference/issue-types/options/delete-dropdown-options.md +++ b/docs/api-reference/issue-types/options/delete-dropdown-options.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, options, del
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/
@@ -24,25 +24,25 @@ Delete an issue property option -Option id. +The unique identifier of the option. -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/issue-types/options/get-option-details.md b/docs/api-reference/issue-types/options/get-option-details.md index 45427d7..b39e21d 100644 --- a/docs/api-reference/issue-types/options/get-option-details.md +++ b/docs/api-reference/issue-types/options/get-option-details.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, options, ret
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/
@@ -24,25 +24,25 @@ Get issue property option by id -Option id. +The unique identifier of the option. -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -89,7 +89,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/options/list-dropdown-options.md b/docs/api-reference/issue-types/options/list-dropdown-options.md index c2fba59..1d6cf57 100644 --- a/docs/api-reference/issue-types/options/list-dropdown-options.md +++ b/docs/api-reference/issue-types/options/list-dropdown-options.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, options, lis
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-properties/{property_id}/options/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/
@@ -24,19 +24,19 @@ List issue property options -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/options/update-dropdown-options.md b/docs/api-reference/issue-types/options/update-dropdown-options.md index 316f8c2..573c7b3 100644 --- a/docs/api-reference/issue-types/options/update-dropdown-options.md +++ b/docs/api-reference/issue-types/options/update-dropdown-options.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, options, upd
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-properties/{property_id}/options/{option_id}/
@@ -24,25 +24,25 @@ Update an issue property option -Option id. +The unique identifier of the option. -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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`. @@ -117,7 +117,7 @@ Parent. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -136,7 +136,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -153,7 +153,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-properties/550e8400-e29b-41d4-a716-446655440001/options/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-properties/property-uuid/options/option-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/issue-types/properties/add-property.md b/docs/api-reference/issue-types/properties/add-property.md index b61b4cf..93d5a06 100644 --- a/docs/api-reference/issue-types/properties/add-property.md +++ b/docs/api-reference/issue-types/properties/add-property.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, properties,
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/
@@ -24,19 +24,19 @@ Create a new issue property -Project ID +The unique identifier of the project. - + -Workspace slug +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`. -Type ID +The unique identifier of the work item type. @@ -163,7 +163,7 @@ Formula config. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -183,7 +183,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -201,7 +201,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/", { method: "POST", headers: { diff --git a/docs/api-reference/issue-types/properties/delete-property.md b/docs/api-reference/issue-types/properties/delete-property.md index 379eab3..c20b207 100644 --- a/docs/api-reference/issue-types/properties/delete-property.md +++ b/docs/api-reference/issue-types/properties/delete-property.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, properties,
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/
@@ -24,25 +24,25 @@ Delete an issue property -Project ID +The unique identifier of the project. -Property id. +The unique identifier of the property. - + -Workspace slug +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`. -Type ID +The unique identifier of the work item type. @@ -66,9 +66,9 @@ Type ID ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/issue-types/properties/get-property-details.md b/docs/api-reference/issue-types/properties/get-property-details.md index 2f141cc..7f2f418 100644 --- a/docs/api-reference/issue-types/properties/get-property-details.md +++ b/docs/api-reference/issue-types/properties/get-property-details.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, properties,
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/
@@ -24,25 +24,25 @@ Get issue property by id -Project ID +The unique identifier of the project. -Property id. +The unique identifier of the property. - + -Workspace slug +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`. -Type ID +The unique identifier of the work item type. @@ -66,9 +66,9 @@ Type ID ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -89,7 +89,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/properties/list-properties.md b/docs/api-reference/issue-types/properties/list-properties.md index 4eaf258..445a0fc 100644 --- a/docs/api-reference/issue-types/properties/list-properties.md +++ b/docs/api-reference/issue-types/properties/list-properties.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, properties,
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/
@@ -24,19 +24,19 @@ List issue properties -Project ID +The unique identifier of the project. - + -Workspace slug +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`. -Type ID +The unique identifier of the work item type. @@ -60,9 +60,9 @@ Type ID ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/properties/update-property.md b/docs/api-reference/issue-types/properties/update-property.md index 2b786f9..e3cf870 100644 --- a/docs/api-reference/issue-types/properties/update-property.md +++ b/docs/api-reference/issue-types/properties/update-property.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, properties,
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/work-item-properties/{property_id}/
@@ -24,25 +24,25 @@ Update an issue property -Project ID +The unique identifier of the project. -Property id. +The unique identifier of the property. - + -Workspace slug +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`. -Type ID +The unique identifier of the work item type. @@ -169,7 +169,7 @@ Formula config. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -189,7 +189,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -207,7 +207,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/work-item-properties/property-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/issue-types/types/add-issue-type.md b/docs/api-reference/issue-types/types/add-issue-type.md index 5f9ce23..6c3644f 100644 --- a/docs/api-reference/issue-types/types/add-issue-type.md +++ b/docs/api-reference/issue-types/types/add-issue-type.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, types, creat
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/
@@ -24,13 +24,13 @@ Create a new issue type for a project -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,7 +99,7 @@ External id. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -118,7 +118,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -135,7 +135,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/", { method: "POST", headers: { diff --git a/docs/api-reference/issue-types/types/delete-issue-type.md b/docs/api-reference/issue-types/types/delete-issue-type.md index 5c0a191..81a5c57 100644 --- a/docs/api-reference/issue-types/types/delete-issue-type.md +++ b/docs/api-reference/issue-types/types/delete-issue-type.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, types, delet
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/
@@ -24,19 +24,19 @@ Delete an issue type -Project ID +The unique identifier of the project. - + -Workspace slug +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`. -Type id. +The unique identifier of the work item type. @@ -60,9 +60,9 @@ Type id. ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/issue-types/types/get-issue-type-details.md b/docs/api-reference/issue-types/types/get-issue-type-details.md index 159c2b1..b9f187b 100644 --- a/docs/api-reference/issue-types/types/get-issue-type-details.md +++ b/docs/api-reference/issue-types/types/get-issue-type-details.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, types, retri
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/
@@ -24,19 +24,19 @@ Retrieve an issue type by id -Project ID +The unique identifier of the project. - + -Workspace slug +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`. -Type id. +The unique identifier of the work item type. @@ -60,9 +60,9 @@ Type id. ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/types/get-work-item-type-schema.md b/docs/api-reference/issue-types/types/get-work-item-type-schema.md index a1ba0fc..1afb9be 100644 --- a/docs/api-reference/issue-types/types/get-work-item-type-schema.md +++ b/docs/api-reference/issue-types/types/get-work-item-type-schema.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, types, get w
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/schema/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/schema/
@@ -44,13 +44,13 @@ when creating/updating work items. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -95,9 +95,9 @@ Work item type ID. If not provided, returns schema for default type (when types ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/schema/?include=members&type_id=550e8400-e29b-41d4-a716-446655440000" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/schema/?include=members&type_id=type-uuid" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -107,7 +107,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/schema/?include=members&type_id=550e8400-e29b-41d4-a716-446655440000", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/schema/?include=members&type_id=type-uuid", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -118,7 +118,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/schema/?include=members&type_id=550e8400-e29b-41d4-a716-446655440000", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/schema/?include=members&type_id=type-uuid", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/types/list-issue-types.md b/docs/api-reference/issue-types/types/list-issue-types.md index 9ed36da..b52aefe 100644 --- a/docs/api-reference/issue-types/types/list-issue-types.md +++ b/docs/api-reference/issue-types/types/list-issue-types.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, types, list
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/
@@ -24,13 +24,13 @@ List all issue types for a project -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -54,9 +54,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -77,7 +77,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/types/update-issue-types.md b/docs/api-reference/issue-types/types/update-issue-types.md index 3f6d697..9875791 100644 --- a/docs/api-reference/issue-types/types/update-issue-types.md +++ b/docs/api-reference/issue-types/types/update-issue-types.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, types, updat
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-item-types/{type_id}/
@@ -24,19 +24,19 @@ Update an issue type -Project ID +The unique identifier of the project. - + -Workspace slug +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`. -Type id. +The unique identifier of the work item type. @@ -105,7 +105,7 @@ External id. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -124,7 +124,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -141,7 +141,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-item-types/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-item-types/type-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/issue-types/values/add-property-values.md b/docs/api-reference/issue-types/values/add-property-values.md index ebcd2b9..07607d9 100644 --- a/docs/api-reference/issue-types/values/add-property-values.md +++ b/docs/api-reference/issue-types/values/add-property-values.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, values, add
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/
@@ -24,25 +24,25 @@ Create or update the property value for a work item. Acts as an upsert operation -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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 id. +The unique identifier of the work item. @@ -93,7 +93,7 @@ Optional external source identifier (e.g., 'github', 'jira') ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -111,7 +111,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", headers={"X-API-Key": "your-api-key"}, json={ "value": "example text value", @@ -127,7 +127,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", { method: "POST", headers: { diff --git a/docs/api-reference/issue-types/values/delete-property-value.md b/docs/api-reference/issue-types/values/delete-property-value.md index 89ef089..c8b71bb 100644 --- a/docs/api-reference/issue-types/values/delete-property-value.md +++ b/docs/api-reference/issue-types/values/delete-property-value.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, values, dele
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/
@@ -24,25 +24,25 @@ Delete the property value(s) for a work item. For multi-value properties, delete -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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 id. +The unique identifier of the work item. @@ -66,9 +66,9 @@ Work item id. ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", { method: "DELETE", headers: { diff --git a/docs/api-reference/issue-types/values/get-property-value-detail.md b/docs/api-reference/issue-types/values/get-property-value-detail.md index 3020813..a3a405e 100644 --- a/docs/api-reference/issue-types/values/get-property-value-detail.md +++ b/docs/api-reference/issue-types/values/get-property-value-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, values, get
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/
@@ -24,25 +24,25 @@ Retrieve the property value(s) for a specific work item property. Returns a sing -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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 id. +The unique identifier of the work item. @@ -66,9 +66,9 @@ Work item id. ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -89,7 +89,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/values/list-property-values.md b/docs/api-reference/issue-types/values/list-property-values.md index df55213..3d3db83 100644 --- a/docs/api-reference/issue-types/values/list-property-values.md +++ b/docs/api-reference/issue-types/values/list-property-values.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, values, list
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/
@@ -24,25 +24,25 @@ Retrieve the property value(s) for a specific work item property. Returns a sing -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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 id. +The unique identifier of the work item. @@ -66,9 +66,9 @@ Work item id. ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -89,7 +89,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", { method: "GET", headers: { diff --git a/docs/api-reference/issue-types/values/update-property-value.md b/docs/api-reference/issue-types/values/update-property-value.md index 9000acc..46c8d4a 100644 --- a/docs/api-reference/issue-types/values/update-property-value.md +++ b/docs/api-reference/issue-types/values/update-property-value.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue types, values, upda
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/work-item-properties/{property_id}/values/
@@ -24,25 +24,25 @@ Update an existing property value for a work item (partial update) -Project ID +The unique identifier of the project. -Property ID +The unique identifier of the property. - + -Workspace slug +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 id. +The unique identifier of the work item. @@ -93,7 +93,7 @@ Optional external source identifier (e.g., 'github', 'jira') ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -109,7 +109,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", headers={"X-API-Key": "your-api-key"}, json={ "value": "updated text value" @@ -123,7 +123,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/work-item-properties/550e8400-e29b-41d4-a716-446655440001/values/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/work-item-properties/property-uuid/values/", { method: "PATCH", headers: { diff --git a/docs/api-reference/issue/add-issue.md b/docs/api-reference/issue/add-issue.md index 1a468b8..9b6cb5b 100644 --- a/docs/api-reference/issue/add-issue.md +++ b/docs/api-reference/issue/add-issue.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue, create a work item
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/
@@ -24,13 +24,13 @@ Create a new work item in the specified project with the provided details. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -211,7 +211,7 @@ Type. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -238,7 +238,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -262,26 +262,23 @@ print(response.json()) @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/resource-id-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/issue/get-issue-detail.md b/docs/api-reference/issue/get-issue-detail.md index 2a7f36f..437a8d2 100644 --- a/docs/api-reference/issue/get-issue-detail.md +++ b/docs/api-reference/issue/get-issue-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue, retrieve a work it
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{resource_id}/
@@ -22,21 +22,21 @@ Retrieve details of a specific work item.
- + -Pk. +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,9 +99,9 @@ Field to order results by. Prefix with '-' for descending order ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/?expand=assignees&external_id=1234567890" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/resource-id-uuid/?expand=assignees&external_id=1234567890" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -111,7 +111,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/?expand=assignees&external_id=1234567890", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/resource-id-uuid/?expand=assignees&external_id=1234567890", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -122,7 +122,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/?expand=assignees&external_id=1234567890", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/resource-id-uuid/?expand=assignees&external_id=1234567890", { method: "GET", headers: { diff --git a/docs/api-reference/issue/get-issue-sequence-id.md b/docs/api-reference/issue/get-issue-sequence-id.md index cb51d5f..3bd935f 100644 --- a/docs/api-reference/issue/get-issue-sequence-id.md +++ b/docs/api-reference/issue/get-issue-sequence-id.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue, retrieve a work it
GET - /api/v1/workspaces/{slug}/work-items/{project_identifier}-{issue_identifier}/ + /api/v1/workspaces/{workspace_slug}/work-items/{project_identifier}-{issue_identifier}/
@@ -24,19 +24,19 @@ Retrieve a specific work item using workspace slug, project identifier, and issu -Issue sequence ID (numeric identifier within project) +The numeric issue identifier. -Project identifier (unique string within workspace) +The project identifier key. - + -Workspace slug +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`. @@ -62,7 +62,7 @@ Workspace slug curl -X GET \ "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/PROJ-123/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` diff --git a/docs/api-reference/issue/list-issues.md b/docs/api-reference/issue/list-issues.md index baacd4a..1a590bb 100644 --- a/docs/api-reference/issue/list-issues.md +++ b/docs/api-reference/issue/list-issues.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue, list all work item
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/
@@ -24,13 +24,13 @@ Retrieve a paginated list of all work items in a project. Supports filtering, or -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -105,9 +105,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -117,7 +117,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -128,7 +128,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/issue/search-issues.md b/docs/api-reference/issue/search-issues.md index cba5eb5..65bba30 100644 --- a/docs/api-reference/issue/search-issues.md +++ b/docs/api-reference/issue/search-issues.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue, search work items
GET - /api/v1/workspaces/{slug}/work-items/search/ + /api/v1/workspaces/{workspace_slug}/work-items/search/
@@ -22,9 +22,9 @@ Perform semantic search across issue names, sequence IDs, and project identifier
- + -Workspace slug +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`. @@ -81,9 +81,9 @@ Whether to search across entire workspace or within specific project ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/?limit=10&project_id=550e8400-e29b-41d4-a716-446655440000" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/?limit=10&project_id=project-uuid" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -93,7 +93,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/?limit=10&project_id=550e8400-e29b-41d4-a716-446655440000", + "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/?limit=10&project_id=project-uuid", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -104,7 +104,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/?limit=10&project_id=550e8400-e29b-41d4-a716-446655440000", + "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/?limit=10&project_id=project-uuid", { method: "GET", headers: { diff --git a/docs/api-reference/issue/update-issue-detail.md b/docs/api-reference/issue/update-issue-detail.md index 2109ea9..02e5b10 100644 --- a/docs/api-reference/issue/update-issue-detail.md +++ b/docs/api-reference/issue/update-issue-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, issue, update a work item
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{resource_id}/
@@ -22,21 +22,21 @@ Partially update an existing work item with the provided fields. Supports extern
- + -Pk. +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -217,7 +217,7 @@ Type. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -242,7 +242,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -265,7 +265,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/resource-id-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/label/add-label.md b/docs/api-reference/label/add-label.md index dcdcb0b..2f4f8cf 100644 --- a/docs/api-reference/label/add-label.md +++ b/docs/api-reference/label/add-label.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, label, create a label
POST - /api/v1/workspaces/{slug}/projects/{project_id}/labels/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/
@@ -24,13 +24,13 @@ Create a new label in the specified project with name, color, and description. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -105,7 +105,7 @@ Sort order. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -125,7 +125,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -142,23 +142,20 @@ print(response.json()) @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/label-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/label-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/label/get-label-detail.md b/docs/api-reference/label/get-label-detail.md index ebc13ea..83284f5 100644 --- a/docs/api-reference/label/get-label-detail.md +++ b/docs/api-reference/label/get-label-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, label, retrieve a label
GET - /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/{label_id}/
@@ -22,21 +22,21 @@ Retrieve details of a specific label.
- + -Label ID +The unique identifier of the label. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/label-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/label-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/label-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/label/list-labels.md b/docs/api-reference/label/list-labels.md index 2323103..202fb75 100644 --- a/docs/api-reference/label/list-labels.md +++ b/docs/api-reference/label/list-labels.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, label, list all labels
GET - /api/v1/workspaces/{slug}/projects/{project_id}/labels/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/
@@ -24,13 +24,13 @@ Retrieve all labels in a project. Supports filtering by name and color. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -93,9 +93,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -105,7 +105,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -116,7 +116,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/label/update-label-detail.md b/docs/api-reference/label/update-label-detail.md index 1a9e970..73d6ae9 100644 --- a/docs/api-reference/label/update-label-detail.md +++ b/docs/api-reference/label/update-label-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, label, update a label
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/labels/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/labels/{label_id}/
@@ -22,21 +22,21 @@ Partially update an existing label's properties like name, color, or description
- + -Label ID +The unique identifier of the label. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -111,7 +111,7 @@ Sort order. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/label-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -131,7 +131,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/label-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -149,7 +149,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/labels/label-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/link/add-link.md b/docs/api-reference/link/add-link.md index 3f79c4b..bd37d03 100644 --- a/docs/api-reference/link/add-link.md +++ b/docs/api-reference/link/add-link.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, link, create a link
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/links/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/
@@ -22,21 +22,21 @@ Add a new external link to a work item with URL, title, and metadata.
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -81,7 +81,7 @@ Url. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -98,7 +98,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/", headers={"X-API-Key": "your-api-key"}, json={ "url": "https://example.com/resource", @@ -113,7 +113,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/", { method: "POST", headers: { diff --git a/docs/api-reference/link/delete-link.md b/docs/api-reference/link/delete-link.md index faddad6..191e5ee 100644 --- a/docs/api-reference/link/delete-link.md +++ b/docs/api-reference/link/delete-link.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, link, delete a link
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/links/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/{resource_id}/
@@ -22,27 +22,27 @@ Permanently remove an external link from a work item.
- + -Issue ID +The unique identifier of the work item. - + -Link ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/link/get-link-detail.md b/docs/api-reference/link/get-link-detail.md index e9abd0f..d9b5aa4 100644 --- a/docs/api-reference/link/get-link-detail.md +++ b/docs/api-reference/link/get-link-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, link, retrieve a link
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/links/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/{resource_id}/
@@ -22,27 +22,27 @@ Retrieve details of a specific work item link.
- + -Issue ID +The unique identifier of the work item. - + -Link ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,9 +99,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -111,7 +111,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -122,7 +122,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/link/list-links.md b/docs/api-reference/link/list-links.md index 21c755d..e0c5d2f 100644 --- a/docs/api-reference/link/list-links.md +++ b/docs/api-reference/link/list-links.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, link, list all links
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/links/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/
@@ -22,21 +22,21 @@ Retrieve all links associated with a work item. Supports filtering by URL, title
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,9 +99,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -111,7 +111,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -122,7 +122,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/link/update-link-detail.md b/docs/api-reference/link/update-link-detail.md index bd5073e..fb05ab2 100644 --- a/docs/api-reference/link/update-link-detail.md +++ b/docs/api-reference/link/update-link-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, link, update a link
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/links/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/{resource_id}/
@@ -22,27 +22,27 @@ Modify the URL, title, or metadata of an existing issue link.
- + -Issue ID +The unique identifier of the work item. - + -Link ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -87,7 +87,7 @@ Url. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -104,7 +104,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "url": "https://example.com/resource", @@ -119,7 +119,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/links/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/resource-id-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/members/add-project-member.md b/docs/api-reference/members/add-project-member.md index 9f7cad0..7e73353 100644 --- a/docs/api-reference/members/add-project-member.md +++ b/docs/api-reference/members/add-project-member.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, members, create project m
POST - /api/v1/workspaces/{slug}/projects/{project_id}/project-members/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/project-members/
@@ -24,13 +24,13 @@ Create a new project member -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -77,7 +77,7 @@ Member. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -94,7 +94,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/", headers={"X-API-Key": "your-api-key"}, json={ "member": "550e8400-e29b-41d4-a716-446655440000", @@ -109,7 +109,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/", { method: "POST", headers: { diff --git a/docs/api-reference/members/delete-project-member.md b/docs/api-reference/members/delete-project-member.md index ab0e8a8..cb98b4b 100644 --- a/docs/api-reference/members/delete-project-member.md +++ b/docs/api-reference/members/delete-project-member.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, members, delete project m
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/project-members/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/project-members/{member_id}/
@@ -22,21 +22,21 @@ Delete a project member
- + -Pk. +The unique identifier of the member. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/members/get-project-member-detail.md b/docs/api-reference/members/get-project-member-detail.md index 50dee43..238085f 100644 --- a/docs/api-reference/members/get-project-member-detail.md +++ b/docs/api-reference/members/get-project-member-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, members, get project memb
GET - /api/v1/workspaces/{slug}/projects/{project_id}/project-members/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/project-members/{member_id}/
@@ -22,21 +22,21 @@ Retrieve a project member by ID.
- + -Pk. +The unique identifier of the member. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/members/get-project-members.md b/docs/api-reference/members/get-project-members.md index 456dda3..e777e91 100644 --- a/docs/api-reference/members/get-project-members.md +++ b/docs/api-reference/members/get-project-members.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, members, list all project
GET - /api/v1/workspaces/{slug}/projects/{project_id}/project-members/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/project-members/
@@ -24,13 +24,13 @@ Retrieve all users who are members of the specified project. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -54,9 +54,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -77,7 +77,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/", { method: "GET", headers: { diff --git a/docs/api-reference/members/get-workspace-members.md b/docs/api-reference/members/get-workspace-members.md index 7029db0..d106322 100644 --- a/docs/api-reference/members/get-workspace-members.md +++ b/docs/api-reference/members/get-workspace-members.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, members, get all workspac
GET - /api/v1/workspaces/{slug}/members/ + /api/v1/workspaces/{workspace_slug}/members/
@@ -22,9 +22,9 @@ Retrieve all users who are members of the specified workspace.
- + -Workspace slug +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`. @@ -50,7 +50,7 @@ Workspace slug curl -X GET \ "https://api.plane.so/api/v1/workspaces/my-workspace/members/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` diff --git a/docs/api-reference/members/remove-workspace-member.md b/docs/api-reference/members/remove-workspace-member.md index 5de4a9a..06a458f 100644 --- a/docs/api-reference/members/remove-workspace-member.md +++ b/docs/api-reference/members/remove-workspace-member.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, members, remove workspace
POST - /api/v1/workspaces/{slug}/members/remove/ + /api/v1/workspaces/{workspace_slug}/members/remove/
@@ -22,9 +22,9 @@ Remove a member from the workspace, deactivate them from all projects, and reduc
- + -Workspace slug +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`. @@ -50,7 +50,7 @@ Workspace slug curl -X POST \ "https://api.plane.so/api/v1/workspaces/my-workspace/members/remove/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` diff --git a/docs/api-reference/members/update-project-member.md b/docs/api-reference/members/update-project-member.md index bfff7c9..e4d3943 100644 --- a/docs/api-reference/members/update-project-member.md +++ b/docs/api-reference/members/update-project-member.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, members, update project m
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/project-members/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/project-members/{member_id}/
@@ -22,21 +22,21 @@ Update a project member
- + -Pk. +The unique identifier of the member. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -83,7 +83,7 @@ Member. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -100,7 +100,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "member": "550e8400-e29b-41d4-a716-446655440000", @@ -115,7 +115,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/project-members/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/project-members/member-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/milestones/add-milestone.md b/docs/api-reference/milestones/add-milestone.md index dc42cec..fb13cef 100644 --- a/docs/api-reference/milestones/add-milestone.md +++ b/docs/api-reference/milestones/add-milestone.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, milestones, create milest
POST - /api/v1/workspaces/{slug}/projects/{project_id}/milestones/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/milestones/
@@ -24,13 +24,13 @@ Create a new milestone in a project. -Project id. +The unique identifier of the project. - + -Slug. +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`. @@ -87,7 +87,7 @@ API key authentication or an OAuth token with equivalent access. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -106,7 +106,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/", headers={"X-API-Key": "your-api-key"}, json={ "title": "Example Name", @@ -122,22 +122,19 @@ print(response.json()) @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/milestone-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/milestone-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/milestones/get-milestone-detail.md b/docs/api-reference/milestones/get-milestone-detail.md index b13d653..7ec8ad9 100644 --- a/docs/api-reference/milestones/get-milestone-detail.md +++ b/docs/api-reference/milestones/get-milestone-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, milestones, get milestone
GET - /api/v1/workspaces/{slug}/projects/{project_id}/milestones/{milestone_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/milestones/{milestone_id}/
@@ -24,19 +24,19 @@ Retrieve a specific milestone by its ID. -Milestone id. +The unique identifier of the milestone. -Project id. +The unique identifier of the project. - + -Slug. +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`. @@ -60,9 +60,9 @@ API key authentication or an OAuth token with equivalent access. ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/milestone-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/milestone-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/milestone-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/milestones/list-milestone-work-items.md b/docs/api-reference/milestones/list-milestone-work-items.md index f7a2094..5bd87c2 100644 --- a/docs/api-reference/milestones/list-milestone-work-items.md +++ b/docs/api-reference/milestones/list-milestone-work-items.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, milestones, list mileston
GET - /api/v1/workspaces/{slug}/projects/{project_id}/milestones/{milestone_id}/work-items/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/milestones/{milestone_id}/work-items/
@@ -24,19 +24,19 @@ List all work items for a milestone. -Milestone id. +The unique identifier of the milestone. -Project id. +The unique identifier of the project. - + -Slug. +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`. @@ -60,9 +60,9 @@ API key authentication or an OAuth token with equivalent access. ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/work-items/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/milestone-uuid/work-items/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/work-items/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/milestone-uuid/work-items/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/550e8400-e29b-41d4-a716-446655440001/work-items/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/milestone-uuid/work-items/", { method: "GET", headers: { diff --git a/docs/api-reference/milestones/list-milestones.md b/docs/api-reference/milestones/list-milestones.md index 6e4b318..c4ecea3 100644 --- a/docs/api-reference/milestones/list-milestones.md +++ b/docs/api-reference/milestones/list-milestones.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, milestones, list mileston
GET - /api/v1/workspaces/{slug}/projects/{project_id}/milestones/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/milestones/
@@ -24,13 +24,13 @@ List all milestones in a project. -Project id. +The unique identifier of the project. - + -Slug. +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`. @@ -54,9 +54,9 @@ API key authentication or an OAuth token with equivalent access. ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/milestones/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/milestones/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +76,12 @@ print(response.json()) @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/resource-id-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/module/get-module-detail.md b/docs/api-reference/module/get-module-detail.md index 2741d17..cac9cf7 100644 --- a/docs/api-reference/module/get-module-detail.md +++ b/docs/api-reference/module/get-module-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, module, retrieve a module
GET - /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{resource_id}/
@@ -22,21 +22,21 @@ Retrieve details of a specific module.
- + -Module ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/resource-id-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/module/list-archived-modules.md b/docs/api-reference/module/list-archived-modules.md index 616c34f..98fed23 100644 --- a/docs/api-reference/module/list-archived-modules.md +++ b/docs/api-reference/module/list-archived-modules.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, module, list all archived
GET - /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/archived-modules/
@@ -24,13 +24,13 @@ Retrieve all modules that have been archived in the project. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -93,9 +93,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-modules/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-modules/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -105,7 +105,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-modules/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-modules/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -116,7 +116,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-modules/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-modules/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/module/list-module-work-items.md b/docs/api-reference/module/list-module-work-items.md index 389c309..aa8d53f 100644 --- a/docs/api-reference/module/list-module-work-items.md +++ b/docs/api-reference/module/list-module-work-items.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, module, list all work ite
GET - /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/module-issues/
@@ -24,19 +24,19 @@ Retrieve all work items assigned to a module with detailed information. -Module ID +The unique identifier of the module. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,9 +99,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440001/module-issues/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/module-issues/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -111,7 +111,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440001/module-issues/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/module-issues/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -122,7 +122,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440001/module-issues/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/module-issues/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/module/list-modules.md b/docs/api-reference/module/list-modules.md index cd49051..fd63d62 100644 --- a/docs/api-reference/module/list-modules.md +++ b/docs/api-reference/module/list-modules.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, module, list all modules
GET - /api/v1/workspaces/{slug}/projects/{project_id}/modules/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/
@@ -24,13 +24,13 @@ Retrieve all modules in a project. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -93,9 +93,9 @@ Number of results per page (default: 20, max: 100) ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/?cursor=20:1:0&expand=assignees" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/?cursor=20:1:0&expand=assignees" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -105,7 +105,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -116,7 +116,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/module/remove-module-work-item.md b/docs/api-reference/module/remove-module-work-item.md index 9de2c0e..ad78720 100644 --- a/docs/api-reference/module/remove-module-work-item.md +++ b/docs/api-reference/module/remove-module-work-item.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, module, remove work item
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/modules/{module_id}/module-issues/{issue_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/module-issues/{work_item_id}/
@@ -22,27 +22,27 @@ Remove a work item from a module while keeping the work item in the project.
- + -Issue ID +The unique identifier of the work item. -Module ID +The unique identifier of the module. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440001/module-issues/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/module-issues/work-item-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440001/module-issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/module-issues/work-item-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440001/module-issues/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/module-issues/work-item-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/module/unarchive-module.md b/docs/api-reference/module/unarchive-module.md index 82b83ac..0429411 100644 --- a/docs/api-reference/module/unarchive-module.md +++ b/docs/api-reference/module/unarchive-module.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, module, restore a module
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/archived-modules/{pk}/unarchive/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/archived-modules/{resource_id}/unarchive/
@@ -22,21 +22,21 @@ Restore an archived module to active status, making it available for regular use
- + -Module ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-modules/550e8400-e29b-41d4-a716-446655440000/unarchive/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-modules/resource-id-uuid/unarchive/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-modules/550e8400-e29b-41d4-a716-446655440000/unarchive/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-modules/resource-id-uuid/unarchive/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -83,7 +83,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archived-modules/550e8400-e29b-41d4-a716-446655440000/unarchive/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archived-modules/resource-id-uuid/unarchive/", { method: "DELETE", headers: { diff --git a/docs/api-reference/module/update-module-detail.md b/docs/api-reference/module/update-module-detail.md index 64ea24d..ae014da 100644 --- a/docs/api-reference/module/update-module-detail.md +++ b/docs/api-reference/module/update-module-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, module, update module det
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/modules/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{resource_id}/
@@ -22,21 +22,21 @@ Modify an existing module's properties like name, description, status, or timeli
- + -Module ID +The unique identifier of the resource. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -128,7 +128,7 @@ External id. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -149,7 +149,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -168,7 +168,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/modules/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/resource-id-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/page/add-project-page.md b/docs/api-reference/page/add-project-page.md index 1b69ea4..c66762f 100644 --- a/docs/api-reference/page/add-project-page.md +++ b/docs/api-reference/page/add-project-page.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, page, create a project pa
POST - /api/v1/workspaces/{slug}/projects/{project_id}/pages/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/pages/
@@ -24,13 +24,13 @@ Create a project page -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -124,7 +124,7 @@ Description html. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/pages/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/pages/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -149,7 +149,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/pages/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/pages/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -171,28 +171,25 @@ print(response.json()) @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/pages/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/pages/page-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/pages/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/pages/page-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/page/get-workspace-page.md b/docs/api-reference/page/get-workspace-page.md index 6725cf6..9a6de60 100644 --- a/docs/api-reference/page/get-workspace-page.md +++ b/docs/api-reference/page/get-workspace-page.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, page, retrieve a wiki pag
GET - /api/v1/workspaces/{slug}/pages/{pk}/ + /api/v1/workspaces/{workspace_slug}/pages/{page_id}/
@@ -22,15 +22,15 @@ Get a workspace page by ID
- + -Page ID +The unique identifier of the page. - + -Workspace slug +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`. @@ -54,9 +54,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/pages/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/pages/page-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/pages/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/pages/page-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +76,12 @@ print(response.json()) @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/features/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/features/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +76,12 @@ print(response.json()) @@ -66,7 +66,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/archive/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/archive/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -76,15 +76,12 @@ print(response.status_code) @@ -99,7 +99,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/states/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/?cursor=20:1:0&expand=assignees", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -110,7 +110,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/states/?cursor=20:1:0&expand=assignees", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/?cursor=20:1:0&expand=assignees", { method: "GET", headers: { diff --git a/docs/api-reference/state/update-state-detail.md b/docs/api-reference/state/update-state-detail.md index db2819c..f199260 100644 --- a/docs/api-reference/state/update-state-detail.md +++ b/docs/api-reference/state/update-state-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, state, update a state
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/states/{state_id}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/{state_id}/
@@ -24,19 +24,19 @@ Partially update an existing workflow state's properties like name, color, or gr -Project ID +The unique identifier of the project. - + -Workspace slug +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`. -State ID +The unique identifier of the state. @@ -128,7 +128,7 @@ External id. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/states/550e8400-e29b-41d4-a716-446655440001/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/state-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -148,7 +148,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/states/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/state-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "name": "Example Name", @@ -166,7 +166,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/states/550e8400-e29b-41d4-a716-446655440001/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/states/state-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/sticky/add-sticky.md b/docs/api-reference/sticky/add-sticky.md index 87922f2..a0ef046 100644 --- a/docs/api-reference/sticky/add-sticky.md +++ b/docs/api-reference/sticky/add-sticky.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, sticky, create a sticky
POST - /api/v1/workspaces/{slug}/stickies/ + /api/v1/workspaces/{workspace_slug}/stickies/
@@ -22,9 +22,9 @@ Create a new sticky in the workspace
- + -Workspace slug +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/docs/api-reference/sticky/delete-sticky.md b/docs/api-reference/sticky/delete-sticky.md index 871a8ba..f8b6897 100644 --- a/docs/api-reference/sticky/delete-sticky.md +++ b/docs/api-reference/sticky/delete-sticky.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, sticky, delete a sticky
DELETE - /api/v1/workspaces/{slug}/stickies/{pk}/ + /api/v1/workspaces/{workspace_slug}/stickies/{resource_id}/
@@ -22,15 +22,15 @@ Delete a sticky by its ID
- + -A UUID string identifying this Sticky. +The unique identifier of the resource. - + -Workspace slug +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`. @@ -54,9 +54,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -76,15 +76,12 @@ print(response.status_code) @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/resource-id-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +76,12 @@ print(response.json()) diff --git a/docs/api-reference/sticky/update-sticky-detail.md b/docs/api-reference/sticky/update-sticky-detail.md index ed1763e..f557918 100644 --- a/docs/api-reference/sticky/update-sticky-detail.md +++ b/docs/api-reference/sticky/update-sticky-detail.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, sticky, update a sticky
PATCH - /api/v1/workspaces/{slug}/stickies/{pk}/ + /api/v1/workspaces/{workspace_slug}/stickies/{resource_id}/
@@ -22,15 +22,15 @@ Update a sticky by its ID
- + -A UUID string identifying this Sticky. +The unique identifier of the resource. - + -Workspace slug +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`. @@ -129,7 +129,7 @@ Updated by. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/resource-id-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -155,7 +155,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/stickies/resource-id-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "deleted_at": "2024-01-01T00:00:00Z", @@ -178,29 +178,26 @@ print(response.json()) @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/550e8400-e29b-41d4-a716-446655440001/projects/", + "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/projects/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -77,7 +77,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/550e8400-e29b-41d4-a716-446655440001/projects/", + "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/projects/", { method: "GET", headers: { diff --git a/docs/api-reference/teamspace/list-teamspaces.md b/docs/api-reference/teamspace/list-teamspaces.md index dda2866..7f17138 100644 --- a/docs/api-reference/teamspace/list-teamspaces.md +++ b/docs/api-reference/teamspace/list-teamspaces.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, teamspace, list all teams
GET - /api/v1/workspaces/{slug}/teamspaces/ + /api/v1/workspaces/{workspace_slug}/teamspaces/
@@ -22,9 +22,9 @@ List all teamspaces in the workspace
- + -Workspace slug +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`. @@ -71,7 +71,7 @@ Number of results per page (default: 20, max: 100) curl -X GET \ "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/?cursor=20:1:0&per_page=20" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` diff --git a/docs/api-reference/teamspace/remove-projects-from-teamspace.md b/docs/api-reference/teamspace/remove-projects-from-teamspace.md index be751e0..d03cfba 100644 --- a/docs/api-reference/teamspace/remove-projects-from-teamspace.md +++ b/docs/api-reference/teamspace/remove-projects-from-teamspace.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, teamspace, remove project
DELETE - /api/v1/workspaces/{slug}/teamspaces/{teamspace_id}/projects/ + /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/projects/
@@ -22,15 +22,15 @@ Remove projects from a teamspace by its ID
- + -Workspace slug +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`. -Teamspace ID +The unique identifier of the teamspace. @@ -54,9 +54,9 @@ Teamspace ID ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/550e8400-e29b-41d4-a716-446655440001/projects/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/projects/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/550e8400-e29b-41d4-a716-446655440001/projects/", + "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/projects/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -77,7 +77,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/550e8400-e29b-41d4-a716-446655440001/projects/", + "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/projects/", { method: "DELETE", headers: { diff --git a/docs/api-reference/teamspace/remove-teamspace-members.md b/docs/api-reference/teamspace/remove-teamspace-members.md index 9df05a2..53c6a81 100644 --- a/docs/api-reference/teamspace/remove-teamspace-members.md +++ b/docs/api-reference/teamspace/remove-teamspace-members.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, teamspace, remove members
DELETE - /api/v1/workspaces/{slug}/teamspaces/{teamspace_id}/members/ + /api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/members/
@@ -22,15 +22,15 @@ Delete members from a teamspace by its ID
- + -Workspace slug +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`. -Teamspace ID +The unique identifier of the teamspace. @@ -54,9 +54,9 @@ Teamspace ID ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/550e8400-e29b-41d4-a716-446655440001/members/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/members/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/550e8400-e29b-41d4-a716-446655440001/members/", + "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/members/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -76,15 +76,12 @@ print(response.status_code) @@ -84,7 +84,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/pages/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/pages/page-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -95,7 +95,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/pages/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/pages/page-uuid/", { method: "GET", headers: { diff --git a/docs/api-reference/work-item-pages/list-work-item-pages.md b/docs/api-reference/work-item-pages/list-work-item-pages.md index dbd31c9..c615f61 100644 --- a/docs/api-reference/work-item-pages/list-work-item-pages.md +++ b/docs/api-reference/work-item-pages/list-work-item-pages.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, work item pages, list wor
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/pages/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/pages/
@@ -22,27 +22,27 @@ Retrieve all page links associated with a work item.
- + -Issue ID +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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 id. +The unique identifier of the work item. @@ -93,9 +93,9 @@ API key authentication or an OAuth token with equivalent access. ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/pages/?cursor=20:1:0&order_by=-created_at" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/pages/?cursor=20:1:0&order_by=-created_at" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -105,7 +105,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/pages/?cursor=20:1:0&order_by=-created_at", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/pages/?cursor=20:1:0&order_by=-created_at", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -116,7 +116,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/pages/?cursor=20:1:0&order_by=-created_at", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/pages/?cursor=20:1:0&order_by=-created_at", { method: "GET", headers: { diff --git a/docs/api-reference/work-item-relations/create-work-item-relation.md b/docs/api-reference/work-item-relations/create-work-item-relation.md new file mode 100644 index 0000000..691eacf --- /dev/null +++ b/docs/api-reference/work-item-relations/create-work-item-relation.md @@ -0,0 +1,178 @@ +--- +title: Create work item relation +description: Create work item relation via Plane API. HTTP request format, parameters, scopes, and example responses for create work item relation. +keywords: plane, plane api, rest api, api integration, work item relations, create work item relation +--- + +# Create work item relation + +
+ POST + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/relations/ +
+ +
+
+ +Create relationships between work items. Supports various relation types including blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, and finish_after. + +
+ +### Path Parameters + +
+ + + +The unique identifier of the work item. + + + + + +The unique identifier of the project. + + + + + +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 + +
+ + + +Type of relationship between work items + +- `blocking` - Blocking +- `blocked_by` - Blocked By +- `duplicate` - Duplicate +- `relates_to` - Relates To +- `start_before` - Start Before +- `start_after` - Start After +- `finish_before` - Finish Before +- `finish_after` - Finish After + + + + + +Array of work item IDs to create relations with + + + +
+
+ +
+ +### Scopes + +`projects.work_items:write` + +
+ +
+ +
+ + + + + + + + + +```json +[ + [ + { + "id": "550e8400-e29b-41d4-a716-446655440000", + "name": "Example Name", + "sequence_id": 42, + "project_id": "550e8400-e29b-41d4-a716-446655440000", + "relation_type": "blocked_by", + "state_id": "550e8400-e29b-41d4-a716-446655440000", + "priority": "high", + "type_id": "550e8400-e29b-41d4-a716-446655440000", + "is_epic": false, + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z", + "created_by": "550e8400-e29b-41d4-a716-446655440000", + "updated_by": "550e8400-e29b-41d4-a716-446655440000" + } + ] +] +``` + + + +
+ +
diff --git a/docs/api-reference/work-item-relations/list-work-item-relations.md b/docs/api-reference/work-item-relations/list-work-item-relations.md new file mode 100644 index 0000000..d60c640 --- /dev/null +++ b/docs/api-reference/work-item-relations/list-work-item-relations.md @@ -0,0 +1,158 @@ +--- +title: List work item relations +description: List work item relations via Plane API. HTTP request format, parameters, scopes, and example responses for list work item relations. +keywords: plane, plane api, rest api, api integration, work item relations, list work item relations +--- + +# List work item relations + +
+ GET + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/relations/ +
+ +
+
+ +Retrieve all relationships for a work item including blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, and finish_after relations. + +
+ +### Path Parameters + +
+ + + +The unique identifier of the work item. + + + + + +The unique identifier of the project. + + + + + +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 + +
+ + + +Pagination cursor for getting next set of results + + + + + +Comma-separated list of related fields to expand in response + + + + + +Comma-separated list of fields to include in response + + + + + +Field to order results by. Prefix with '-' for descending order + + + + + +Number of results per page (default: 20, max: 100) + + + +
+
+ +
+ +### Scopes + +`projects.work_items:read` + +
+ +
+ +
+ + + + + + + + + +```json +{ + "blocking": ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440000"], + "blocked_by": ["550e8400-e29b-41d4-a716-446655440000"], + "duplicate": [], + "relates_to": ["550e8400-e29b-41d4-a716-446655440000"], + "start_after": [], + "start_before": ["550e8400-e29b-41d4-a716-446655440000"], + "finish_after": [], + "finish_before": [] +} +``` + + + +
+ +
diff --git a/docs/api-reference/work-item-relations/overview.md b/docs/api-reference/work-item-relations/overview.md new file mode 100644 index 0000000..e1c8842 --- /dev/null +++ b/docs/api-reference/work-item-relations/overview.md @@ -0,0 +1,73 @@ +--- +title: Overview +description: Plane Work Item Relations API overview. Learn how to list, create, and remove work item relationships using the Plane API. +keywords: plane, plane api, rest api, api integration, work item relations, dependencies, blocking relationships +--- + +# Overview + +Work item relations let you model dependencies and planning constraints between work items, including blocking, duplicate, relates-to, and scheduling relationships. + +[Learn more about Work Items](https://docs.plane.so/core-concepts/issues) + +
+
+ +## The Work Item Relations Response + +### Attributes + +- `blocking` _array_ + + List of issue IDs that are blocking this issue + +- `blocked_by` _array_ + + List of issue IDs that this issue is blocked by + +- `duplicate` _array_ + + List of issue IDs that are duplicates of this issue + +- `relates_to` _array_ + + List of issue IDs that relate to this issue + +- `start_after` _array_ + + List of issue IDs that start after this issue + +- `start_before` _array_ + + List of issue IDs that start before this issue + +- `finish_after` _array_ + + List of issue IDs that finish after this issue + +- `finish_before` _array_ + + List of issue IDs that finish before this issue + +
+
+ + + +```json +{ + "blocking": ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440000"], + "blocked_by": ["550e8400-e29b-41d4-a716-446655440000"], + "duplicate": [], + "relates_to": ["550e8400-e29b-41d4-a716-446655440000"], + "start_after": [], + "start_before": ["550e8400-e29b-41d4-a716-446655440000"], + "finish_after": [], + "finish_before": [] +} +``` + + + +
+
diff --git a/docs/api-reference/work-item-relations/remove-work-item-relation.md b/docs/api-reference/work-item-relations/remove-work-item-relation.md new file mode 100644 index 0000000..602b196 --- /dev/null +++ b/docs/api-reference/work-item-relations/remove-work-item-relation.md @@ -0,0 +1,134 @@ +--- +title: Remove work item relation +description: Remove work item relation via Plane API. HTTP request format, parameters, scopes, and example responses for remove work item relation. +keywords: plane, plane api, rest api, api integration, work item relations, remove work item relation +--- + +# Remove work item relation + +
+ POST + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/relations/remove/ +
+ +
+
+ +Remove a relationship between work items by specifying the related work item ID. + +
+ +### Path Parameters + +
+ + + +The unique identifier of the work item. + + + + + +The unique identifier of the project. + + + + + +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 + +
+ + + +ID of the related work item to remove relation with + + + +
+
+ +
+ +### Scopes + +`projects.work_items:write` + +
+ +
+ +
+ + + + + + + + + +No response body. + + + +
+ +
diff --git a/docs/api-reference/worklogs/create-worklog.md b/docs/api-reference/worklogs/create-worklog.md index d827c10..78bd657 100644 --- a/docs/api-reference/worklogs/create-worklog.md +++ b/docs/api-reference/worklogs/create-worklog.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, worklogs, create a worklo
POST - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/worklogs/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/worklogs/
@@ -22,21 +22,21 @@ Create a new worklog entry
- + -Issue id. +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -93,7 +93,7 @@ Updated by. ```bash curl -X POST \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -112,7 +112,7 @@ curl -X POST \ import requests response = requests.post( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/", headers={"X-API-Key": "your-api-key"}, json={ "description": "Example description", @@ -129,7 +129,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/", { method: "POST", headers: { diff --git a/docs/api-reference/worklogs/delete-worklog.md b/docs/api-reference/worklogs/delete-worklog.md index 8b4fca4..4b98163 100644 --- a/docs/api-reference/worklogs/delete-worklog.md +++ b/docs/api-reference/worklogs/delete-worklog.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, worklogs, delete a worklo
DELETE - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/worklogs/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/worklogs/{worklog_id}/
@@ -22,27 +22,27 @@ Delete a worklog entry
- + -Issue id. +The unique identifier of the work item. - + -Pk. +The unique identifier of the worklog. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -66,9 +66,9 @@ Workspace slug ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/worklog-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -78,7 +78,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/worklog-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -89,7 +89,7 @@ print(response.status_code) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/worklog-uuid/", { method: "DELETE", headers: { diff --git a/docs/api-reference/worklogs/get-total-time.md b/docs/api-reference/worklogs/get-total-time.md index d84acea..f420305 100644 --- a/docs/api-reference/worklogs/get-total-time.md +++ b/docs/api-reference/worklogs/get-total-time.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, worklogs, get total time
GET - /api/v1/workspaces/{slug}/projects/{project_id}/total-worklogs/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/total-worklogs/
@@ -24,13 +24,13 @@ Get project worklog summary -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -54,9 +54,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/total-worklogs/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/total-worklogs/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/total-worklogs/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/total-worklogs/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -77,7 +77,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/total-worklogs/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/total-worklogs/", { method: "GET", headers: { diff --git a/docs/api-reference/worklogs/get-worklogs-for-issue.md b/docs/api-reference/worklogs/get-worklogs-for-issue.md index e6e4d92..ce50a17 100644 --- a/docs/api-reference/worklogs/get-worklogs-for-issue.md +++ b/docs/api-reference/worklogs/get-worklogs-for-issue.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, worklogs, list all worklo
GET - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/worklogs/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/worklogs/
@@ -22,21 +22,21 @@ List worklog entries
- + -Issue id. +The unique identifier of the work item. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -60,9 +60,9 @@ Workspace slug ```bash curl -X GET \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -72,7 +72,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -83,7 +83,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/", { method: "GET", headers: { diff --git a/docs/api-reference/worklogs/update-worklog.md b/docs/api-reference/worklogs/update-worklog.md index a53773f..2fbfd61 100644 --- a/docs/api-reference/worklogs/update-worklog.md +++ b/docs/api-reference/worklogs/update-worklog.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, worklogs, update a worklo
PATCH - /api/v1/workspaces/{slug}/projects/{project_id}/work-items/{issue_id}/worklogs/{pk}/ + /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/worklogs/{worklog_id}/
@@ -22,27 +22,27 @@ Update a worklog entry
- + -Issue id. +The unique identifier of the work item. - + -Pk. +The unique identifier of the worklog. -Project ID +The unique identifier of the project. - + -Workspace slug +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`. @@ -99,7 +99,7 @@ Updated by. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/worklog-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -118,7 +118,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/worklog-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "description": "Example description", @@ -135,7 +135,7 @@ print(response.json()) ```javascript const response = await fetch( - "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/worklogs/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/worklogs/worklog-uuid/", { method: "PATCH", headers: { diff --git a/docs/api-reference/workspace-features/get-workspace-features.md b/docs/api-reference/workspace-features/get-workspace-features.md index a469a4b..86fa942 100644 --- a/docs/api-reference/workspace-features/get-workspace-features.md +++ b/docs/api-reference/workspace-features/get-workspace-features.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, workspace features, get w
GET - /api/v1/workspaces/{slug}/features/ + /api/v1/workspaces/{workspace_slug}/features/
@@ -22,9 +22,9 @@ Get the features of a workspace
- + -Workspace slug +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`. @@ -50,7 +50,7 @@ Workspace slug curl -X GET \ "https://api.plane.so/api/v1/workspaces/my-workspace/features/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` diff --git a/docs/api-reference/workspace-features/update-workspace-features.md b/docs/api-reference/workspace-features/update-workspace-features.md index 61d1fbc..d1446d3 100644 --- a/docs/api-reference/workspace-features/update-workspace-features.md +++ b/docs/api-reference/workspace-features/update-workspace-features.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, workspace features, updat
PATCH - /api/v1/workspaces/{slug}/features/ + /api/v1/workspaces/{workspace_slug}/features/
@@ -22,9 +22,9 @@ Update the features of a workspace
- + -Workspace slug +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/docs/api-reference/workspace-invitations/add-workspace-invitation.md b/docs/api-reference/workspace-invitations/add-workspace-invitation.md index 8b29887..e79c69d 100644 --- a/docs/api-reference/workspace-invitations/add-workspace-invitation.md +++ b/docs/api-reference/workspace-invitations/add-workspace-invitation.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, workspace invitations, cr
POST - /api/v1/workspaces/{slug}/invitations/ + /api/v1/workspaces/{workspace_slug}/invitations/
@@ -22,9 +22,9 @@ Create a workspace invite
- + -Workspace slug +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/docs/api-reference/workspace-invitations/delete-workspace-invitation.md b/docs/api-reference/workspace-invitations/delete-workspace-invitation.md index 556fa28..13bf739 100644 --- a/docs/api-reference/workspace-invitations/delete-workspace-invitation.md +++ b/docs/api-reference/workspace-invitations/delete-workspace-invitation.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, workspace invitations, de
DELETE - /api/v1/workspaces/{slug}/invitations/{pk}/ + /api/v1/workspaces/{workspace_slug}/invitations/{invitation_id}/
@@ -22,15 +22,15 @@ Delete a workspace invite
- + -Workspace invite ID +The unique identifier of the invitation. - + -Workspace slug +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`. @@ -54,9 +54,9 @@ Workspace admin or owner permission required. ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/invitation-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -66,7 +66,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/invitation-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -76,15 +76,12 @@ print(response.status_code) @@ -66,7 +66,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/invitation-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +76,12 @@ print(response.json()) diff --git a/docs/api-reference/workspace-invitations/update-workspace-invitation.md b/docs/api-reference/workspace-invitations/update-workspace-invitation.md index 85aeb5b..ba1f435 100644 --- a/docs/api-reference/workspace-invitations/update-workspace-invitation.md +++ b/docs/api-reference/workspace-invitations/update-workspace-invitation.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, workspace invitations, up
PATCH - /api/v1/workspaces/{slug}/invitations/{pk}/ + /api/v1/workspaces/{workspace_slug}/invitations/{invitation_id}/
@@ -22,15 +22,15 @@ Update a workspace invite
- + -Workspace invite ID +The unique identifier of the invitation. - + -Workspace slug +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`. @@ -77,7 +77,7 @@ Workspace admin or owner permission required. ```bash curl -X PATCH \ - "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/550e8400-e29b-41d4-a716-446655440000/" \ + "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/invitation-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ -H "Content-Type: application/json" \ @@ -94,7 +94,7 @@ curl -X PATCH \ import requests response = requests.patch( - "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/550e8400-e29b-41d4-a716-446655440000/", + "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/invitation-uuid/", headers={"X-API-Key": "your-api-key"}, json={ "email": "Example Name", @@ -108,20 +108,17 @@ print(response.json())