Change request content

Manage the actual content changes associated with a change request.

Retrieve or update the pages and files tied to an open change request. This lets you preview alterations and merge them when ready.

Get a change request the latest content revision

get

Authorizations

user

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

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

or

or

or

or

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content

HTTPcURLJavaScriptPython

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

200

OK

{
  "object": "revision",
  "id": "text",
  "parents": [
    "text"
  ],
  "pages": [
    "[Circular Reference]"
  ],
  "files": [
    {
      "id": "text",
      "name": "text",
      "contentType": "text",
      "downloadURL": "text",
      "size": 1,
      "dimensions": {
        "width": 1,
        "height": 1
      },
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ],
  "reusableContents": [
    {
      "id": "text",
      "title": "text",
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ],
  "tags": [
    {
      "slug": "text",
      "label": "text",
      "color": "default",
      "emoji": "🎉"
    }
  ],
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "createdAt": "2026-03-18T12:47:47.121Z",
  "git": {
    "oid": "text",
    "message": "text",
    "createdByGitBook": true,
    "url": "text",
    "ref": "text"
  },
  "urls": {
    "app": "https://example.com",
    "published": "https://example.com",
    "public": "https://example.com"
  },
  "type": "edits"
}

List all change request pages

get

Authorizations

user

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

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/pages

HTTPcURLJavaScriptPython

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

200

OK

{
  "pages": [
    {
      "id": "text",
      "title": "text",
      "linkTitle": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-03-18T12:47:47.121Z",
      "updatedAt": "2026-03-18T12:47:47.121Z",
      "markdown": "text",
      "type": "document",
      "urls": {
        "app": "https://example.com"
      },
      "slug": "text",
      "path": "text",
      "description": "text",
      "pages": [
        "[Circular Reference]"
      ],
      "git": {
        "oid": "text",
        "path": "text"
      },
      "layout": {
        "width": "default",
        "cover": true,
        "coverSize": "hero",
        "title": true,
        "description": true,
        "tableOfContents": true,
        "outline": true,
        "pagination": true,
        "metadata": true,
        "tags": true
      },
      "cover": {
        "ref": {
          "kind": "file",
          "file": "text",
          "space": "text"
        },
        "refDark": {
          "kind": "file",
          "file": "text",
          "space": "text"
        },
        "yPos": 0,
        "height": 240
      },
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "hidden": false,
      "noIndex": false,
      "noRobotsIndex": false,
      "metaLinks": {
        "canonical": {
          "kind": "page",
          "page": "text",
          "space": "text"
        },
        "alternates": [
          {
            "kind": "page",
            "page": "text",
            "space": "text"
          }
        ]
      },
      "tags": [
        {
          "tag": {
            "kind": "tag",
            "tag": "text",
            "space": "text"
          },
          "primary": true
        }
      ],
      "computed": {
        "type": "builtin:openapi",
        "dependencies": {
          "spec": {
            "ref": {
              "kind": "openapi",
              "spec": "text"
            }
          }
        },
        "props": {
          "doc": "models"
        }
      },
      "computedSeed": "text"
    }
  ]
}

List all change request files

get

Authorizations

user

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

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/files

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "contentType": "text",
      "downloadURL": "text",
      "size": 1,
      "dimensions": {
        "width": 1,
        "height": 1
      },
      "git": {
        "oid": "text",
        "path": "text"
      }
    }
  ]
}

Get a change request file by its ID

get

Authorizations

user

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_-]+$

fileIdstringRequired

A unique entity identifier

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

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

idstringRequired

namestringRequired

contentTypestringRequired

downloadURLstringRequired

sizenumberRequired

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/files/{fileId}

HTTPcURLJavaScriptPython

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

200

OK

{
  "id": "text",
  "name": "text",
  "contentType": "text",
  "downloadURL": "text",
  "size": 1,
  "dimensions": {
    "width": 1,
    "height": 1
  },
  "git": {
    "oid": "text",
    "path": "text"
  }
}

List all backlink locations of a change request file

get

Authorizations

user

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_-]+$

fileIdstringRequired

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

Responses

200

