List a work item's comments

GEThttps://<your-url>/api/v2/work-items/{work_item}/comments

MCP id work-items.comments.indexAlso on this path: POST Post a comment on a work item

Returns the comment thread on one work item, newest first, keyset-paginated.

Token scope: api:read:project_management
Without it: 403 insufficient-token-scope.
Permission: project_management::view_backlog
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: with_total=1 +2, each include +1.
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 work item's thread with its authors

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

const response = await fetch('https://<your-url>/api/v2/work-items/1/comments?include=author&per_page=25', {
  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/work-items/1/comments?include=author&per_page=25');

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

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "body": "<p>Deployed to staging, ready for review.</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": {
        "…": "1 field of CommentLinks"
      }
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

There is no organisation-wide collection of comments, so this nested path is the only way to list them and filter[commentable_type] / filter[commentable_id] do not exist: the parent is the path segment. The path takes the work item's numeric id or its issue key, so work-items/ACM-123/comments and work-items/41/comments are the same thread. Work items are hard-deleted, so trashed is not an accepted parameter here. Listing additionally requires project_management::manage_work_items on the parent work item. Pass include=author to expand each comment's author; the body is in both views.

Path parameters

work_iteminteger or stringRequired

The WorkItem's numeric id. Or its issue_key, matching [A-Z][A-Z0-9]*-[0-9]+.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

14 parameters in 5 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

Cursor pagination only. Follow links.next.

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

with_totalboolean

Whether meta.page.total is counted for this request.

Default: false

Filters

=: equals
[gte][lt]: at least, less than

filter[author_id]integer

Id of the comment's author. Send together with author_type.

filter[author_type]string

Type of the comment's author. user is the only value in v2.0. Send together with author_id.

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: created_at

Key	Sorts by
`created_at`	When the comment was posted, newest first.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Includes

includestring

Comma-separated names to inline, at most five.

Path	Adds	Cost
`author`	Expand the author into a name-and-id object instead of a bare reference.	+1

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 page of CommentList rows.

dataarray of CommentList

The rows, each a CommentList.

meta.pagePageOptionalTotal

per_page, next_cursor, prev_cursor, total.

linksPageLinks

self, next, prev.

Each row is a CommentList: 11 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
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