Skip to content

Get a comment

GET/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/comments/{pk}/

Retrieve one comment by id. Use it to re-read a comment you created or updated, or to check edited_at before overwriting a body you did not write.

The comment is looked up within the work item in the path. A comment id that belongs to a different work item is not reachable here and returns 404 resource_not_found, the same as an id that does not exist.

Path Parameters

slug:requiredstring

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

project_id:requiredstring (uuid)

The project the work item belongs to.

work_item_id:requiredstring (uuid)

The work item the comment is attached to.

pk:requiredstring (uuid)

The comment to retrieve.

Scopes

projects.work_items.comments:read

Errors

StatusCodeCause
401unauthorizedMissing or invalid credentials.
403forbiddenYour role or token scope can't read this work item.
404resource_not_foundNo such comment, it belongs to another work item, or it's outside your tenant.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Get a comment
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/comments/c1f7a3d9-2b64-4f80-9c1a-3d5e8b2a6c47/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "id": "c1f7a3d9-2b64-4f80-9c1a-3d5e8b2a6c47",
  "work_item_id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
  "comment_html": "<p>Deployed the fix to staging. Please re-test.</p>",
  "comment_stripped": "Deployed the fix to staging. Please re-test.",
  "access": "INTERNAL",
  "actor_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "external_id": null,
  "external_source": null,
  "edited_at": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}
Response404
json
{
  "type": "https://api.plane.so/errors/resource_not_found",
  "title": "Resource Not Found",
  "status": 404,
  "code": "resource_not_found",
  "detail": "No comment matches the given query."
}