OK

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/files/{fileId}/backlinks

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-03-18T12:47:47.121Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "billing": {
          "interval": "monthly",
          "endDate": "2026-03-18T12:47:47.121Z",
          "hasPaymentFailed": true,
          "canCheckout": true,
          "isScheduledToCancel": true,
          "pricing": {
            "members": {
              "plus_2024": {
                "monthly": 1,
                "yearly": 1
              },
              "pro_2024": {
                "monthly": 1,
                "yearly": 1
              }
            },
            "sites": {
              "premium": {
                "monthly": 1,
                "yearly": 1
              },
              "ultimate": {
                "monthly": 1,
                "yearly": 1
              }
            }
          },
          "usageAddons": {
            "ANY_ADDITIONAL_PROPERTY": {
              "enabled": true
            }
          },
          "minUsers": 1,
          "maxUsers": 1,
          "minPremiumSites": 1,
          "maxPremiumSites": 1,
          "minUltimateSites": 1,
          "maxUltimateSites": 1,
          "paidMembers": 1,
          "paidPremiumSites": 1,
          "paidUltimateSites": 1
        },
        "mergeRules": {
          "type": "rules",
          "rules": [
            {
              "rule": "require_specific_reviewers",
              "users": [
                "text"
              ]
            }
          ]
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "count": 1,
          "endDate": "2026-03-18T12:47:47.121Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "source": "backoffice",
          "reason": "text"
        },
        "internal_billingMigration": {
          "deadline": "2026-03-18T12:47:47.121Z",
          "discountPercent": 1,
          "discountEndDate": "2026-03-18T12:47:47.121Z"
        },
        "permissions": {
          "view": true,
          "access": true,
          "admin": true,
          "ownTeam": true,
          "createContent": true,
          "createOpenAPISpec": true,
          "viewBilling": true,
          "listMembers": true,
          "listTeams": true,
          "listIntegrations": true,
          "listInstallations": true,
          "installIntegration": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-03-18T12:47:47.121Z",
        "updatedAt": "2026-03-18T12:47:47.121Z",
        "deletedAt": "2026-03-18T12:47:47.121Z",
        "editMode": "live",
        "mergeRules": {
          "type": "inherit"
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com",
          "public": "https://example.com",
          "icon": "https://example.com"
        },
        "organization": "text",
        "parent": "text",
        "language": "en",
        "gitSync": {
          "repoName": "text",
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2026-03-18T12:47:47.121Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "internal_poweredByV2": true,
        "internal_singleWebsocket": true,
        "permissions": {
          "view": true,
          "access": true,
          "admin": true,
          "viewInviteLinks": true,
          "edit": true,
          "triggerGitSync": true,
          "comment": true,
          "merge": true,
          "review": true,
          "installIntegration": true
        }
      },
      "versionContext": {
        "type": "revision",
        "revision": "[Circular Reference]"
      },
      "file": {
        "id": "text",
        "name": "text",
        "contentType": "text",
        "downloadURL": "text",
        "size": 1,
        "dimensions": {
          "width": 1,
          "height": 1
        },
        "git": {
          "oid": "text",
          "path": "text"
        }
      }
    }
  ]
}

Get a change request page by its ID

get

Authorizations

user

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_-]+$

pageIdstringRequired

A unique entity identifier

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

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

evaluatedone ofOptional

Controls whether the document should be evaluated.

• When set to true, the entire document will be evaluated.
• When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

dereferencedone ofOptional

Controls whether the document should be deferenced (eference to other content will be resolved and expanded).

• When set to true, the entire document will be deferenced
• When set to reusable-contents, only reusable contents will be deferenced.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

or

or

or

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}

HTTPcURLJavaScriptPython

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

200

OK

{
  "id": "text",
  "title": "text",
  "linkTitle": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-03-18T12:47:47.121Z",
  "updatedAt": "2026-03-18T12:47:47.121Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "pages": [
    "[Circular Reference]"
  ],
  "git": {
    "oid": "text",
    "path": "text"
  },
  "layout": {
    "width": "default",
    "cover": true,
    "coverSize": "hero",
    "title": true,
    "description": true,
    "tableOfContents": true,
    "outline": true,
    "pagination": true,
    "metadata": true,
    "tags": true
  },
  "cover": {
    "ref": {
      "kind": "file",
      "file": "text",
      "space": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text",
      "space": "text"
    },
    "yPos": 0,
    "height": 240
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "hidden": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "metaLinks": {
    "canonical": {
      "kind": "page",
      "page": "text",
      "space": "text"
    },
    "alternates": [
      {
        "kind": "page",
        "page": "text",
        "space": "text"
      }
    ]
  },
  "tags": [
    {
      "tag": {
        "kind": "tag",
        "tag": "text",
        "space": "text"
      },
      "primary": true
    }
  ],
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

List all change request links

get

Authorizations

user

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_-]+$

