List all work item comments

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

Retrieve all comments for a work item.

Path parameters

work_item_id:requiredstring

The unique identifier of the work item.

project_id:requiredstring

The unique identifier of the project.

workspace_slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

Query parameters

cursor:optionalstring

Pagination cursor for the next page of results.

expand:optionalstring

Comma-separated list of related fields to expand in the response.

fields:optionalstring

Comma-separated list of fields to include in the response.

order_by:optionalstring

Field to sort results by. Prefix it with - for descending order.

per_page:optionalinteger

Number of results per page. Defaults to 20, maximum 100.

Scopes

projects.work_items.comments:read

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/?cursor=20:1:0&expand=assignees" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"

import requests

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

const response = await fetch(
  "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: {
      "X-API-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "grouped_by": "state",
  "sub_grouped_by": "priority",
  "total_count": 150,
  "next_cursor": "20:1:0",
  "prev_cursor": "20:0:0",
  "next_page_results": true,
  "prev_page_results": false,
  "count": 20,
  "total_pages": 8,
  "total_results": 150,
  "extra_stats": null,
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}