GitBook

GitBook Integrations API

Install and manage third-party integrations.

GitHub OpenAPI

Operations 35

POST /integrations/{integrationName}/installations/{installationId}/spaces Install an integration on a space #
GET /integrations/{integrationName}/installations/{installationId}/spaces List all space integration installations #
GET /integrations List all public integrations #
GET /integrations/{integrationName} Get an integration by its name #
POST /integrations/{integrationName} Publish an integration #
DELETE /integrations/{integrationName} Unpublish an integration #
GET /integrations/{integrationName}/installations List all integration installations #
POST /integrations/{integrationName}/installations Install an integration #
GET /integrations/{integrationName}/events List all integration events #
GET /integrations/{integrationName}/events/{eventId} Get an integration event by its ID #
GET /integrations/{integrationName}/spaces List all integration space installations #
GET /integrations/{integrationName}/sites List all integration site installations #
PUT /integrations/{integrationName}/dev Enable integration dev mode #
DELETE /integrations/{integrationName}/dev Disable integration dev mode #
GET /integrations/{integrationName}/render Render an integration UI with GET method #
POST /integrations/{integrationName}/render Render an integration UI with POST method #
POST /integrations/{integrationName}/tasks Queue an integration task #
GET /integrations/{integrationName}/installations/{installationId} Get an integration installation by its ID #
PATCH /integrations/{integrationName}/installations/{installationId} Update an integration installation #
DELETE /integrations/{integrationName}/installations/{installationId} Uninstall an integration #
POST /integrations/{integrationName}/installations/{installationId}/tokens Create an integration installation API token #
GET /integrations/{integrationName}/installations/{installationId}/spaces/{spaceId} Get an integration space installation #
PATCH /integrations/{integrationName}/installations/{installationId}/spaces/{spaceId} Update an integration space installation #
DELETE /integrations/{integrationName}/installations/{installationId}/spaces/{spaceId} Uninstall an integration from a space #
GET /integrations/{integrationName}/installations/{installationId}/sites List all site integration installations #
POST /integrations/{integrationName}/installations/{installationId}/sites Install an integration on a site #
GET /integrations/{integrationName}/installations/{installationId}/sites/{siteId} Get an integration site installation #
PATCH /integrations/{integrationName}/installations/{installationId}/sites/{siteId} Update an integration site installation #
DELETE /integrations/{integrationName}/installations/{installationId}/sites/{siteId} Uninstall an integration from a site #
GET /orgs/{organizationId}/integrations List all public integrations along with private ones trusted by the specific org #
GET /orgs/{organizationId}/integrations/{integrationName}/installation_status Get the status of an integration #
GET /orgs/{organizationId}/installations List all integration installations #
GET /orgs/{organizationId}/integrations/installations-status List all integration statuses #
GET /orgs/{organizationId}/sites/{siteId}/integration-scripts List custom scripts injected into a site's published pages #
GET /orgs/{organizationId}/sites/{siteId}/integrations List third-party integrations enabled on a site #

Documentation

📖
Documentation
https://docs.gitbook.com/developers

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-integrations-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/asyncapi/gitbook-gitbook-api-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/organization.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/space.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/page.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/user.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/change-request.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/docs-site.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/collection.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-ld/gitbook-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitbook:gitbook-integrations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitbook-integrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitBook Integrations API
  description: The GitBook API
  termsOfService: https://policies.gitbook.com
  contact:
    name: API Support
    url: https://gitbook.com/support
    email: support@gitbook.com
  version: 0.0.1-beta
servers:
- url: '{host}/v1'
  variables:
    host:
      default: https://api.gitbook.com
security:
- user: []
- user-internal: []
- user-staff: []
- integration: []
- integration-installation: []
tags:


# --- truncated at 32 KB (171 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-integrations-api-openapi.yml