List semantic content changes in a change request vs its base

Returns the semantic diff between the change request's current content and the base revision it branched from. Each item describes a logical change such as a page added, removed, or modified. Use this to summarise what a change request changes before merging or reviewing. The default limit is 10 — increase it if the change request is large.

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

limitnumberOptional

Limit the number of changes returned

Default: 10

Responses

200

OK

application/json

morenumberOptional

How many changes were omitted because above the result limit

404

The change request could not be found.

application/json

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

HTTPcURLJavaScriptPython

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

{
  "mergedFrom": {
    "object": "change-request",
    "id": "text",
    "number": 1,
    "status": "draft",
    "subject": "text",
    "description": {
      "object": "document",
      "data": {},
      "nodes": [
        {
          "object": "block",
          "type": "paragraph",
          "data": {},
          "nodes": [
            {
              "object": "text",
              "leaves": [
                {
                  "object": "leaf",
                  "text": "Hello world",
                  "marks": []
                }
              ]
            }
          ]
        }
      ]
    },
    "createdBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    },
    "createdAt": "2026-07-21T23:17:53.983Z",
    "updatedAt": "2026-07-21T23:17:53.983Z",
    "mergedBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    },
    "mergedAt": "2026-07-21T23:17:53.983Z",
    "space": "text",
    "revision": "text",
    "revisionInitial": "text",
    "revisionMergedAncestor": "text",
    "revisionMerged": "text",
    "comments": 1,
    "siteTopic": {
      "site": "text",
      "topic": "text",
      "finding": "text"
    },
    "outdated": true,
    "links": [
      {
        "ref": {
          "kind": "url",
          "url": "text"
        },
        "title": "text",
        "expanded": {
          "kind": "external-ticket",
          "provider": "jira",
          "state": "connected",
          "key": "text",
          "url": "https://example.com",
          "status": {
            "id": "text",
            "name": "text"
          },
          "summary": "text"
        }
      }
    ],
    "urls": {
      "app": "https://example.com",
      "location": "https://example.com"
    }
  },
  "changes": [
    {
      "type": "page_created",
      "page": {
        "id": "text",
        "type": "document",
        "title": "text",
        "path": "text"
      }
    }
  ],
  "more": 1
}