List all formal reviews submitted for a change request

Returns a paginated list of reviews submitted for the change request. Use this to check the current review status and whether all requested reviewers have responded before merging.

Available in MCP
get
Authorizations
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
formatstring · enumOptional

Output format for the content.

Possible values:
outdatedbooleanOptional

Filter reviews marked as outdated.

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses
200

All reviews for the given change request.

application/json
countnumberOptional

Total count of objects in the list

get/spaces/{spaceId}/change-requests/{changeRequestId}/reviews
GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/reviews HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "change-request-review",
      "id": "text",
      "revision": "text",
      "reviewer": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "requestedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "status": "changes-requested",
      "outdated": true,
      "comment": {
        "object": "comment",
        "id": "text",
        "postedBy": {
          "object": "user",
          "id": "text",
          "displayName": "text",
          "email": "text",
          "photoURL": "text",
          "urls": {
            "location": "https://example.com"
          }
        },
        "postedAt": "2026-01-01T00:00:00.000Z",
        "editedAt": "2026-01-01T00:00:00.000Z",
        "reactions": [
          {
            "emoji": "text",
            "count": 1,
            "users": [
              {
                "user": {
                  "object": "user",
                  "id": "text",
                  "displayName": "text",
                  "email": "text",
                  "photoURL": "text",
                  "urls": {
                    "location": "https://example.com"
                  }
                },
                "reactedAt": "2026-01-01T00:00:00.000Z"
              }
            ]
          }
        ],
        "replies": 1,
        "repliers": [
          {
            "updatedAt": "2026-01-01T00:00:00.000Z",
            "count": 1,
            "user": {
              "object": "user",
              "id": "text",
              "displayName": "text",
              "email": "text",
              "photoURL": "text",
              "urls": {
                "location": "https://example.com"
              }
            }
          }
        ],
        "body": "[Circular Reference]",
        "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-01-01T00:00:00.000Z",
        "resolvedBy": {
          "object": "user",
          "id": "text",
          "displayName": "text",
          "email": "text",
          "photoURL": "text",
          "urls": {
            "location": "https://example.com"
          }
        }
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Last updated

Was this helpful?

Powered by GitBook