Spaces

Get the details about a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

shareKeystringOptional

For sites published via share-links, the share key is useful to resolve published URLs.

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}

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

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "deletedAt": "2026-01-25T23:51:25.823Z",
  "editMode": "live",
  "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",
  "gitSync": {
    "installationProvider": "github",
    "integration": "text",
    "url": "text",
    "updatedAt": "2026-01-25T23:51:25.823Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "permissions": {
    "access": true,
    "admin": true,
    "edit": true,
    "comment": true,
    "merge": true,
    "review": true
  }
}

Soft-deletes a space. Soft-deleted spaces will be permanently removed after 7 days.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

205

Space has been deleted

default

Unexpected Error

application/json

delete

/spaces/{spaceId}

DELETE /v1/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update the details of a space

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

and

anyOptional

Responses

200

The space has been updated

application/json

default

Unexpected Error

application/json

patch

/spaces/{spaceId}

PATCH /v1/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "editMode": "live",
  "title": "text",
  "defaultLevel": "admin",
  "emoji": "🎉"
}

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "deletedAt": "2026-01-25T23:51:25.823Z",
  "editMode": "live",
  "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",
  "gitSync": {
    "installationProvider": "github",
    "integration": "text",
    "url": "text",
    "updatedAt": "2026-01-25T23:51:25.823Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "permissions": {
    "access": true,
    "admin": true,
    "edit": true,
    "comment": true,
    "merge": true,
    "review": true
  }
}

Create a duplicate of the space.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

201

Space duplicated

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/duplicate

POST /v1/spaces/{spaceId}/duplicate HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "deletedAt": "2026-01-25T23:51:25.823Z",
  "editMode": "live",
  "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",
  "gitSync": {
    "installationProvider": "github",
    "integration": "text",
    "url": "text",
    "updatedAt": "2026-01-25T23:51:25.823Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "permissions": {
    "access": true,
    "admin": true,
    "edit": true,
    "comment": true,
    "merge": true,
    "review": true
  }
}

Restore a recently soft-deleted space.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

200

Space restored

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/restore

POST /v1/spaces/{spaceId}/restore HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "deletedAt": "2026-01-25T23:51:25.823Z",
  "editMode": "live",
  "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",
  "gitSync": {
    "installationProvider": "github",
    "integration": "text",
    "url": "text",
    "updatedAt": "2026-01-25T23:51:25.823Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "permissions": {
    "access": true,
    "admin": true,
    "edit": true,
    "comment": true,
    "merge": true,
    "review": true
  }
}

Move a space to a new position.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

parentstring | nullableOptional

The unique id of the parent collection

Responses

200

Space moved

application/json

400

Invalid position space or collection provided

application/json

404

No matching Space found for given ID

application/json

409

Operation would not result in any update

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/move

POST /v1/spaces/{spaceId}/move HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "parent": "text",
  "position": {
    "before": {
      "type": "space",
      "space": "text"
    },
    "after": {
      "type": "space",
      "space": "text"
    }
  }
}

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "deletedAt": "2026-01-25T23:51:25.823Z",
  "editMode": "live",
  "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",
  "gitSync": {
    "installationProvider": "github",
    "integration": "text",
    "url": "text",
    "updatedAt": "2026-01-25T23:51:25.823Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "permissions": {
    "access": true,
    "admin": true,
    "edit": true,
    "comment": true,
    "merge": true,
    "review": true
  }
}

Transfer a space to another organization, collection or both.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

organizationstringRequired

The unique id of the target organization

Responses

200

Space transferred

application/json

404

No matching Space found for given ID

application/json

409

Transfer would not result in any update

application/json

412

The space cannot be moved.

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/transfer

POST /v1/spaces/{spaceId}/transfer HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "organization": "text"
}

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "deletedAt": "2026-01-25T23:51:25.823Z",
  "editMode": "live",
  "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",
  "gitSync": {
    "installationProvider": "github",
    "integration": "text",
    "url": "text",
    "updatedAt": "2026-01-25T23:51:25.823Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "permissions": {
    "access": true,
    "admin": true,
    "edit": true,
    "comment": true,
    "merge": true,
    "review": true
  }
}

Resolve a URL to an embed in a given space

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

urlstringRequired

URL to resolve

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/embed

GET /v1/spaces/{spaceId}/embed?url=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "title": "text",
  "site": "text",
  "icon": "text",
  "type": "link"
}

Import a Git repository

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

urlstringRequired

URL of the Git repository to import. It can contain basic auth credentials.

refstringRequired

Git ref to import in the format "refs/heads/main"

repoCacheIDstringOptional

Unique identifier to use to cache the Git repository across multiple operations.

repoTreeURLstringOptional

URL to use as a prefix for external file references.

repoCommitURLstringOptional

URL to use as a prefix for the commit URL.

repoProjectDirectorystringOptional

Path to a root directory for the project in the repository.

timestampstring · date-timeOptional

The timestamp of the event that triggered this import. It ensures that Git sync import and export operations are executed in the same order on GitBook and on the remote repository.

forcebooleanOptional

standalonebooleanOptional

If true, the import will generate a revision without updating the space primary content.

Responses

204

Operation to import the repository has been started.

default

Unexpected Error

application/json

post

/spaces/{spaceId}/git/import

POST /v1/spaces/{spaceId}/git/import HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "url": "text",
  "ref": "text",
  "repoCacheID": "text",
  "repoTreeURL": "text",
  "repoCommitURL": "text",
  "repoProjectDirectory": "text",
  "timestamp": "2026-01-25T23:51:25.823Z",
  "force": true,
  "standalone": true,
  "gitInfo": {
    "provider": "github",
    "url": "text"
  }
}

No content

Export the space content to a Git repository.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

urlstringRequired

URL of the Git repository to export to. It can contain basic auth credentials.

refstringRequired

Git ref to push the commit to in the format "refs/heads/main"

commitMessagestringRequired

Message for the commit generated by the export

repoCacheIDstringOptional

Unique identifier to use to cache the Git repository across multiple operations.

repoTreeURLstringOptional

URL to use as a prefix for external file references.

repoCommitURLstringOptional

URL to use as a prefix for the commit URL.

repoProjectDirectorystringOptional

Path to a root directory for the project in the repository.

timestampstring · date-timeOptional

The timestamp of the event that triggered this export. It ensures that Git sync import and export operations are executed in the same order on GitBook and on the remote repository.

forcebooleanOptional

Responses

204

Operation to export the space has been started.

default

Unexpected Error

application/json

post

/spaces/{spaceId}/git/export

POST /v1/spaces/{spaceId}/git/export HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "url": "text",
  "ref": "text",
  "commitMessage": "text",
  "repoCacheID": "text",
  "repoTreeURL": "text",
  "repoCommitURL": "text",
  "repoProjectDirectory": "text",
  "timestamp": "2026-01-25T23:51:25.823Z",
  "force": true,
  "gitInfo": {
    "provider": "github",
    "url": "text"
  }
}

No content

Get metadata about the Git Sync provider currently set up on the space

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

200