pageIdstringRequired

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

Responses

200

OK

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/links

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "stats": {
    "total": 1,
    "broken": {
      "total": 1,
      "changeRequest": 1
    }
  },
  "items": [
    {
      "status": "ok",
      "relation": "reference",
      "targetReference": {
        "kind": "file",
        "organization": {
          "object": "organization",
          "id": "text",
          "title": "text",
          "createdAt": "2026-03-18T12:47:47.121Z",
          "emailDomains": [
            "text"
          ],
          "hostname": "text",
          "type": "business",
          "useCase": "internalDocs",
          "communityType": "nonProfit",
          "defaultRole": "admin",
          "defaultContent": {
            "type": "site",
            "site": "text"
          },
          "sso": true,
          "ai": true,
          "inviteLinks": true,
          "plan": "free_2024",
          "billing": {
            "interval": "monthly",
            "endDate": "2026-03-18T12:47:47.121Z",
            "hasPaymentFailed": true,
            "canCheckout": true,
            "isScheduledToCancel": true,
            "pricing": {
              "members": {
                "plus_2024": {
                  "monthly": 1,
                  "yearly": 1
                },
                "pro_2024": {
                  "monthly": 1,
                  "yearly": 1
                }
              },
              "sites": {
                "premium": {
                  "monthly": 1,
                  "yearly": 1
                },
                "ultimate": {
                  "monthly": 1,
                  "yearly": 1
                }
              }
            },
            "usageAddons": {
              "ANY_ADDITIONAL_PROPERTY": {
                "enabled": true
              }
            },
            "minUsers": 1,
            "maxUsers": 1,
            "minPremiumSites": 1,
            "maxPremiumSites": 1,
            "minUltimateSites": 1,
            "maxUltimateSites": 1,
            "paidMembers": 1,
            "paidPremiumSites": 1,
            "paidUltimateSites": 1
          },
          "mergeRules": {
            "type": "rules",
            "rules": [
              {
                "rule": "require_specific_reviewers",
                "users": [
                  "text"
                ]
              }
            ]
          },
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trial": {
            "status": "notapplicable",
            "count": 1,
            "endDate": "2026-03-18T12:47:47.121Z",
            "decision": "downgrade"
          },
          "customHostname": "text",
          "blocked": {
            "source": "backoffice",
            "reason": "text"
          },
          "internal_billingMigration": {
            "deadline": "2026-03-18T12:47:47.121Z",
            "discountPercent": 1,
            "discountEndDate": "2026-03-18T12:47:47.121Z"
          },
          "permissions": {
            "view": true,
            "access": true,
            "admin": true,
            "ownTeam": true,
            "createContent": true,
            "createOpenAPISpec": true,
            "viewBilling": true,
            "listMembers": true,
            "listTeams": true,
            "listIntegrations": true,
            "listInstallations": true,
            "installIntegration": true
          }
        },
        "space": {
          "object": "space",
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "visibility": "public",
          "createdAt": "2026-03-18T12:47:47.121Z",
          "updatedAt": "2026-03-18T12:47:47.121Z",
          "deletedAt": "2026-03-18T12:47:47.121Z",
          "editMode": "live",
          "mergeRules": {
            "type": "inherit"
          },
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "published": "https://example.com",
            "public": "https://example.com",
            "icon": "https://example.com"
          },
          "organization": "text",
          "parent": "text",
          "language": "en",
          "gitSync": {
            "repoName": "text",
            "installationProvider": "github",
            "integration": "text",
            "url": "text",
            "updatedAt": "2026-03-18T12:47:47.121Z"
          },
          "visitorAuth": {
            "backend": "custom"
          },
          "revision": "text",
          "defaultLevel": "admin",
          "comments": 1,
          "changeRequests": 1,
          "changeRequestsOpen": 1,
          "changeRequestsDraft": 1,
          "internal_poweredByV2": true,
          "internal_singleWebsocket": true,
          "permissions": {
            "view": true,
            "access": true,
            "admin": true,
            "viewInviteLinks": true,
            "edit": true,
            "triggerGitSync": true,
            "comment": true,
            "merge": true,
            "review": true,
            "installIntegration": true
          }
        },
        "versionContext": "[Circular Reference]",
        "file": {
          "id": "text",
          "name": "text",
          "contentType": "text",
          "downloadURL": "text",
          "size": 1,
          "dimensions": {
            "width": 1,
            "height": 1
          },
          "git": {
            "oid": "text",
            "path": "text"
          }
        }
      },
      "locationReferences": [
        {
          "kind": "file",
          "organization": {
            "object": "organization",
            "id": "text",
            "title": "text",
            "createdAt": "2026-03-18T12:47:47.121Z",
            "emailDomains": [
              "text"
            ],
            "hostname": "text",
            "type": "business",
            "useCase": "internalDocs",
            "communityType": "nonProfit",
            "defaultRole": "admin",
            "defaultContent": {
              "type": "site",
              "site": "text"
            },
            "sso": true,
            "ai": true,
            "inviteLinks": true,
            "plan": "free_2024",
            "billing": {
              "interval": "monthly",
              "endDate": "2026-03-18T12:47:47.121Z",
              "hasPaymentFailed": true,
              "canCheckout": true,
              "isScheduledToCancel": true,
              "pricing": {
                "members": {
                  "plus_2024": {
                    "monthly": 1,
                    "yearly": 1
                  },
                  "pro_2024": {
                    "monthly": 1,
                    "yearly": 1
                  }
                },
                "sites": {
                  "premium": {
                    "monthly": 1,
                    "yearly": 1
                  },
                  "ultimate": {
                    "monthly": 1,
                    "yearly": 1
                  }
                }
              },
              "usageAddons": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "enabled": true
                }
              },
              "minUsers": 1,
              "maxUsers": 1,
              "minPremiumSites": 1,
              "maxPremiumSites": 1,
              "minUltimateSites": 1,
              "maxUltimateSites": 1,
              "paidMembers": 1,
              "paidPremiumSites": 1,
              "paidUltimateSites": 1
            },
            "mergeRules": {
              "type": "rules",
              "rules": [
                {
                  "rule": "require_specific_reviewers",
                  "users": [
                    "text"
                  ]
                }
              ]
            },
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trial": {
              "status": "notapplicable",
              "count": 1,
              "endDate": "2026-03-18T12:47:47.121Z",
              "decision": "downgrade"
            },
            "customHostname": "text",
            "blocked": {
              "source": "backoffice",
              "reason": "text"
            },
            "internal_billingMigration": {
              "deadline": "2026-03-18T12:47:47.121Z",
              "discountPercent": 1,
              "discountEndDate": "2026-03-18T12:47:47.121Z"
            },
            "permissions": {
              "view": true,
              "access": true,
              "admin": true,
              "ownTeam": true,
              "createContent": true,
              "createOpenAPISpec": true,
              "viewBilling": true,
              "listMembers": true,
              "listTeams": true,
              "listIntegrations": true,
              "listInstallations": true,
              "installIntegration": true
            }
          },
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2026-03-18T12:47:47.121Z",
            "updatedAt": "2026-03-18T12:47:47.121Z",
            "deletedAt": "2026-03-18T12:47:47.121Z",
            "editMode": "live",
            "mergeRules": {
              "type": "inherit"
            },
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "published": "https://example.com",
              "public": "https://example.com",
              "icon": "https://example.com"
            },
            "organization": "text",
            "parent": "text",
            "language": "en",
            "gitSync": {
              "repoName": "text",
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2026-03-18T12:47:47.121Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "internal_poweredByV2": true,
            "internal_singleWebsocket": true,
            "permissions": {
              "view": true,
              "access": true,
              "admin": true,
              "viewInviteLinks": true,
              "edit": true,
              "triggerGitSync": true,
              "comment": true,
              "merge": true,
              "review": true,
              "installIntegration": true
            }
          },
          "versionContext": "[Circular Reference]",
          "file": {
            "id": "text",
            "name": "text",
            "contentType": "text",
            "downloadURL": "text",
            "size": 1,
            "dimensions": {
              "width": 1,
              "height": 1
            },
            "git": {
              "oid": "text",
              "path": "text"
            }
          }
        }
      ]
    }
  ]
}

List all backlink locations of a change request page

get

Authorizations

user

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_-]+$

pageIdstringRequired

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

Responses

200

OK

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/backlinks

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-03-18T12:47:47.121Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "type": "site",
          "site": "text"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "billing": {
          "interval": "monthly",
          "endDate": "2026-03-18T12:47:47.121Z",
          "hasPaymentFailed": true,
          "canCheckout": true,
          "isScheduledToCancel": true,
          "pricing": {
            "members": {
              "plus_2024": {
                "monthly": 1,
                "yearly": 1
              },
              "pro_2024": {
                "monthly": 1,
                "yearly": 1
              }
            },
            "sites": {
              "premium": {
                "monthly": 1,
                "yearly": 1
              },
              "ultimate": {
                "monthly": 1,
                "yearly": 1
              }
            }
          },
          "usageAddons": {
            "ANY_ADDITIONAL_PROPERTY": {
              "enabled": true
            }
          },
          "minUsers": 1,
          "maxUsers": 1,
          "minPremiumSites": 1,
          "maxPremiumSites": 1,
          "minUltimateSites": 1,
          "maxUltimateSites": 1,
          "paidMembers": 1,
          "paidPremiumSites": 1,
          "paidUltimateSites": 1
        },
        "mergeRules": {
          "type": "rules",
          "rules": [
            {
              "rule": "require_specific_reviewers",
              "users": [
                "text"
              ]
            }
          ]
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "count": 1,
          "endDate": "2026-03-18T12:47:47.121Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "source": "backoffice",
          "reason": "text"
        },
        "internal_billingMigration": {
          "deadline": "2026-03-18T12:47:47.121Z",
          "discountPercent": 1,
          "discountEndDate": "2026-03-18T12:47:47.121Z"
        },
        "permissions": {
          "view": true,
          "access": true,
          "admin": true,
          "ownTeam": true,
          "createContent": true,
          "createOpenAPISpec": true,
          "viewBilling": true,
          "listMembers": true,
          "listTeams": true,
          "listIntegrations": true,
          "listInstallations": true,
          "installIntegration": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-03-18T12:47:47.121Z",
        "updatedAt": "2026-03-18T12:47:47.121Z",
        "deletedAt": "2026-03-18T12:47:47.121Z",
        "editMode": "live",
        "mergeRules": {
          "type": "inherit"
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "published": "https://example.com",
          "public": "https://example.com",
          "icon": "https://example.com"
        },
        "organization": "text",
        "parent": "text",
        "language": "en",
        "gitSync": {
          "repoName": "text",
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2026-03-18T12:47:47.121Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "internal_poweredByV2": true,
        "internal_singleWebsocket": true,
        "permissions": {
          "view": true,
          "access": true,
          "admin": true,
          "viewInviteLinks": true,
          "edit": true,
          "triggerGitSync": true,
          "comment": true,
          "merge": true,
          "review": true,
          "installIntegration": true
        }
      },
      "versionContext": {
        "type": "revision",
        "revision": "[Circular Reference]"
      },
      "file": {
        "id": "text",
        "name": "text",
        "contentType": "text",
        "downloadURL": "text",
        "size": 1,
        "dimensions": {
          "width": 1,
          "height": 1
        },
        "git": {
          "oid": "text",
          "path": "text"
        }
      }
    }
  ]
}

