List all top-level comments in a change request

Returns a paginated list of comments posted on the change request, optionally filtered by status, target page, or author. Comments can be anchored to a specific page or be general change-request-level comments. Use this to read the review discussion before responding. To fetch replies to a comment, use the comment replies endpoint.

Available in MCP

get

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

changeRequestIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

orderstring · enumOptional

An order for the items in the list

Default: descPossible values:

formatstring · enumOptional

Output format for the content.

Possible values:

statusstring · enumOptional

When provided, only comments with the given status are returned. Defaults to "all".

Default: allPossible values:

targetPagestringOptional

The target page of the comment

authorsstring[]Optional

User IDs to filter queried comments on

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

get/spaces/{spaceId}/change-requests/{changeRequestId}/comments

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "comment",
      "id": "text",
      "postedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "postedAt": "2026-07-21T22:03:07.887Z",
      "editedAt": "2026-07-21T22:03:07.887Z",
      "reactions": [
        {
          "emoji": "text",
          "count": 1,
          "users": [
            {
              "user": {
                "object": "user",
                "id": "text",
                "displayName": "text",
                "email": "text",
                "photoURL": "text",
                "urls": {
                  "location": "https://example.com"
                }
              },
              "reactedAt": "2026-07-21T22:03:07.887Z"
            }
          ]
        }
      ],
      "replies": 1,
      "repliers": [
        {
          "updatedAt": "2026-07-21T22:03:07.887Z",
          "count": 1,
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          }
        }
      ],
      "body": {
        "markdown": "# Hello World\n\nThis is a markdown document linking to [another page](/pages/page_id).\n"
      },
      "target": {
        "node": {
          "id": "text"
        },
        "tableCell": {
          "record": "text",
          "definition": "text"
        },
        "changeRequest": "text",
        "review": "text",
        "page": {
          "id": "text"
        },
        "space": "text",
        "revision": "text"
      },
      "urls": {
        "location": "https://example.com"
      },
      "permissions": {
        "view": true,
        "edit": true,
        "reply": true,
        "delete": true
      },
      "status": "resolved",
      "resolvedAt": "2026-07-21T22:03:07.887Z",
      "resolvedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}