The Git Sync info for the space

application/json

404

No Git provider currently set up on the space

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/git/info

GET /v1/spaces/{spaceId}/git/info HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "installationProvider": "github",
  "integration": "text",
  "url": "text",
  "updatedAt": "2026-01-25T23:51:25.823Z"
}

Invite to a space

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

Responses

204

404

No team or user with the provided Id

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/permissions

POST /v1/spaces/{spaceId}/permissions HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "role": "admin",
  "teams": [
    "text"
  ]
}

No content

Remove a team from a space

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

teamIdstringRequired

The unique ID of the Team

Responses

205

The team has been removed from the space

400

Team does not have access to space

application/json

404

No team found with the given ID

application/json

default

Unexpected Error

application/json

delete

/spaces/{spaceId}/permissions/teams/{teamId}

DELETE /v1/spaces/{spaceId}/permissions/teams/{teamId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Remove a user from a space

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

userIdstringRequired

The unique ID of the User

Responses

205

The user has been removed from the space

404

No user found with the given ID

application/json

default

Unexpected Error

application/json

delete

/spaces/{spaceId}/permissions/users/{userId}

DELETE /v1/spaces/{spaceId}/permissions/users/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get backlink locations for a file existing in a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

fileIdstringRequired

The unique id of the file

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content/files/{fileId}/backlinks

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "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",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "updatedAt": "2026-01-25T23:51:25.823Z",
        "deletedAt": "2026-01-25T23:51:25.823Z",
        "editMode": "live",
        "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",
        "gitSync": {
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2026-01-25T23:51:25.823Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "access": true,
          "admin": true,
          "edit": true,
          "comment": true,
          "merge": true,
          "review": 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 links in a page

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

pageIdstringRequired

The unique id of the page

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

statusstring · enumOptional

Text to display to represent the reference. Possible values include:

ok - No problems detected for this content reference.
broken - The target does not exist in the revision.
in-app - The target is a URL link pointing to an internal location in the app.

Possible values:

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content/page/{pageId}/links

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

{
  "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-01-25T23:51:25.823Z",
          "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",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trialDecision": "downgrade",
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_isUsingSnippets": true,
          "internal_isOnNewTrial": true,
          "permissions": {
            "admin": true,
            "createContent": true
          }
        },
        "space": {
          "object": "space",
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "visibility": "public",
          "createdAt": "2026-01-25T23:51:25.823Z",
          "updatedAt": "2026-01-25T23:51:25.823Z",
          "deletedAt": "2026-01-25T23:51:25.823Z",
          "editMode": "live",
          "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",
          "gitSync": {
            "installationProvider": "github",
            "integration": "text",
            "url": "text",
            "updatedAt": "2026-01-25T23:51:25.823Z"
          },
          "visitorAuth": {
            "backend": "custom"
          },
          "revision": "text",
          "defaultLevel": "admin",
          "comments": 1,
          "changeRequests": 1,
          "changeRequestsOpen": 1,
          "changeRequestsDraft": 1,
          "permissions": {
            "access": true,
            "admin": true,
            "edit": true,
            "comment": true,
            "merge": true,
            "review": 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-01-25T23:51:25.823Z",
            "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",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trialDecision": "downgrade",
            "customHostname": "text",
            "blocked": {
              "reason": "security"
            },
            "internal_isUsingSnippets": true,
            "internal_isOnNewTrial": true,
            "permissions": {
              "admin": true,
              "createContent": true
            }
          },
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2026-01-25T23:51:25.823Z",
            "updatedAt": "2026-01-25T23:51:25.823Z",
            "deletedAt": "2026-01-25T23:51:25.823Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2026-01-25T23:51:25.823Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": 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"
            }
          }
        }
      ]
    }
  ]
}

Get backlink locations for a page existing in a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

pageIdstringRequired

The unique id of the page

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/content/page/{pageId}/backlinks

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "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",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "updatedAt": "2026-01-25T23:51:25.823Z",
        "deletedAt": "2026-01-25T23:51:25.823Z",
        "editMode": "live",
        "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",
        "gitSync": {
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2026-01-25T23:51:25.823Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "access": true,
          "admin": true,
          "edit": true,
          "comment": true,
          "merge": true,
          "review": 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 change requests for a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

statusstring · enumOptional

If defined, only change requests matching this status will be returned.

Default: openPossible values:

contributorstringOptional

If defined, only change requests with contributions from this user will be returned.

Responses

200

List of the space's change requests

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "change-request",
      "id": "text",
      "number": 1,
      "status": "draft",
      "subject": "text",
      "createdBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "revision": "text",
      "revisionInitial": "text",
      "revisionMergedAncestor": "text",
      "revisionMerged": "text",
      "comments": 1,
      "outdated": true,
      "urls": {
        "app": "https://example.com",
        "location": "https://example.com"
      }
    }
  ]
}

Create a new change request for a space.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

subjectstringOptional

Subject of the change-request

Responses

201

Change Request Created

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/change-requests

POST /v1/spaces/{spaceId}/change-requests HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "subject": "text"
}

{
  "object": "change-request",
  "id": "text",
  "number": 1,
  "status": "draft",
  "subject": "text",
  "createdBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "revision": "text",
  "revisionInitial": "text",
  "revisionMergedAncestor": "text",
  "revisionMerged": "text",
  "comments": 1,
  "outdated": true,
  "urls": {
    "app": "https://example.com",
    "location": "https://example.com"
  }
}

Get the change request with the given id.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Responses

200

The matching change request

application/json

404

The change request could not be found.

application/json

default

Unexpected Error

application/json

get

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

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

{
  "object": "change-request",
  "id": "text",
  "number": 1,
  "status": "draft",
  "subject": "text",
  "createdBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "revision": "text",
  "revisionInitial": "text",
  "revisionMergedAncestor": "text",
  "revisionMerged": "text",
  "comments": 1,
  "outdated": true,
  "urls": {
    "app": "https://example.com",
    "location": "https://example.com"
  }
}

Update the details of a change request

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Body

subjectstring · max: 100Optional

Subject of the change request

statusstring · enumOptionalPossible values:

Responses

200

The change request has been updated

application/json

default

Unexpected Error

application/json

patch

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

PATCH /v1/spaces/{spaceId}/change-requests/{changeRequestId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "subject": "text",
  "status": "draft"
}

{
  "object": "change-request",
  "id": "text",
  "number": 1,
  "status": "draft",
  "subject": "text",
  "createdBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "revision": "text",
  "revisionInitial": "text",
  "revisionMergedAncestor": "text",
  "revisionMerged": "text",
  "comments": 1,
  "outdated": true,
  "urls": {
    "app": "https://example.com",
    "location": "https://example.com"
  }
}

Merge a change request in the primary content of a space.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Responses

200

application/json

default

Unexpected Error

application/json

post

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

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

{
  "revision": "text",
  "result": "merge"
}

Update a change-request with changes from primary content.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Responses

200

application/json

default

Unexpected Error

application/json

post

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

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

{
  "revision": "text",
  "result": "update"
}

Get all reviews for a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

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

404

The change request or space could not be found.

application/json

default

Unexpected Error

application/json

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",
      "comment": {
        "object": "comment",
        "id": "text",
        "postedBy": {
          "object": "user",
          "id": "text",
          "displayName": "text",
          "email": "text",
          "photoURL": "text",
          "urls": {
            "location": "https://example.com"
          }
        },
        "postedAt": "2026-01-25T23:51:25.823Z",
        "editedAt": "2026-01-25T23:51:25.823Z",
        "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-25T23:51:25.823Z"
              }
            ]
          }
        ],
        "replies": 1,
        "body": "[Circular Reference]",
        "target": {
          "node": {
            "id": "text",
            "preview": "text"
          },
          "changeRequest": "text",
          "review": "text",
          "page": {
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "icon": "gear",
            "createdAt": "2026-01-25T23:51:25.823Z",
            "updatedAt": "2026-01-25T23:51:25.823Z",
            "path": "text",
            "outdated": true
          },
          "space": "text",
          "revision": "text"
        },
        "urls": {
          "location": "https://example.com"
        },
        "status": "resolved",
        "resolvedAt": "2026-01-25T23:51:25.823Z",
        "resolvedBy": {
          "object": "user",
          "id": "text",
          "displayName": "text",
          "email": "text",
          "photoURL": "text",
          "urls": {
            "location": "https://example.com"
          }
        }
      },
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z"
    }
  ]
}

Submit a review for a change request.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Body

statusstring · enumRequired

The status of the submitted review.

Possible values:

commentone ofOptional

Optionally, provide a comment along with the review.

object · EmptyOptional

Responses

201

A new review has been created.

application/json

default

Unexpected Error

application/json

post

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

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/reviews HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "status": "changes-requested",
  "comment": {
    "markdown": "text"
  }
}

{
  "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",
  "comment": {
    "object": "comment",
    "id": "text",
    "postedBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    },
    "postedAt": "2026-01-25T23:51:25.823Z",
    "editedAt": "2026-01-25T23:51:25.823Z",
    "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-25T23:51:25.823Z"
          }
        ]
      }
    ],
    "replies": 1,
    "body": {
      "markdown": "text"
    },
    "target": {
      "node": {
        "id": "text",
        "preview": "text"
      },
      "changeRequest": "text",
      "review": "text",
      "page": {
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "icon": "gear",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "updatedAt": "2026-01-25T23:51:25.823Z",
        "path": "text",
        "outdated": true
      },
      "space": "text",
      "revision": "text"
    },
    "urls": {
      "location": "https://example.com"
    },
    "status": "resolved",
    "resolvedAt": "2026-01-25T23:51:25.823Z",
    "resolvedBy": {
      "object": "user",
      "id": "text",
      "displayName": "text",
      "email": "text",
      "photoURL": "text",
      "urls": {
        "location": "https://example.com"
      }
    }
  },
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z"
}

Get all requested reviewers for a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

A list of requested reviewers

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "change-request-requested-reviewer",
      "revision": "text",
      "requestedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "createdAt": "2026-01-25T23:51:25.823Z",
      "kind": "user",
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Request reviewers on a change request. Note that requesting a review from teams is not yet supported.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Body

usersstring[]Required

An array of user ids that will be requested.

subjectstringOptional

Optionally, update the subject of the change request when requesting reviewers.

Responses

200

The requests have successfully been sent.

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "users": [
    "text"
  ],
  "subject": "text"
}

{
  "users": [
    {
      "object": "change-request-requested-reviewer",
      "revision": "text",
      "requestedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "createdAt": "2026-01-25T23:51:25.823Z",
      "kind": "user",
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Get all links in the context of a change request including their status and location where they appear.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

statusstring · enumOptional

Text to display to represent the reference. Possible values include:

ok - No problems detected for this content reference.
broken - The target does not exist in the revision.
in-app - The target is a URL link pointing to an internal location in the app.

Possible values:

brokenContextstring · enumOptionalPossible values:

Responses

200

application/json

404

The change request could not be found.

application/json

default

Unexpected Error

application/json

get

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

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

{
  "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-01-25T23:51:25.823Z",
          "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",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trialDecision": "downgrade",
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_isUsingSnippets": true,
          "internal_isOnNewTrial": true,
          "permissions": {
            "admin": true,
            "createContent": true
          }
        },
        "space": {
          "object": "space",
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "visibility": "public",
          "createdAt": "2026-01-25T23:51:25.823Z",
          "updatedAt": "2026-01-25T23:51:25.823Z",
          "deletedAt": "2026-01-25T23:51:25.823Z",
          "editMode": "live",
          "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",
          "gitSync": {
            "installationProvider": "github",
            "integration": "text",
            "url": "text",
            "updatedAt": "2026-01-25T23:51:25.823Z"
          },
          "visitorAuth": {
            "backend": "custom"
          },
          "revision": "text",
          "defaultLevel": "admin",
          "comments": 1,
          "changeRequests": 1,
          "changeRequestsOpen": 1,
          "changeRequestsDraft": 1,
          "permissions": {
            "access": true,
            "admin": true,
            "edit": true,
            "comment": true,
            "merge": true,
            "review": 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-01-25T23:51:25.823Z",
            "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",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trialDecision": "downgrade",
            "customHostname": "text",
            "blocked": {
              "reason": "security"
            },
            "internal_isUsingSnippets": true,
            "internal_isOnNewTrial": true,
            "permissions": {
              "admin": true,
              "createContent": true
            }
          },
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2026-01-25T23:51:25.823Z",
            "updatedAt": "2026-01-25T23:51:25.823Z",
            "deletedAt": "2026-01-25T23:51:25.823Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2026-01-25T23:51:25.823Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": 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 the comments in a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

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

Responses

200

application/json

default

Unexpected Error

application/json

get

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

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

{
  "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-01-25T23:51:25.823Z",
      "editedAt": "2026-01-25T23:51:25.823Z",
      "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-25T23:51:25.823Z"
            }
          ]
        }
      ],
      "replies": 1,
      "body": {
        "markdown": "text"
      },
      "target": {
        "node": {
          "id": "text",
          "preview": "text"
        },
        "changeRequest": "text",
        "review": "text",
        "page": {
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "icon": "gear",
          "createdAt": "2026-01-25T23:51:25.823Z",
          "updatedAt": "2026-01-25T23:51:25.823Z",
          "path": "text",
          "outdated": true
        },
        "space": "text",
        "revision": "text"
      },
      "urls": {
        "location": "https://example.com"
      },
      "status": "resolved",
      "resolvedAt": "2026-01-25T23:51:25.823Z",
      "resolvedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Post a new comment in a change request.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Body

nodestringOptional

The node to which the comment is posted, if any.

pagestringOptional

The page to which the comment is posted, if any.

bodyone ofRequired

The content of the comment.

object · EmptyOptional

Responses

200

The comment was posted.

application/json

default

Unexpected Error

application/json

post

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

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "node": "text",
  "page": "text",
  "body": {
    "markdown": "text"
  }
}

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "status": "resolved",
  "resolvedAt": "2026-01-25T23:51:25.823Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Get a comment in a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

The returned comment.

application/json

default

Unexpected Error

application/json

get

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

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

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "status": "resolved",
  "resolvedAt": "2026-01-25T23:51:25.823Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Update a comment in a change request.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

Body

resolvedbooleanOptional

Whether the comment is resolved or not.

bodyone ofOptional

Content of the comment.

object · EmptyOptional

addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses

200

The comment was updated.

application/json

default

Unexpected Error

application/json

put

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

PUT /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "resolved": true,
  "body": {
    "markdown": "text"
  },
  "addedReactions": [
    "text"
  ],
  "removedReactions": [
    "text"
  ]
}

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "status": "resolved",
  "resolvedAt": "2026-01-25T23:51:25.823Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Delete a comment in a change request.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

Responses

205

The comment has been deleted.

default

Unexpected Error

application/json

delete

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

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

No content

List all the replies to a comment in a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "comment-reply",
      "id": "text",
      "postedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "postedAt": "2026-01-25T23:51:25.823Z",
      "editedAt": "2026-01-25T23:51:25.823Z",
      "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-25T23:51:25.823Z"
            }
          ]
        }
      ],
      "body": {
        "markdown": "text"
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Post a new reply to a comment in a change request.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Body

bodyone ofRequired

The content of the comment.

object · EmptyOptional

Responses

200

The reply was posted.

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "body": {
    "markdown": "text"
  }
}

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Get a comment reply in a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

The returned comment reply.

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies/{commentReplyId}

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

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Update a comment reply in a change request.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Body

resolvedbooleanOptional

Whether the comment is resolved or not.

bodyone ofOptional

Content of the comment.

object · EmptyOptional

addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses

200

The reply was updated.

application/json

default

Unexpected Error

application/json

put

/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies/{commentReplyId}

PUT /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies/{commentReplyId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "resolved": true,
  "body": {
    "markdown": "text"
  },
  "addedReactions": [
    "text"
  ],
  "removedReactions": [
    "text"
  ]
}

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Delete a comment reply in a change request.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Responses

205

The comment has been deleted.

default

Unexpected Error

application/json

delete

/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies/{commentReplyId}

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

No content

Get all contributors for the change request with the given id.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Responses

200

Contributors on the change request

application/json

404

The change request could not be found.

application/json

default

Unexpected Error

application/json

get

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

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "count": 1,
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Get backlink locations for a file existing in a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

fileIdstringRequired

The unique id of the file

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

default

Unexpected Error

application/json

get

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

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "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",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "updatedAt": "2026-01-25T23:51:25.823Z",
        "deletedAt": "2026-01-25T23:51:25.823Z",
        "editMode": "live",
        "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",
        "gitSync": {
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2026-01-25T23:51:25.823Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "access": true,
          "admin": true,
          "edit": true,
          "comment": true,
          "merge": true,
          "review": 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 links in a page inside a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

pageIdstringRequired

The unique id of the page

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

default

Unexpected Error

application/json

get

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

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

{
  "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-01-25T23:51:25.823Z",
          "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",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trialDecision": "downgrade",
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_isUsingSnippets": true,
          "internal_isOnNewTrial": true,
          "permissions": {
            "admin": true,
            "createContent": true
          }
        },
        "space": {
          "object": "space",
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "visibility": "public",
          "createdAt": "2026-01-25T23:51:25.823Z",
          "updatedAt": "2026-01-25T23:51:25.823Z",
          "deletedAt": "2026-01-25T23:51:25.823Z",
          "editMode": "live",
          "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",
          "gitSync": {
            "installationProvider": "github",
            "integration": "text",
            "url": "text",
            "updatedAt": "2026-01-25T23:51:25.823Z"
          },
          "visitorAuth": {
            "backend": "custom"
          },
          "revision": "text",
          "defaultLevel": "admin",
          "comments": 1,
          "changeRequests": 1,
          "changeRequestsOpen": 1,
          "changeRequestsDraft": 1,
          "permissions": {
            "access": true,
            "admin": true,
            "edit": true,
            "comment": true,
            "merge": true,
            "review": 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-01-25T23:51:25.823Z",
            "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",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trialDecision": "downgrade",
            "customHostname": "text",
            "blocked": {
              "reason": "security"
            },
            "internal_isUsingSnippets": true,
            "internal_isOnNewTrial": true,
            "permissions": {
              "admin": true,
              "createContent": true
            }
          },
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2026-01-25T23:51:25.823Z",
            "updatedAt": "2026-01-25T23:51:25.823Z",
            "deletedAt": "2026-01-25T23:51:25.823Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2026-01-25T23:51:25.823Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": 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"
            }
          }
        }
      ]
    }
  ]
}

Get backlink locations for a page existing in a change request.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

pageIdstringRequired

The unique id of the page

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

default

Unexpected Error

application/json

get

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

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

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "kind": "file",
      "organization": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "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",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "space": {
        "object": "space",
        "id": "text",
        "title": "text",
        "emoji": "🎉",
        "visibility": "public",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "updatedAt": "2026-01-25T23:51:25.823Z",
        "deletedAt": "2026-01-25T23:51:25.823Z",
        "editMode": "live",
        "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",
        "gitSync": {
          "installationProvider": "github",
          "integration": "text",
          "url": "text",
          "updatedAt": "2026-01-25T23:51:25.823Z"
        },
        "visitorAuth": {
          "backend": "custom"
        },
        "revision": "text",
        "defaultLevel": "admin",
        "comments": 1,
        "changeRequests": 1,
        "changeRequestsOpen": 1,
        "changeRequestsDraft": 1,
        "permissions": {
          "access": true,
          "admin": true,
          "edit": true,
          "comment": true,
          "merge": true,
          "review": 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"
        }
      }
    }
  ]
}

Generate a URL to export the content of a change request as a PDF.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Query parameters

onlybooleanOptional

Generate a PDF only for the provided page.

pagestringOptional

ID of a specific page to generate a PDF for.

Responses

200

URL of the PDF

application/json

default

Unexpected Error

application/json

get

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

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

{
  "url": "https://example.com"
}

Brainstorm with AI on a change request and stream the results as a Server-Sent Events.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Body

Responses

200

Updated session.

text/event-stream

default

Unexpected Error

application/json

post

/spaces/{spaceId}/change-requests/{changeRequestId}/task/brainstorm

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/task/brainstorm HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 413

{
  "session": {
    "id": "text",
    "status": "pending",
    "messages": [
      {
        "id": "text",
        "actor": "user",
        "message": {
          "object": "document",
          "data": {
            "schemaVersion": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "nodes": [
            "[Circular Reference]"
          ]
        },
        "context": {
          "page": "text"
        },
        "logs": [
          {
            "tool": "get-page",
            "intent": "text",
            "page": {
              "id": "text",
              "type": "document",
              "title": "text",
              "path": "text"
            }
          }
        ],
        "attachment": {
          "type": "plan",
          "plan": "[Circular Reference]"
        }
      }
    ]
  }
}

{
  "id": "text",
  "status": "pending",
  "messages": [
    {
      "id": "text",
      "actor": "user",
      "message": {
        "object": "document",
        "data": {
          "schemaVersion": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "nodes": [
          "[Circular Reference]"
        ]
      },
      "context": {
        "page": "text"
      },
      "logs": [
        {
          "tool": "get-page",
          "intent": "text",
          "page": {
            "id": "text",
            "type": "document",
            "title": "text",
            "path": "text"
          }
        }
      ],
      "attachment": {
        "type": "plan",
        "plan": {
          "status": "pending",
          "title": "text",
          "steps": "[Circular Reference]",
          "context": {
            "page": "text"
          }
        }
      }
    }
  ]
}

Implement a task on a change request and stream the results as a Server-Sent Events.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

Body

Responses

200

Task being implemented.

text/event-stream

default

Unexpected Error

application/json

post

/spaces/{spaceId}/change-requests/{changeRequestId}/task/implement

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/task/implement HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "plan": {
    "status": "pending",
    "title": "text",
    "steps": [
      {
        "title": "text",
        "status": "pending",
        "instruction": {
          "object": "document",
          "data": {
            "schemaVersion": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "nodes": [
            "[Circular Reference]"
          ]
        },
        "implementation": {
          "summary": {
            "object": "document",
            "data": {
              "schemaVersion": 1,
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "nodes": [
              "[Circular Reference]"
            ]
          },
          "logs": [
            {
              "tool": "get-page",
              "intent": "text",
              "page": {
                "id": "text",
                "type": "document",
                "title": "text",
                "path": "text"
              }
            }
          ]
        }
      }
    ],
    "context": {
      "page": "text"
    }
  }
}

{
  "status": "pending",
  "title": "text",
  "steps": [
    {
      "title": "text",
      "status": "pending",
      "instruction": {
        "object": "document",
        "data": {
          "schemaVersion": 1,
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "nodes": [
          "[Circular Reference]"
        ]
      },
      "implementation": {
        "summary": {
          "object": "document",
          "data": {
            "schemaVersion": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "nodes": [
            "[Circular Reference]"
          ]
        },
        "logs": [
          {
            "tool": "get-page",
            "intent": "text",
            "page": {
              "id": "text",
              "type": "document",
              "title": "text",
              "path": "text"
            }
          }
        ]
      }
    }
  ],
  "context": {
    "page": "text"
  }
}

List all the comments in a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

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:

statusstring · enumOptional

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

Default: allPossible values:

formatstring · enumOptional

Output format for the content.

Possible values:

targetPagestringOptional

The target page of the comment

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/comments

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

{
  "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-01-25T23:51:25.823Z",
      "editedAt": "2026-01-25T23:51:25.823Z",
      "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-25T23:51:25.823Z"
            }
          ]
        }
      ],
      "replies": 1,
      "body": {
        "markdown": "text"
      },
      "target": {
        "node": {
          "id": "text",
          "preview": "text"
        },
        "changeRequest": "text",
        "review": "text",
        "page": {
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "icon": "gear",
          "createdAt": "2026-01-25T23:51:25.823Z",
          "updatedAt": "2026-01-25T23:51:25.823Z",
          "path": "text",
          "outdated": true
        },
        "space": "text",
        "revision": "text"
      },
      "urls": {
        "location": "https://example.com"
      },
      "status": "resolved",
      "resolvedAt": "2026-01-25T23:51:25.823Z",
      "resolvedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Post a new comment in a space.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

nodestringOptional

The node to which the comment is posted, if any.

pagestringOptional

The page to which the comment is posted, if any.

bodyone ofRequired

The content of the comment.

object · EmptyOptional

Responses

200

The comment was posted.

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/comments

POST /v1/spaces/{spaceId}/comments HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "node": "text",
  "page": "text",
  "body": {
    "markdown": "text"
  }
}

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "status": "resolved",
  "resolvedAt": "2026-01-25T23:51:25.823Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Get a comment in a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

The returned comment.

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/comments/{commentId}

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

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "status": "resolved",
  "resolvedAt": "2026-01-25T23:51:25.823Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Update a comment in a space.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Body

resolvedbooleanOptional

Whether the comment is resolved or not.

bodyone ofOptional

Content of the comment.

object · EmptyOptional

addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses

200

The comment was updated.

application/json

default

Unexpected Error

application/json

put

/spaces/{spaceId}/comments/{commentId}

PUT /v1/spaces/{spaceId}/comments/{commentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "resolved": true,
  "body": {
    "markdown": "text"
  },
  "addedReactions": [
    "text"
  ],
  "removedReactions": [
    "text"
  ]
}

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "status": "resolved",
  "resolvedAt": "2026-01-25T23:51:25.823Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Delete a comment in a space.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Responses

205

The comment has been deleted.

default

Unexpected Error

application/json

delete

/spaces/{spaceId}/comments/{commentId}

DELETE /v1/spaces/{spaceId}/comments/{commentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List all the replies to a comment in a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/comments/{commentId}/replies

GET /v1/spaces/{spaceId}/comments/{commentId}/replies HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "comment-reply",
      "id": "text",
      "postedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "postedAt": "2026-01-25T23:51:25.823Z",
      "editedAt": "2026-01-25T23:51:25.823Z",
      "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-25T23:51:25.823Z"
            }
          ]
        }
      ],
      "body": {
        "markdown": "text"
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Post a new reply to a comment in a space.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Body

bodyone ofRequired

The content of the comment.

object · EmptyOptional

Responses

200

The reply was posted.

application/json

default

Unexpected Error

application/json

post

/spaces/{spaceId}/comments/{commentId}/replies

POST /v1/spaces/{spaceId}/comments/{commentId}/replies HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "body": {
    "markdown": "text"
  }
}

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Get a comment reply in a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

The returned comment reply.

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId}

GET /v1/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Update a comment reply in a space.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Body

bodyone ofOptional

Content of the comment.

object · EmptyOptional

addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses

200

The reply was updated.

application/json

default

Unexpected Error

application/json

put

/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId}

PUT /v1/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "body": {
    "markdown": "text"
  },
  "addedReactions": [
    "text"
  ],
  "removedReactions": [
    "text"
  ]
}

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2026-01-25T23:51:25.823Z",
  "editedAt": "2026-01-25T23:51:25.823Z",
  "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-25T23:51:25.823Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Delete a comment reply in a space.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Responses

205

The comment has been deleted.

default

Unexpected Error

application/json

delete

/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId}

DELETE /v1/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deprecated

Get the publishing customization configuration for a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

200

application/json

400

Bad Request

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/publishing/customization

GET /v1/spaces/{spaceId}/publishing/customization HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "inherit": true,
  "title": "text",
  "styling": {
    "primaryColor": {
      "light": "text",
      "dark": "text"
    },
    "corners": "straight",
    "font": "ABCFavorit"
  },
  "internationalization": {
    "locale": "en",
    "inherit": true
  },
  "favicon": {
    "icon": {
      "light": "https://example.com",
      "dark": "https://example.com"
    }
  },
  "header": {
    "preset": "default",
    "logo": {
      "light": "https://example.com",
      "dark": "https://example.com"
    },
    "backgroundColor": {
      "light": "text",
      "dark": "text"
    },
    "linkColor": {
      "light": "text",
      "dark": "text"
    },
    "links": [
      {
        "title": "text",
        "style": "link",
        "to": {
          "kind": "file",
          "file": "text"
        },
        "links": [
          {
            "title": "text",
            "to": {
              "kind": "file",
              "file": "text"
            }
          }
        ]
      }
    ]
  },
  "footer": {
    "logo": {
      "light": "https://example.com",
      "dark": "https://example.com"
    },
    "groups": [
      {
        "title": "text",
        "links": [
          {
            "title": "text",
            "to": {
              "kind": "file",
              "file": "text"
            }
          }
        ]
      }
    ],
    "copyright": "text"
  },
  "themes": {
    "default": "light",
    "toggeable": true
  },
  "pdf": {
    "enabled": true
  },
  "feedback": {
    "enabled": true
  },
  "aiSearch": {
    "enabled": true
  },
  "git": {
    "showEditLink": true
  },
  "pagination": {
    "enabled": true
  },
  "trademark": {
    "enabled": true
  },
  "privacyPolicy": {
    "url": "https://example.com"
  },
  "socialPreview": {
    "url": "https://example.com"
  }
}

Deprecated

Update the publishing customization configuration for a space.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

inheritbooleanRequired

Inherit customization settings from the parent collection.

titlestringOptional

Title to use for the published content. If not defined, it'll fallback to the content title.

faviconone ofRequired

objectOptional

Responses

200

application/json

400

Bad Request

application/json

default

Unexpected Error

application/json

put

/spaces/{spaceId}/publishing/customization

PUT /v1/spaces/{spaceId}/publishing/customization HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1085

{
  "inherit": true,
  "title": "text",
  "styling": {
    "primaryColor": {
      "light": "text",
      "dark": "text"
    },
    "corners": "straight",
    "font": "ABCFavorit"
  },
  "internationalization": {
    "locale": "en",
    "inherit": true
  },
  "favicon": {
    "icon": {
      "light": "https://example.com",
      "dark": "https://example.com"
    }
  },
  "header": {
    "preset": "default",
    "logo": {
      "light": "https://example.com",
      "dark": "https://example.com"
    },
    "backgroundColor": {
      "light": "text",
      "dark": "text"
    },
    "linkColor": {
      "light": "text",
      "dark": "text"
    },
    "links": [
      {
        "title": "text",
        "style": "link",
        "to": {
          "kind": "file",
          "file": "text"
        },
        "links": [
          {
            "title": "text",
            "to": {
              "kind": "file",
              "file": "text"
            }
          }
        ]
      }
    ]
  },
  "footer": {
    "logo": {
      "light": "https://example.com",
      "dark": "https://example.com"
    },
    "groups": [
      {
        "title": "text",
        "links": [
          {
            "title": "text",
            "to": {
              "kind": "file",
              "file": "text"
            }
          }
        ]
      }
    ],
    "copyright": "text"
  },
  "themes": {
    "default": "light",
    "toggeable": true
  },
  "pdf": {
    "enabled": true
  },
  "feedback": {
    "enabled": true
  },
  "aiSearch": {
    "enabled": true
  },
  "git": {
    "showEditLink": true
  },
  "pagination": {
    "enabled": true
  },
  "trademark": {
    "enabled": true
  },
  "privacyPolicy": {
    "url": "https://example.com"
  },
  "socialPreview": {
    "url": "https://example.com"
  }
}

{
  "inherit": true,
  "title": "text",
  "styling": {
    "primaryColor": {
      "light": "text",
      "dark": "text"
    },
    "corners": "straight",
    "font": "ABCFavorit"
  },
  "internationalization": {
    "locale": "en",
    "inherit": true
  },
  "favicon": {
    "icon": {
      "light": "https://example.com",
      "dark": "https://example.com"
    }
  },
  "header": {
    "preset": "default",
    "logo": {
      "light": "https://example.com",
      "dark": "https://example.com"
    },
    "backgroundColor": {
      "light": "text",
      "dark": "text"
    },
    "linkColor": {
      "light": "text",
      "dark": "text"
    },
    "links": [
      {
        "title": "text",
        "style": "link",
        "to": {
          "kind": "file",
          "file": "text"
        },
        "links": [
          {
            "title": "text",
            "to": {
              "kind": "file",
              "file": "text"
            }
          }
        ]
      }
    ]
  },
  "footer": {
    "logo": {
      "light": "https://example.com",
      "dark": "https://example.com"
    },
    "groups": [
      {
        "title": "text",
        "links": [
          {
            "title": "text",
            "to": {
              "kind": "file",
              "file": "text"
            }
          }
        ]
      }
    ],
    "copyright": "text"
  },
  "themes": {
    "default": "light",
    "toggeable": true
  },
  "pdf": {
    "enabled": true
  },
  "feedback": {
    "enabled": true
  },
  "aiSearch": {
    "enabled": true
  },
  "git": {
    "showEditLink": true
  },
  "pagination": {
    "enabled": true
  },
  "trademark": {
    "enabled": true
  },
  "privacyPolicy": {
    "url": "https://example.com"
  },
  "socialPreview": {
    "url": "https://example.com"
  }
}

List the scripts to embed in published content for a space.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

200

application/json

400

Bad Request

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/integration-scripts

GET /v1/spaces/{spaceId}/integration-scripts HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "script": "https://example.com",
    "contentSecurityPolicy": "text",
    "cookies": true
  }
]

Get the values of the custom fields set on a space

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/custom-fields

GET /v1/spaces/{spaceId}/custom-fields HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "customField": {
      "id": "text",
      "name": "text",
      "title": "text",
      "description": "text",
      "type": "text",
      "placeholder": "text",
      "options": [
        "text"
      ],
      "createdAt": "2026-01-25T23:51:25.823Z",
      "updatedAt": "2026-01-25T23:51:25.823Z",
      "urls": {
        "location": "https://example.com"
      }
    },
    "value": "text"
  }
]

Update the custom fields in a space

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

Responses

204

Custom fields updated

default

Unexpected Error

application/json

patch

/spaces/{spaceId}/custom-fields

PATCH /v1/spaces/{spaceId}/custom-fields HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "values": {
    "ANY_ADDITIONAL_PROPERTY": {
      "value": "text"
    }
  }
}

No content

Get a page feedback by a visitor.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

pageIdstringRequired

The unique id of the page

visitorIdstringRequired

The id of the visitor

Responses

200

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/pages/{pageId}/feedbacks/{visitorId}

GET /v1/spaces/{spaceId}/pages/{pageId}/feedbacks/{visitorId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "page-feedback",
  "visitorId": "text",
  "rating": "bad",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "revision": "text",
  "urls": {
    "location": "https://example.com"
  }
}

Create a page feedback by a visitor.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

pageIdstringRequired

The unique id of the page

visitorIdstringRequired

The id of the visitor

Body

ratingstring · enumRequiredPossible values:

Responses

200

Feedback updated

application/json

201

Feedback created

application/json

default

Unexpected Error

application/json

put

/spaces/{spaceId}/pages/{pageId}/feedbacks/{visitorId}

PUT /v1/spaces/{spaceId}/pages/{pageId}/feedbacks/{visitorId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "rating": "bad"
}

{
  "object": "page-feedback",
  "visitorId": "text",
  "rating": "bad",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "revision": "text",
  "urls": {
    "location": "https://example.com"
  }
}

Generate a URL to export the content of the space as a PDF.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

onlybooleanOptional

Generate a PDF only for the provided page.

pagestringOptional

ID of a specific page to generate a PDF for.

Responses

200

URL of the PDF

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/pdf

GET /v1/spaces/{spaceId}/pdf HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "https://example.com"
}

Get all links in a space including their status and location where they appear.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

statusstring · enumOptional

Text to display to represent the reference. Possible values include:

ok - No problems detected for this content reference.
broken - The target does not exist in the revision.
in-app - The target is a URL link pointing to an internal location in the app.

Possible values:

Responses

200

application/json

404

The space could not be found.

application/json

default

Unexpected Error

application/json

get

/spaces/{spaceId}/links

GET /v1/spaces/{spaceId}/links HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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-01-25T23:51:25.823Z",
          "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",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trialDecision": "downgrade",
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_isUsingSnippets": true,
          "internal_isOnNewTrial": true,
          "permissions": {
            "admin": true,
            "createContent": true
          }
        },
        "space": {
          "object": "space",
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "visibility": "public",
          "createdAt": "2026-01-25T23:51:25.823Z",
          "updatedAt": "2026-01-25T23:51:25.823Z",
          "deletedAt": "2026-01-25T23:51:25.823Z",
          "editMode": "live",
          "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",
          "gitSync": {
            "installationProvider": "github",
            "integration": "text",
            "url": "text",
            "updatedAt": "2026-01-25T23:51:25.823Z"
          },
          "visitorAuth": {
            "backend": "custom"
          },
          "revision": "text",
          "defaultLevel": "admin",
          "comments": 1,
          "changeRequests": 1,
          "changeRequestsOpen": 1,
          "changeRequestsDraft": 1,
          "permissions": {
            "access": true,
            "admin": true,
            "edit": true,
            "comment": true,
            "merge": true,
            "review": 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-01-25T23:51:25.823Z",
            "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",
            "urls": {
              "location": "https://example.com",
              "app": "https://example.com",
              "logo": "https://example.com"
            },
            "trialDecision": "downgrade",
            "customHostname": "text",
            "blocked": {
              "reason": "security"
            },
            "internal_isUsingSnippets": true,
            "internal_isOnNewTrial": true,
            "permissions": {
              "admin": true,
              "createContent": true
            }
          },
          "space": {
            "object": "space",
            "id": "text",
            "title": "text",
            "emoji": "🎉",
            "visibility": "public",
            "createdAt": "2026-01-25T23:51:25.823Z",
            "updatedAt": "2026-01-25T23:51:25.823Z",
            "deletedAt": "2026-01-25T23:51:25.823Z",
            "editMode": "live",
            "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",
            "gitSync": {
              "installationProvider": "github",
              "integration": "text",
              "url": "text",
              "updatedAt": "2026-01-25T23:51:25.823Z"
            },
            "visitorAuth": {
              "backend": "custom"
            },
            "revision": "text",
            "defaultLevel": "admin",
            "comments": 1,
            "changeRequests": 1,
            "changeRequestsOpen": 1,
            "changeRequestsDraft": 1,
            "permissions": {
              "access": true,
              "admin": true,
              "edit": true,
              "comment": true,
              "merge": true,
              "review": 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"
            }
          }
        }
      ]
    }
  ]
}

Create an organization space

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

titlestring · max: 50Optional

emojistring · emoji · max: 50Optional

Unicode codepoint or character of the emoji

Example: 🎉

privatebooleanOptionalDeprecated

Private spaces are no longer supported by GitBook.

parentstringOptional

ID of a parent collection

Responses

201

Space created

application/json

default

Unexpected Error

application/json

post

/orgs/{organizationId}/spaces

POST /v1/orgs/{organizationId}/spaces HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "title": "text",
  "emoji": "🎉",
  "parent": "text"
}

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2026-01-25T23:51:25.823Z",
  "updatedAt": "2026-01-25T23:51:25.823Z",
  "deletedAt": "2026-01-25T23:51:25.823Z",
  "editMode": "live",
  "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",
  "gitSync": {
    "installationProvider": "github",
    "integration": "text",
    "url": "text",
    "updatedAt": "2026-01-25T23:51:25.823Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "permissions": {
    "access": true,
    "admin": true,
    "edit": true,
    "comment": true,
    "merge": true,
    "review": true
  }
}

List integrations owned by an organization

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

searchstringOptional

A search string to filter integrations by name

Responses

200

List of integrations.

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/integrations

GET /v1/orgs/{organizationId}/integrations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "integration",
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "previewImages": [
        "text"
      ],
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "snippets:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "urlUnfurl": [
            "text"
          ],
          "markdown": {
            "codeblock": "text",
            "body": "text"
          }
        }
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "configurations": {
        "account": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "space": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        },
        "site": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "type": "string",
              "default": "text"
            }
          },
          "required": [
            "text"
          ]
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "object": "organization",
        "id": "text",
        "title": "text",
        "createdAt": "2026-01-25T23:51:25.823Z",
        "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",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trialDecision": "downgrade",
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_isUsingSnippets": true,
        "internal_isOnNewTrial": true,
        "permissions": {
          "admin": true,
          "createContent": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      },
      "contentSecurityPolicy": "text"
    }
  ]
}

List installations of integrations in an organization.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

searchstringOptional

A search string to filter integrations by name

Responses

200

List of integrations with the associated installations.

application/json

default

Unexpected Error

application/json

get

/orgs/{organizationId}/installations

