Skip to main content
GitBook
GitBook
61 actions · 1 auth method
PreviewIAM

Authentication

API Key

Connect using your GitBook Personal Access Token. Generate tokens from your Developer Settings.Guides: Connector Profile, Link Account
Actions
61 actions
Action
Description
List All Change Requests In A Space
Get all change requests in a space
Get A Change Request By Its ID
Retrieve detailed information about a specific change request
Create A New Change Request
Create a new change request in a space
Update A Change Request
Update properties of an existing change request
Merge A Change Request
Merge a change request into the main content
Get All Change Request Reviewers
List requested reviewers for a change request
Remove A Reviewer From A Change Request
Remove a requested reviewer from a change request
List All Collections
Get all collections in an organization
Get A Collection By Its ID
Retrieve detailed information about a specific collection
Create A New Collection
Create a new collection in an organization
Update A Collection
Update properties of an existing collection
Delete A Collection
Delete a collection
List Collection User Permissions
List users who have been added to a collection
Update A Collection User Permission
Update user permission level in a collection
Remove A User From A Collection
Remove a user’s access to a collection
Get Space Git Info
Get Git Sync configuration and status for a space
Import A Git Repository
Trigger a Git Sync import operation
Get Unified Credentials
Return the authenticated identity and auth type for the current GitBook connection. Calls GET /user to confirm Personal…
List Unified Groups
List GitBook organization teams mapped to the IAM unified group schema, cursor-paginated. Wraps GET /orgs/{organization_…
Get Unified Group
Retrieve a single GitBook team by id, mapped to the IAM unified group schema. Wraps GET /orgs/{organization_id}/teams/{i…
List Unified Organizations
List every GitBook organization the authenticated account is a member of, cursor-paginated. Wraps GET /orgs. Each entry…
Get Unified Organization
Retrieve a single GitBook organization by id, mapped to the IAM unified organization schema. Wraps GET /orgs/{organizati…
List Unified Resource Types
List unified resource types in GitBook.
List Unified Resource Users
List unified resource users in GitBook.
List Unified Roles
Return the seven GitBook organization member roles as IAM role records (admin, create, edit, review, comment, read, gues…
Get Unified Role
Retrieve a single GitBook organization role by its key (admin, create, edit, review, comment, read, guest). Returns the…
List Unified Users
List GitBook organization members mapped to the IAM unified user schema, cursor-paginated. Wraps GET /orgs/{organization…
Get Unified User
Retrieve a single GitBook organization member by user id, mapped to the IAM unified user schema. Wraps GET /orgs/{organi…
Update Unified User
Update a GitBook organization member’s role.
Delete Unified User
Remove a member from a GitBook organization.
List Organization Invites
List all invite links in an organization
Get An Organization Invite Link
Retrieve details of a specific invite link
Create A New Organization Invite
Create a new invite link for the organization
Invite Users To Organization
Invite users to organization by email
Deletes An Organization Invite
Deletes an organization invite link
Get The List Of Organizations For The Currently Authenticated User
List all organizations accessible to the authenticated user
Get An Organization By Its ID
Retrieve detailed information about a specific organization
Update An Organization
Update properties of an existing organization
List All Organization Members
Get all members of an organization
Get An Organization Member By Its ID
Retrieve detailed information about a specific organization member
Delete An Organization Member
Remove a member from an organization
List Space User Permissions
List users who have been added to a space
List All Space Users Permissions
List all users who can access a space with aggregated permissions
Update Space User Permissions
Update user permission level in a space
Remove A Space User
Remove a user’s access to a space
List All Spaces
Get all spaces in an organization
Get A Space By Its ID
Retrieve detailed information about a specific space
Create A New Space
Create a new documentation space in an organization
Update A Space
Update properties of an existing space
Delete A Space
Delete a space and move it to trash
Get A URL Of The Content Of A Space As PDF
Generate and retrieve a temporary URL to export space content as PDF
List All Teams
Get all teams in an organization
Get A Team
Retrieve detailed information about a specific team
Create A New Team
Create a new team in an organization
Update A Team
Update properties of an existing team
Delete A Team
Delete a team from an organization
List All Team Members
Get all members of a team with their roles
Add A Member To A Team
Add a user to a team
Delete A Team Member
Remove a member from a team
Get Profile Of Authenticated User
Get details about the authenticated user
Get A User By Its ID
Get publicly available information about a GitBook user

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.

Connector Profile

GitBook - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.

Link Account

GitBook - API Key
4

Use Actions

Invoke actions using one of the methods below: