ConnectCloud Developers

List the comments of an item (tenant:forge:read)

GET /api/forge/v1/projects/{key}/items/{number}/comments

Module: Forge · operationId: listForgeComments · Tag: Comments · Auth: access token (Authorization: Bearer <accessToken>)

Requires tenant:forge:read and a project the caller sees. Thread order, paged by keyset (limit 1–500, default 200; follow nextCursor); deleted comments keep their place with an empty body and deletedAt.

Parameters

Name In Type Required Description
limit query integer 1–500; another value is a 400 invalid. (default 200; max 500)
cursor query string The nextCursor of the previous page.
key path string yes Project key (e.g. APP)
number path integer yes Item number in the project (12 of APP-12)

Responses

  • 200 A page of comments (keyset, nextCursor while more follow) (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • items (array of Comment, required)
    • authorKind (string, required): Kind of actor that wrote it (one of person, integration, assistant, system, automation)
    • authorName (string, required): Display name of the author
    • authorRef (string, required): E-mail (or actor ref) of the author
    • body (string, required): Markdown
    • createdAt (string (date-time), required): When the comment was written
    • id (string (uuid), required): Comment id
    • itemId (string (uuid), required): The item commented on
    • deletedAt (string (date-time), nullable): When it was deleted (the body is then empty); null otherwise
    • editedAt (string (date-time), nullable): Last edit; null when never edited
    • originRef (string): Comments imported by a conversion: the source item, e.g. #123
    • originVisibility (string): Comments imported by a conversion: the visibility on the source side (one of public, internal)
  • nextCursor (string)

Example 200 answer:

{
  "items": [
    {
      "authorKind": "person",
      "authorName": "Emma Maier",
      "authorRef": "emma.maier@muster-it.example",
      "body": "Zwei Anmerkungen im Pull Request, vor allem der Fokus beim Schließen des Bottom-Sheets.",
      "createdAt": "2026-11-17T09:20:00Z",
      "deletedAt": null,
      "editedAt": null,
      "id": "4a5b6c7d-8e9f-4a0b-9c1d-3e4f5a6b7c01",
      "itemId": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c06"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/forge/v1/projects/string/items/1/comments' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI