List all work item comments

GET/api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/comments/

Returns a list of all comments on a work item, ordered chronologically.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

project_id:requiredstring

The unique identifier of the project.

work_item_id:requiredstring

The unique identifier for the work item.

Query Parameters

issue:optionalstring

Filter by work item ID.

project:optionalstring

Filter by project ID.

workspace:optionalstring

Filter by workspace ID.

limit:optionalnumber

Number of results to return per page.

offset:optionalnumber

Number of results to skip for pagination.

List all work item comments

curl -X GET \
  "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"

import requests

response = requests.get(
    "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"}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/comments/",
  {
    method: "GET",
    headers: {
      "X-API-Key": "your-api-key"
    }
  }
);
const data = await response.json();

Response200

{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}