GitBook

Gitbook Create Change Request

Create a new change request in a GitBook space. Change requests are branch-like constructs for proposing documentation edits. They start as drafts and can be opened for review, then merged or closed. Optionally provide a subject (title) for the change request. Returns: the created change request with id, number, status, revision, urls.

Gitbook Create Comment

Create a comment on a GitBook space or change request. With just space_id + body: creates a space-level comment. With change_request_id: creates a comment on that change request. With comment_id: posts a reply to an existing comment thread. With page_id: attaches the comment to a specific page. Body is markdown text. Returns: the created comment/reply object with id, body, postedBy, postedAt.

Gitbook Create Space

Create a new GitBook space (documentation project) in an organization. Requires a title and organization_id. Visibility defaults to private. The new space starts with a default page and an initial revision. Returns: the created space object with id, title, visibility, urls.

Gitbook Get Change Requests

Get change requests (similar to pull requests) in a GitBook space. Lists all change requests filtered by status, or retrieves a single one by change_request_id. Change requests are used for collaborative editing — contributors propose changes that get reviewed and merged. Filter by 'open', 'closed', 'merged', or 'draft' status. Returns: items[] with id, number, subject, status, createdAt, createdBy, urls.

Gitbook Get Collections

Get GitBook collections (folders that group related spaces). Pass organization_id to list all collections in an org. Pass collection_id to get a single collection's details. Pass collection_id + list_spaces=true to list the spaces within that collection. Collections are optional grouping containers — spaces can also exist standalone in an org. Returns: items[] with id, title, description, urls.

Gitbook Get Comments

Get comments on a GitBook space or change request. With just space_id: lists space-level comments. With space_id + change_request_id: lists comments on that change request. With comment_id: returns a single comment's details. With comment_id + list_replies=true: returns replies to that comment. Comments support threaded discussions on documentation content. Returns: items[] with id, body, postedBy, postedAt, replies count, status.

Gitbook Get Content

Get documentation content from a GitBook space. Called with just space_id: returns the current revision's hierarchical content tree (pages, groups, links). With list_pages=true: returns a flat list of all pages with id, title, path, kind. With page_id or page_path: returns a single page's full details including document content. Content is organized hierarchically — pages can be nested under groups. Returns: revision info with pages tree, or individual page with title, description, path, documen

Gitbook Get Files

Get files (images, PDFs, and other assets) attached to a GitBook space. Lists all files in the space's current revision, or retrieves a single file by file_id. Useful for auditing uploaded assets or finding file URLs for embedding. Returns: items[] with id, name, contentType, downloadURL, size.

Gitbook Get Org Members

Get members of a GitBook organization. Lists all members with their roles and join dates, or retrieves a single member by user_id. Use 'search' to filter by display name or email, 'role' to filter by permission level. Useful for auditing access, managing team permissions, or finding specific users. Returns: items[] with user (id, displayName, email), role, joinedAt, lastSeenAt.

Gitbook Get Orgs

Get GitBook organizations. Without arguments, lists every organization the authenticated user is a member of. Pass organization_id to retrieve details for a single org (name, plan, member count, URLs). Organization IDs are needed for spaces, teams, members, collections, and search. Returns: items[] with id, title, urls, createdAt, plan.

Gitbook Get Revisions

Get a specific revision (immutable content snapshot) of a GitBook space. Every merge creates a new revision. Use this to inspect historical content states. With show_changes=true: returns the diff introduced by this revision vs its parent. With list_pages=true: returns a flat list of all pages in the revision. Returns: revision object with id, pages tree, files, createdAt, type.

Gitbook Get Space Permissions

Get aggregated permissions for a GitBook space. Returns all users and teams that have access to the space, along with their permission levels. Useful for auditing who can view, edit, or admin a documentation project. Returns: items[] with user/team info and permission level (admin, edit, review, comment, read).

Gitbook Get Spaces

Get GitBook spaces (documentation projects). Pass space_id to get a single space's details. Pass organization_id (without space_id) to list all spaces in that org. Spaces are the primary containers for documentation content, pages, and change requests. Returns: id, title, visibility, urls, createdAt, updatedAt, gitSync status.

Gitbook Get Team Members

Get members of a specific GitBook team. Returns all users in the team along with their membership details. Teams are org-level groups used for bulk permission assignment on spaces and collections. Returns: items[] with user (id, displayName, email), role, joinedAt.

Gitbook Get Teams

Get teams in a GitBook organization. Lists all teams or retrieves a single team by team_id. Teams group members for shared space permissions and access control. Use 'title' to search for teams by name. Returns: items[] with id, title, members count, createdAt.

Gitbook Get User

Get a GitBook user profile. When called without arguments, returns the authenticated user's own profile (name, email, photo URL). Pass user_id to look up any user by their unique identifier. Use this first to confirm API connectivity and see who the token belongs to. Returns: id, displayName, email, photoURL, urls.

Gitbook Merge Change Request

Merge a GitBook change request into the space's primary content. This applies all proposed edits from the change request to the main revision. The change request must be in 'open' status. Creates a new revision in the space. Returns: merge result with the new revision ID.

Gitbook Search Content

Search GitBook documentation content by keyword. Searches across all spaces in an organization (pass organization_id) or within a single space (pass space_id). Finds pages matching the query and returns ranked results with titles, paths, and matched content snippets. Use for locating specific documentation, finding references to topics, or auditing content coverage. Returns: items[] with title, path, space info, and matched sections.

Gitbook Update Change Request

Update an existing GitBook change request. Can modify the subject (title) and/or status (draft, open, archived). Set status to 'open' to submit for review, 'archived' to close without merging. Returns: the updated change request object.