GET /v1/orgs/{organizationId}/installations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "installation": {
        "id": "text",
        "status": "active",
        "space_selection": "all",
        "site_selection": "all",
        "spaces": 1,
        "configuration": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "createdAt": "2026-01-25T23:51:25.823Z",
        "updatedAt": "2026-01-25T23:51:25.823Z",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "publicEndpoint": "https://example.com"
        },
        "externalIds": [
          "text"
        ],
        "target": {
          "organization": "text"
        }
      },
      "integration": {
        "object": "integration",
        "name": "text",
        "version": 1,
        "title": "text",
        "description": "text",
        "summary": "text",
        "previewImages": [
          "text"
        ],
        "target": "all",
        "verified": true,
        "visibility": "public",
        "scopes": [
          "snippets:read"
        ],
        "categories": [
          "analytics"
        ],
        "blocks": [
          {
            "id": "text",
            "title": "text",
            "description": "text",
            "icon": "text",
            "urlUnfurl": [
              "text"
            ],
            "markdown": {
              "codeblock": "text",
              "body": "text"
            }
          }
        ],
        "contentSources": [
          {
            "id": "text",
            "title": "text",
            "description": "text",
            "icon": "text",
            "configuration": {
              "componentId": "text"
            }
          }
        ],
        "configurations": {
          "account": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "type": "string",
                "default": "text"
              }
            },
            "required": [
              "text"
            ]
          },
          "space": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "type": "string",
                "default": "text"
              }
            },
            "required": [
              "text"
            ]
          },
          "site": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "type": "string",
                "default": "text"
              }
            },
            "required": [
              "text"
            ]
          }
        },
        "externalLinks": [
          {
            "url": "https://example.com",
            "label": "text"
          }
        ],
        "owner": {
          "object": "organization",
          "id": "text",
          "title": "text",
          "createdAt": "2026-01-25T23:51:25.823Z",
          "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",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trialDecision": "downgrade",
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_isUsingSnippets": true,
          "internal_isOnNewTrial": true,
          "permissions": {
            "admin": true,
            "createContent": true
          }
        },
        "urls": {
          "location": "https://example.com",
          "icon": "https://example.com",
          "app": "https://example.com",
          "assets": "https://example.com",
          "publicEndpoint": "https://example.com"
        },
        "permissions": {
          "admin": true
        },
        "contentSecurityPolicy": "text"
      }
    }
  ]
}

Last updated 2 months ago

Was this helpful?

hashtagGet the details about a space.

hashtagSoft-deletes a space. Soft-deleted spaces will be permanently removed after 7 days.

hashtagUpdate the details of a space

hashtagCreate a duplicate of the space.

hashtagRestore a recently soft-deleted space.

hashtagMove a space to a new position.

hashtagTransfer a space to another organization, collection or both.

hashtagResolve a URL to an embed in a given space

hashtagImport a Git repository

hashtagExport the space content to a Git repository.

hashtagGet metadata about the Git Sync provider currently set up on the space

hashtagInvite to a space

hashtagRemove a team from a space

hashtagRemove a user from a space

hashtagGet backlink locations for a file existing in a space.

hashtagList all links in a page

hashtagGet backlink locations for a page existing in a space.

hashtagList change requests for a space.

hashtagCreate a new change request for a space.

hashtagGet the change request with the given id.

hashtagUpdate the details of a change request

hashtagMerge a change request in the primary content of a space.

hashtagUpdate a change-request with changes from primary content.

hashtagGet all reviews for a change request.

hashtagSubmit a review for a change request.

hashtagGet all requested reviewers for a change request.

hashtagRequest reviewers on a change request. Note that requesting a review from teams is not yet supported.

hashtagGet all links in the context of a change request including their status and location where they appear.

hashtagList all the comments in a change request.

hashtagPost a new comment in a change request.

hashtagGet a comment in a change request.

hashtagUpdate a comment in a change request.

hashtagDelete a comment in a change request.

hashtagList all the replies to a comment in a change request.

hashtagPost a new reply to a comment in a change request.

hashtagGet a comment reply in a change request.

hashtagUpdate a comment reply in a change request.

hashtagDelete a comment reply in a change request.

hashtagGet all contributors for the change request with the given id.

hashtagGet backlink locations for a file existing in a change request.

hashtagList all links in a page inside a change request.

hashtagGet backlink locations for a page existing in a change request.

hashtagGenerate a URL to export the content of a change request as a PDF.

hashtagBrainstorm with AI on a change request and stream the results as a Server-Sent Events.

hashtagImplement a task on a change request and stream the results as a Server-Sent Events.

hashtagList all the comments in a space.

hashtagPost a new comment in a space.

hashtagGet a comment in a space.

hashtagUpdate a comment in a space.

hashtagDelete a comment in a space.

hashtagList all the replies to a comment in a space.

hashtagPost a new reply to a comment in a space.

hashtagGet a comment reply in a space.

hashtagUpdate a comment reply in a space.

hashtagDelete a comment reply in a space.

hashtagGet the publishing customization configuration for a space.

hashtagUpdate the publishing customization configuration for a space.

hashtagList the scripts to embed in published content for a space.

hashtagGet the values of the custom fields set on a space

hashtagUpdate the custom fields in a space

hashtagGet a page feedback by a visitor.

hashtagCreate a page feedback by a visitor.

hashtagGenerate a URL to export the content of the space as a PDF.

hashtagGet all links in a space including their status and location where they appear.

hashtagCreate an organization space

hashtagList integrations owned by an organization

hashtagList installations of integrations in an organization.

Get the details about a space.

Soft-deletes a space. Soft-deleted spaces will be permanently removed after 7 days.

Update the details of a space

Create a duplicate of the space.

Restore a recently soft-deleted space.

Move a space to a new position.

Transfer a space to another organization, collection or both.

Resolve a URL to an embed in a given space

Import a Git repository

Export the space content to a Git repository.

Get metadata about the Git Sync provider currently set up on the space

Invite to a space

Remove a team from a space

Remove a user from a space

Get backlink locations for a file existing in a space.

List all links in a page

Get backlink locations for a page existing in a space.

List change requests for a space.

Create a new change request for a space.

Get the change request with the given id.

Update the details of a change request

Merge a change request in the primary content of a space.

Update a change-request with changes from primary content.

Get all reviews for a change request.

Submit a review for a change request.

Get all requested reviewers for a change request.

Request reviewers on a change request. Note that requesting a review from teams is not yet supported.

Get all links in the context of a change request including their status and location where they appear.

List all the comments in a change request.

Post a new comment in a change request.

Get a comment in a change request.

Update a comment in a change request.

Delete a comment in a change request.

List all the replies to a comment in a change request.

Post a new reply to a comment in a change request.

Get a comment reply in a change request.

Update a comment reply in a change request.

Delete a comment reply in a change request.

Get all contributors for the change request with the given id.

Get backlink locations for a file existing in a change request.

List all links in a page inside a change request.

Get backlink locations for a page existing in a change request.

Generate a URL to export the content of a change request as a PDF.

Brainstorm with AI on a change request and stream the results as a Server-Sent Events.

Implement a task on a change request and stream the results as a Server-Sent Events.

List all the comments in a space.

Post a new comment in a space.

Get a comment in a space.

Update a comment in a space.

Delete a comment in a space.

List all the replies to a comment in a space.

Post a new reply to a comment in a space.

Get a comment reply in a space.

Update a comment reply in a space.

Delete a comment reply in a space.

Get the publishing customization configuration for a space.

Update the publishing customization configuration for a space.

List the scripts to embed in published content for a space.

Get the values of the custom fields set on a space

Update the custom fields in a space

Get a page feedback by a visitor.

Create a page feedback by a visitor.

Generate a URL to export the content of the space as a PDF.

Get all links in a space including their status and location where they appear.

Create an organization space

List integrations owned by an organization

List installations of integrations in an organization.