List all meta links of a change request page

get

Authorizations

user

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_-]+$

pageIdstringRequired

A unique entity identifier

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

Responses

200

OK

application/json

canonicalone ofOptional

or

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/meta-links

HTTPcURLJavaScriptPython

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

200

OK

{
  "canonical": {
    "kind": "page",
    "page": "text",
    "space": "text"
  },
  "alternates": [
    {
      "kind": "page",
      "page": "text",
      "space": "text"
    }
  ]
}

Get a change request reusable content by its ID

get

Authorizations

user

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_-]+$

reusableContentIdstringRequired

A unique entity identifier

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

Query parameters

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

and

anyOptional

or

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/reusable-contents/{reusableContentId}

HTTPcURLJavaScriptPython

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

200

OK

{
  "id": "text",
  "title": "text",
  "git": {
    "oid": "text",
    "path": "text"
  },
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}

Get change request semantic changes

get

Return the semantic changes between a change request and its base revision.

Authorizations

user

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": {
        "schemaVersion": 1,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "nodes": [
        {
          "object": "block",
          "type": "paragraph",
          "key": "text",
          "nodes": "[Circular Reference]",
          "isVoid": false,
          "data": {
            "align": "start"
          }
        }
      ],
      "meta": {
        "token": "text"
      }
    },
    "createdBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    },
    "createdAt": "2026-03-18T12:47:47.121Z",
    "updatedAt": "2026-03-18T12:47:47.121Z",
    "space": "text",
    "revision": "text",
    "revisionInitial": "text",
    "revisionMergedAncestor": "text",
    "revisionMerged": "text",
    "comments": 1,
    "outdated": true,
    "urls": {
      "app": "https://example.com",
      "location": "https://example.com"
    }
  },
  "changes": [
    {
      "type": "page_created",
      "page": {
        "id": "text",
        "type": "document",
        "title": "text",
        "path": "text"
      }
    }
  ],
  "more": 1
}

Get a change request page by its path

get

Authorizations

user

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_-]+$

pagePathstringRequired

The path of the page in the revision.

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

evaluatedone ofOptional

Controls whether the document should be evaluated.

• When set to true, the entire document will be evaluated.
• When set to deterministic-only, only expressions that depend exclusively on deterministic inputs will be evaluated.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

dereferencedone ofOptional

Controls whether the document should be deferenced (eference to other content will be resolved and expanded).

• When set to true, the entire document will be deferenced
• When set to reusable-contents, only reusable contents will be deferenced.

Default: false

booleanOptional

or

string · enumOptionalPossible values:

metadatabooleanOptional

If false is passed, "git" mutable metadata will not returned. Passing false can optimize performances of the lookup.

Default: true

computedbooleanOptional

If false is passed, content will not be computed

Default: true

Responses

200

OK

application/json

or

get

/spaces/{spaceId}/change-requests/{changeRequestId}/content/path/{pagePath}

HTTPcURLJavaScriptPython

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

200

OK

{
  "id": "text",
  "title": "text",
  "linkTitle": "text",
  "emoji": "🎉",
  "icon": "gear",
  "createdAt": "2026-03-18T12:47:47.121Z",
  "updatedAt": "2026-03-18T12:47:47.121Z",
  "markdown": "text",
  "type": "document",
  "urls": {
    "app": "https://example.com"
  },
  "slug": "text",
  "path": "text",
  "description": "text",
  "pages": [
    "[Circular Reference]"
  ],
  "git": {
    "oid": "text",
    "path": "text"
  },
  "layout": {
    "width": "default",
    "cover": true,
    "coverSize": "hero",
    "title": true,
    "description": true,
    "tableOfContents": true,
    "outline": true,
    "pagination": true,
    "metadata": true,
    "tags": true
  },
  "cover": {
    "ref": {
      "kind": "file",
      "file": "text",
      "space": "text"
    },
    "refDark": {
      "kind": "file",
      "file": "text",
      "space": "text"
    },
    "yPos": 0,
    "height": 240
  },
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "hidden": false,
  "noIndex": false,
  "noRobotsIndex": false,
  "metaLinks": {
    "canonical": {
      "kind": "page",
      "page": "text",
      "space": "text"
    },
    "alternates": [
      {
        "kind": "page",
        "page": "text",
        "space": "text"
      }
    ]
  },
  "tags": [
    {
      "tag": {
        "kind": "tag",
        "tag": "text",
        "space": "text"
      },
      "primary": true
    }
  ],
  "computed": {
    "type": "builtin:openapi",
    "dependencies": {
      "spec": {
        "ref": {
          "kind": "openapi",
          "spec": "text"
        }
      }
    },
    "props": {
      "doc": "models"
    }
  },
  "computedSeed": "text"
}