Read a comment

GEThttps://<your-url>/api/v2/comments/{comment}

MCP id comments.showAlso on this path: PATCH Edit a comment, DELETE Delete a comment

Returns one comment in the detail view, reachable by id from either parent.

Token scope: api:read:project_managementorapi:read:project_driveorapi:read:customer_driveorapi:read:organization_driveorapi:read:user_drive
Without it: 403 insufficient-token-scope.
Permission: project_management::view_backlog
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One comment with its author expanded

curl -G \
  'https://<your-url>/api/v2/comments/1' \
  --data-urlencode 'include=author' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/comments/1?include=author', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/comments/1?include=author');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/comments/1?include=author',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "body": "<p>…</p>",
    "author_type": "user",
    "author_id": 1,
    "author": {
      "id": 1
    },
    "commentable_type": "work_item",
    "commentable_id": 1,
    "commentable": {
      "id": 1
    },
    "created_at": "2026-03-04T09:15:00Z",
    "updated_at": "2026-03-04T09:15:00Z",
    "links": {
      "self": "https://<your-url>/api/v2/work-items/1"
    }
  }
}

The commentable_type / commentable_id pair names the record it hangs off; the commentable itself is a reference and is not expandable. Reading a comment requires being able to read its parent, so the permission depends on what the comment hangs off: project_management::view_backlog (checked as project_management::manage_work_items) for a comment on a work item, and the drive prefix's access permission (project_drive::access, customer_drive::access, organization_drive::access or user_drive::access, whichever the document sits under) for a comment on a drive item. The token must cover that same prefix: a token without it gets 404, not 403. Comments are hard-deleted, so a deleted one is simply 404 and trashed is not an accepted parameter.

Path parameters

commentintegerRequired

The Comment's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a Comment in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning