For the complete documentation index, see llms.txt. This page is also available as Markdown.

Space integrations

Connect external tools and plugins to enhance your space functionality.

This API handles the registration and removal of integrations, automating how data flows between GitBook and your chosen external services.

List all third-party integrations enabled on a space

get

Returns a paginated list of integrations that are currently installed and enabled on the space. Use the query parameter to filter by integration name. Use this to check which integrations are active before interacting with integration-specific features or blocks.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

A unique entity identifier

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

Query parameters

searchstringOptional

A search string to filter integrations by name

Responses

200

Listing of integrations enabled in the space.

application/json

get/spaces/{spaceId}/integrations

200

Listing of integrations enabled in the space.

List all custom content blocks provided by integrations in a space

get

Returns all custom block types contributed by integrations installed on the space. Integration blocks are custom content elements (e.g. embedded widgets, code runners) that integrations register for use in pages. Use this to discover what custom block types are available in a given space.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

A unique entity identifier

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

Responses

200

list of installed integration blocks

application/json

404

Not Found

application/json

get/spaces/{spaceId}/integration-blocks

Last updated 19 hours ago

Was this helpful?

{ "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": [ "space:content: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", "completion_url": "text", "enum": [ "text" ] } }, "required": [ "text" ] }, "space": { "properties": { "ANY_ADDITIONAL_PROPERTY": { "title": "text", "description": "text", "type": "string", "default": "text", "completion_url": "text", "enum": [ "text" ] } }, "required": [ "text" ] }, "site": { "properties": { "ANY_ADDITIONAL_PROPERTY": { "title": "text", "description": "text", "type": "string", "default": "text", "completion_url": "text", "enum": [ "text" ] } }, "required": [ "text" ] } }, "externalLinks": [ { "url": "https://example.com", "label": "text" } ], "owner": { "object": "organization", "id": "text", "title": "text", "createdAt": "2026年07月03日T09:13:28.721Z", "emailDomains": [ "text" ], "hostname": "text", "type": "business", "useCase": "internalDocs", "communityType": "nonProfit", "defaultRole": "admin", "defaultContent": { "type": "site", "site": "text" }, "sso": true, "ai": true, "inviteLinks": true, "plan": "free_2024", "billing": { "interval": "monthly", "endDate": "2026年07月03日T09:13:28.721Z", "hasPaymentFailed": true, "canCheckout": true, "isScheduledToCancel": true, "pricing": { "members": { "plus_2024": { "monthly": 1, "yearly": 1 }, "pro_2024": { "monthly": 1, "yearly": 1 } }, "sites": { "premium": { "monthly": 1, "yearly": 1 }, "ultimate": { "monthly": 1, "yearly": 1 } } }, "usageAddons": { "ANY_ADDITIONAL_PROPERTY": { "enabled": true } }, "minUsers": 1, "maxUsers": 1, "minPremiumSites": 1, "maxPremiumSites": 1, "minUltimateSites": 1, "maxUltimateSites": 1, "paidMembers": 1, "paidPremiumSites": 1, "paidUltimateSites": 1, "canChangeInterval": true, "canUseSAML": true }, "mergeRules": { "type": "rules", "rules": [ { "rule": "require_specific_reviewers", "users": [ "text" ] } ] }, "urls": { "location": "https://example.com", "app": "https://example.com", "logo": "https://example.com" }, "trial": { "status": "notapplicable", "count": 1, "endDate": "2026年07月03日T09:13:28.721Z", "decision": "downgrade" }, "customHostname": "text", "blocked": { "source": "backoffice", "reason": "text" }, "internal_billingMigration": { "deadline": "2026年07月03日T09:13:28.721Z", "discountPercent": 1, "discountEndDate": "2026年07月03日T09:13:28.721Z" }, "permissions": { "view": true, "access": true, "admin": true, "ownTeam": true, "createContent": true, "createOpenAPISpec": true, "viewBilling": true, "listMembers": true, "listTeams": true, "listIntegrations": true, "listInstallations": true, "installIntegration": true } }, "urls": { "location": "https://example.com", "icon": "https://example.com", "app": "https://example.com", "assets": "https://example.com", "publicEndpoint": "https://example.com", "publicContentEndpoint": "https://example.com" }, "permissions": { "admin": true }, "contentSecurityPolicy": "text" } ] }