Integrations

Manage third-party integrations to extend GitBook features.

Was this helpful?

List integrations blocks for a space

get

/spaces/{spaceId}/integration-blocks

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/integration-blocks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

[
  {
    "name": "text",
    "blocks": [
      {
        "id": "text",
        "title": "text",
        "description": "text",
        "icon": "text",
        "markdown": {
          "codeblock": "text",
          "body": "text"
        },
        "urlUnfurl": [
          "text"
        ]
      }
    ]
  }
]

list of installed integration blocks

Get a specific integration by its name

get

/integrations/{integrationName}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

{
  "name": "text",
  "version": 1,
  "title": "text",
  "description": "text",
  "summary": "text",
  "target": "all",
  "verified": true,
  "visibility": "public",
  "scopes": [
    "space:views:read"
  ],
  "categories": [
    "analytics"
  ],
  "blocks": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "markdown": {
        "codeblock": "text",
        "body": "text"
      },
      "urlUnfurl": [
        "text"
      ]
    }
  ],
  "configurations": {
    "account": {
      "required": [
        "text"
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "default": "text",
          "type": "string"
        }
      }
    },
    "space": {
      "required": [
        "text"
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "default": "text",
          "type": "string"
        }
      }
    },
    "site": {
      "required": [
        "text"
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "default": "text",
          "type": "string"
        }
      }
    }
  },
  "externalLinks": [
    {
      "url": "https://example.com",
      "label": "text"
    }
  ],
  "owner": {
    "id": "text",
    "title": "text",
    "createdAt": "2025-03-09T02:41:11.751Z",
    "emailDomains": [
      "text"
    ],
    "hostname": "text",
    "type": "business",
    "useCase": "internalDocs",
    "communityType": "nonProfit",
    "defaultRole": "admin",
    "defaultContent": {
      "site": "text",
      "type": "site"
    },
    "sso": true,
    "ai": true,
    "inviteLinks": true,
    "plan": "free_2024",
    "customHostname": "text",
    "internal_isOnNewTrial": true,
    "object": "organization",
    "urls": {
      "location": "https://example.com",
      "app": "https://example.com",
      "logo": "https://example.com"
    },
    "blocked": {
      "reason": "security"
    },
    "internal_billingMigration": {
      "deadline": "2025-03-09T02:41:11.751Z",
      "discountPercent": 1,
      "discountEndDate": "2025-03-09T02:41:11.751Z"
    },
    "permissions": {
      "admin": true,
      "createContent": true
    },
    "trial": {
      "status": "notapplicable",
      "endDate": "2025-03-09T02:41:11.751Z",
      "decision": "downgrade"
    }
  },
  "contentSecurityPolicy": "text",
  "object": "integration",
  "previewImages": [
    "text"
  ],
  "contentSources": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "configuration": {
        "componentId": "text"
      }
    }
  ],
  "urls": {
    "location": "https://example.com",
    "icon": "https://example.com",
    "app": "https://example.com",
    "assets": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "permissions": {
    "admin": true
  }
}

Integration

Publish an integration

post

/integrations/{integrationName}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Body

iconstring · byte

Base64 content of the icon

titlestring · min: 2 · max: 30required

Title of the integration

descriptionstring · max: 100required

Description of the integration

summarystring · max: 2048

Long form markdown summary of the integration

visibilitystring · enum

Options: public, private, unlisted

targetstring · enum

Allowed installation target for the integration. If not specified, the integration can be installed at all targets (org, spaces etc)

Options: all, site, space, organization

scopesstring · enum[]required

Permissions that should be granted to the integration

categoriesstring · enum[]

Categories for which the integration is listed in the marketplace

blocksobject[]

Custom blocks defined by this integration.

externalLinksobject[]

External urls configured by the developer of the integration

configurationsobject

scriptstringrequired

Content of the script to use

organizationstringrequired

The ID or subdomain of the organization under which the integration should be published

secretsobject

Secrets stored on the integration and passed at runtime.

contentSecurityPolicyone of

Security policy to validate the content of the integrations scripts and Contentkit. Will be sent as headers when processing the script fetch event and the blocks fetch events.

previewImagesstring · byte[]

Base64 content of the image

contentSourcesobject[]

Definition of a content source provided by the integration.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "icon": "text",
    "title": "text",
    "description": "text",
    "summary": "text",
    "visibility": "public",
    "target": "all",
    "scopes": [
      "space:views:read"
    ],
    "categories": [
      "analytics"
    ],
    "blocks": [
      {
        "id": "text",
        "title": "text",
        "description": "text",
        "icon": "text",
        "markdown": {
          "codeblock": "text",
          "body": "text"
        },
        "urlUnfurl": [
          "text"
        ]
      }
    ],
    "externalLinks": [
      {
        "url": "https://example.com",
        "label": "text"
      }
    ],
    "configurations": {
      "account": {
        "required": [
          "text"
        ],
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "default": "text",
            "type": "string"
          }
        }
      },
      "space": {
        "required": [
          "text"
        ],
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "default": "text",
            "type": "string"
          }
        }
      },
      "site": {
        "required": [
          "text"
        ],
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "title": "text",
            "description": "text",
            "default": "text",
            "type": "string"
          }
        }
      }
    },
    "script": "text",
    "organization": "text",
    "secrets": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "contentSecurityPolicy": "text",
    "previewImages": [
      "text"
    ],
    "contentSources": [
      {
        "id": "text",
        "title": "text",
        "description": "text",
        "icon": "text",
        "configuration": {
          "componentId": "text"
        }
      }
    ]
  }'

200

404

default

{
  "name": "text",
  "version": 1,
  "title": "text",
  "description": "text",
  "summary": "text",
  "target": "all",
  "verified": true,
  "visibility": "public",
  "scopes": [
    "space:views:read"
  ],
  "categories": [
    "analytics"
  ],
  "blocks": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "markdown": {
        "codeblock": "text",
        "body": "text"
      },
      "urlUnfurl": [
        "text"
      ]
    }
  ],
  "configurations": {
    "account": {
      "required": [
        "text"
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "default": "text",
          "type": "string"
        }
      }
    },
    "space": {
      "required": [
        "text"
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "default": "text",
          "type": "string"
        }
      }
    },
    "site": {
      "required": [
        "text"
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {
          "title": "text",
          "description": "text",
          "default": "text",
          "type": "string"
        }
      }
    }
  },
  "externalLinks": [
    {
      "url": "https://example.com",
      "label": "text"
    }
  ],
  "owner": {
    "id": "text",
    "title": "text",
    "createdAt": "2025-03-09T02:41:11.751Z",
    "emailDomains": [
      "text"
    ],
    "hostname": "text",
    "type": "business",
    "useCase": "internalDocs",
    "communityType": "nonProfit",
    "defaultRole": "admin",
    "defaultContent": {
      "site": "text",
      "type": "site"
    },
    "sso": true,
    "ai": true,
    "inviteLinks": true,
    "plan": "free_2024",
    "customHostname": "text",
    "internal_isOnNewTrial": true,
    "object": "organization",
    "urls": {
      "location": "https://example.com",
      "app": "https://example.com",
      "logo": "https://example.com"
    },
    "blocked": {
      "reason": "security"
    },
    "internal_billingMigration": {
      "deadline": "2025-03-09T02:41:11.751Z",
      "discountPercent": 1,
      "discountEndDate": "2025-03-09T02:41:11.751Z"
    },
    "permissions": {
      "admin": true,
      "createContent": true
    },
    "trial": {
      "status": "notapplicable",
      "endDate": "2025-03-09T02:41:11.751Z",
      "decision": "downgrade"
    }
  },
  "contentSecurityPolicy": "text",
  "object": "integration",
  "previewImages": [
    "text"
  ],
  "contentSources": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "configuration": {
        "componentId": "text"
      }
    }
  ],
  "urls": {
    "location": "https://example.com",
    "icon": "https://example.com",
    "app": "https://example.com",
    "assets": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "permissions": {
    "admin": true
  }
}

Unpublish an integration

delete

/integrations/{integrationName}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

default

No body

Integration has been deleted

Render an integration UI in the context of an installation.

get

/integrations/{integrationName}/render

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Query parameters

requeststringrequired

LZ-string compressed JSON request

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/render?request=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "element": "[Circular Reference]",
  "state": {},
  "props": {
    "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
  },
  "type": "element"
}

ContentKit element to render

Render an integration UI in the context of an installation.

post

/integrations/{integrationName}/render

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Body

componentIdstringrequired

ID of the component to render in the integration.

propsobjectrequired

Current properties of the UI.

stateobject

Current local state of the UI.

contextone ofrequired

Object representing the context in which a ContentKit component is rendered.

actionany of

Custom action to re-render the block.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/render' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "componentId": "text",
    "props": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    },
    "state": {},
    "context": {
      "theme": "dark",
      "organizationId": "text",
      "type": "configuration_account"
    },
    "action": {
      "action": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }'

200

default

{
  "element": "[Circular Reference]",
  "state": {},
  "props": {
    "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
  },
  "type": "element"
}

ContentKit element to render

Get a specific integration's installation by its ID

get

/integrations/{integrationName}/installations/{installationId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

{
  "id": "text",
  "status": "active",
  "space_selection": "all",
  "site_selection": "all",
  "spaces": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-03-09T02:41:11.751Z",
  "updatedAt": "2025-03-09T02:41:11.751Z",
  "externalIds": [
    "text"
  ],
  "target": {
    "organization": "text"
  },
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "publicEndpoint": "https://example.com"
  }
}

Integration installation

Uninstall the integration from a target organization

delete

/integrations/{integrationName}/installations/{installationId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

404

default

No body

Integration uninstalled successfully

Update external IDs and configurations of an integration's installation

patch

/integrations/{integrationName}/installations/{installationId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

Body

externalIdsstring[]

External IDs assigned by the integration.

configurationobject

Configuration of the integration at the account level

space_selectionstring · enum

Describe whether all spaces have been selected or there's a selection involved

Options: all, selected

site_selectionstring · enum

Describe whether all sites have been selected or there's a selection involved

Options: all, selected

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalIds": [
      "text"
    ],
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "space_selection": "all",
    "site_selection": "all"
  }'

200

default

{
  "id": "text",
  "status": "active",
  "space_selection": "all",
  "site_selection": "all",
  "spaces": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-03-09T02:41:11.751Z",
  "updatedAt": "2025-03-09T02:41:11.751Z",
  "externalIds": [
    "text"
  ],
  "target": {
    "organization": "text"
  },
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "publicEndpoint": "https://example.com"
  }
}

The installation has been updated.

Get a specific integration's space installation

get

/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

spaceIdstringrequired

The unique id of the space

Query parameters

extendedboolean · default: false

If true, returns the space object in each items. If false, returns the space ID in each items.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "space": "text"
}

Integration space installation

Uninstall the integration from a space

delete

/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

spaceIdstringrequired

The unique id of the space

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

default

No body

The space installation has been deleted.

Update external IDs and configurations of an integration's installation for a space

patch

/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

spaceIdstringrequired

The unique id of the space

Query parameters

extendedboolean · default: false

If true, returns the space object in each items. If false, returns the space ID in each items.

Body

externalIdsstring[]

External IDs assigned by the integration.

configurationobject

Configuration of the integration at the account level

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalIds": [
      "text"
    ],
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }'

200

default

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "space": "text"
}

The space installation has been updated.

Get a specific integration's site installation

get

/integrations/{integrationName}/installations/{installationId}/sites/{siteId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

siteIdstringrequired

The unique id of the site

Query parameters

extendedboolean · default: false

If true, returns the site object in each items. If false, returns the site ID in each items.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "site": "text"
}

Integration site installation

Uninstall the integration from a site

delete

/integrations/{integrationName}/installations/{installationId}/sites/{siteId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

siteIdstringrequired

The unique id of the site

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

default

No body

The site installation has been deleted.

Update external IDs and configurations of an integration's installation for a site

patch

/integrations/{integrationName}/installations/{installationId}/sites/{siteId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

siteIdstringrequired

The unique id of the site

Query parameters

extendedboolean · default: false

If true, returns the site object in each items. If false, returns the site ID in each items.

Body

externalIdsstring[]

External IDs assigned by the integration.

configurationobject

Configuration of the integration at the account level

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalIds": [
      "text"
    ],
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }'

200

default

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "site": "text"
}

The site installation has been updated.

Update an integration to be in development mode.

put

/integrations/{integrationName}/dev

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Body

tunnelUrlstring · min: 1 · max: 256required

URL of the tunnel to dispatch integration events to

allboolean · default: false

If set to true, all requests will be forwarded to the tunnel, not just from the owning organization.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/dev' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "tunnelUrl": "text",
    "all": false
  }'

204

404

default

No body

Updated development mode successfully

Disable the development mode on an integration.

delete

/integrations/{integrationName}/dev

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/dev' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

205

default

No body

Disabled development mode successfully

Queue a task for an integration to be executed later

post

/integrations/{integrationName}/tasks

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Body

taskobjectrequired

Payload for the integration task

schedulenumber · max: 86400

Number of seconds to wait before executing the task, defaults to 0

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/tasks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "task": {},
    "schedule": 1
  }'

204

404

default

No body

Integration task created successfully

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

get

/orgs/{organizationId}/sites/{siteId}/integration-scripts

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

siteIdstringrequired

The unique id of the site

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/sites/{siteId}/integration-scripts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

default

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

Get a specific integration event by its id

get

/integrations/{integrationName}/events/{eventId}

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

eventIdstringrequired

ID of the integration event

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/events/{eventId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

{
  "event": {
    "id": "text",
    "integrationId": "text",
    "installationId": "text",
    "createdAt": "2025-03-09T02:41:11.751Z",
    "payload": {
      "eventId": "text",
      "type": "installation_setup",
      "installationId": "text",
      "status": "active",
      "previous": {
        "status": "active",
        "configuration": {}
      }
    },
    "status": "success"
  },
  "trace": {
    "logs": [
      {
        "message": "text",
        "timestamp": "2025-03-09T02:41:11.751Z",
        "level": "debug"
      }
    ]
  }
}

Integration event

Get the status of an integration installation in an organization

get

/orgs/{organizationId}/integrations/{integrationName}/installation_status

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

integrationNamestring · max: 100required

Name of the integration.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/integrations/{integrationName}/installation_status' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

{
  "status": "active"
}

Integration installation status

List integrations enabled in a space.

get

/spaces/{spaceId}/integrations

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

searchstring

A search string to filter integrations by name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/integrations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "space:views:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "markdown": {
            "codeblock": "text",
            "body": "text"
          },
          "urlUnfurl": [
            "text"
          ]
        }
      ],
      "configurations": {
        "account": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        },
        "space": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        },
        "site": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "id": "text",
        "title": "text",
        "createdAt": "2025-03-09T02:41:11.751Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "site": "text",
          "type": "site"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "customHostname": "text",
        "internal_isOnNewTrial": true,
        "object": "organization",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "blocked": {
          "reason": "security"
        },
        "internal_billingMigration": {
          "deadline": "2025-03-09T02:41:11.751Z",
          "discountPercent": 1,
          "discountEndDate": "2025-03-09T02:41:11.751Z"
        },
        "permissions": {
          "admin": true,
          "createContent": true
        },
        "trial": {
          "status": "notapplicable",
          "endDate": "2025-03-09T02:41:11.751Z",
          "decision": "downgrade"
        }
      },
      "contentSecurityPolicy": "text",
      "object": "integration",
      "previewImages": [
        "text"
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      }
    }
  ]
}

Listing of integrations enabled in the space.

List all public integrations

get

/integrations

Authorizations

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

searchstring

A search string to filter integrations by name

categorystring · enum

Filter the integrations by category

Options: analytics, collaboration, content, gitsync, marketing, visitor-auth, other

blockDomainstring · max: 100

Filter the integrations by block's domains

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

blocksboolean

If true, returns only integrations with blocks. If false, returns only integrations without blocks.

contentSourcesboolean

If true, returns only integrations with contentSources. If false, returns only integrations without contentSources.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "space:views:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "markdown": {
            "codeblock": "text",
            "body": "text"
          },
          "urlUnfurl": [
            "text"
          ]
        }
      ],
      "configurations": {
        "account": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        },
        "space": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        },
        "site": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "id": "text",
        "title": "text",
        "createdAt": "2025-03-09T02:41:11.751Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "site": "text",
          "type": "site"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "customHostname": "text",
        "internal_isOnNewTrial": true,
        "object": "organization",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "blocked": {
          "reason": "security"
        },
        "internal_billingMigration": {
          "deadline": "2025-03-09T02:41:11.751Z",
          "discountPercent": 1,
          "discountEndDate": "2025-03-09T02:41:11.751Z"
        },
        "permissions": {
          "admin": true,
          "createContent": true
        },
        "trial": {
          "status": "notapplicable",
          "endDate": "2025-03-09T02:41:11.751Z",
          "decision": "downgrade"
        }
      },
      "contentSecurityPolicy": "text",
      "object": "integration",
      "previewImages": [
        "text"
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      }
    }
  ]
}

Paginated list of integrations

Fetch a list of installations of an integration

get

/integrations/{integrationName}/installations

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

externalIdstring

External Id to filter by

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "id": "text",
      "status": "active",
      "space_selection": "all",
      "site_selection": "all",
      "spaces": 1,
      "configuration": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdAt": "2025-03-09T02:41:11.751Z",
      "updatedAt": "2025-03-09T02:41:11.751Z",
      "externalIds": [
        "text"
      ],
      "target": {
        "organization": "text"
      },
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com",
        "publicEndpoint": "https://example.com"
      }
    }
  ]
}

Install integration on a target organization

post

/integrations/{integrationName}/installations

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Body

organizationstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "organization": "text"
  }'

201

404

default

{
  "id": "text",
  "status": "active",
  "space_selection": "all",
  "site_selection": "all",
  "spaces": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-03-09T02:41:11.751Z",
  "updatedAt": "2025-03-09T02:41:11.751Z",
  "externalIds": [
    "text"
  ],
  "target": {
    "organization": "text"
  },
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "publicEndpoint": "https://example.com"
  }
}

Integration installed successfully

List all integration events

get

/integrations/{integrationName}/events

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/events' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    "[Circular Reference]"
  ]
}

Paginated list of integration events

Fetch a list of space installations of an integration

get

/integrations/{integrationName}/spaces

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

externalIdstring

External Id to filter by

extendedboolean · default: false

If true, returns the space object in each items. If false, returns the space ID in each items.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/spaces' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "integration": "text",
      "installation": "text",
      "status": "active",
      "configuration": {},
      "externalIds": [
        "text"
      ],
      "urls": {
        "location": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "space": "text"
    }
  ]
}

List installations on spaces for an integration in an organization

get

/integrations/{integrationName}/installations/{installationId}/spaces

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

extendedboolean · default: false

If true, returns the space object in each items. If false, returns the space ID in each items.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/spaces' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "integration": "text",
      "installation": "text",
      "status": "active",
      "configuration": {},
      "externalIds": [
        "text"
      ],
      "urls": {
        "location": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "space": "text"
    }
  ]
}

Install integration on a space using an existing installation

post

/integrations/{integrationName}/installations/{installationId}/spaces

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

Query parameters

extendedboolean · default: false

If true, returns the space object in each items. If false, returns the space ID in each items.

Body

spacestringrequired

ID of the space to install the integration on

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/spaces' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "space": "text"
  }'

201

404

default

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "space": "text"
}

Integration installed successfully on space

List installations on sites for an integration in an organization

get

/integrations/{integrationName}/installations/{installationId}/sites

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

extendedboolean · default: false

If true, returns the site object in each items. If false, returns the site ID in each items.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/sites' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "integration": "text",
      "installation": "text",
      "status": "active",
      "configuration": {},
      "externalIds": [
        "text"
      ],
      "urls": {
        "location": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "site": "text"
    }
  ]
}

Install integration on a site using an existing installation

post

/integrations/{integrationName}/installations/{installationId}/sites

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

Query parameters

extendedboolean · default: false

If true, returns the site object in each items. If false, returns the site ID in each items.

Body

siteIdstringrequired

ID of the site to install the integration on

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/sites' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "siteId": "text"
  }'

201

404

default

{
  "integration": "text",
  "installation": "text",
  "status": "active",
  "configuration": {},
  "externalIds": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "site": "text"
}

Integration installed successfully on site

List integrations enabled in a site.

get

/orgs/{organizationId}/sites/{siteId}/integrations

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

siteIdstringrequired

The unique id of the site

Query parameters

searchstring

A search string to filter integrations by name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/sites/{siteId}/integrations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "name": "text",
      "version": 1,
      "title": "text",
      "description": "text",
      "summary": "text",
      "target": "all",
      "verified": true,
      "visibility": "public",
      "scopes": [
        "space:views:read"
      ],
      "categories": [
        "analytics"
      ],
      "blocks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "markdown": {
            "codeblock": "text",
            "body": "text"
          },
          "urlUnfurl": [
            "text"
          ]
        }
      ],
      "configurations": {
        "account": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        },
        "space": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        },
        "site": {
          "required": [
            "text"
          ],
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "title": "text",
              "description": "text",
              "default": "text",
              "type": "string"
            }
          }
        }
      },
      "externalLinks": [
        {
          "url": "https://example.com",
          "label": "text"
        }
      ],
      "owner": {
        "id": "text",
        "title": "text",
        "createdAt": "2025-03-09T02:41:11.751Z",
        "emailDomains": [
          "text"
        ],
        "hostname": "text",
        "type": "business",
        "useCase": "internalDocs",
        "communityType": "nonProfit",
        "defaultRole": "admin",
        "defaultContent": {
          "site": "text",
          "type": "site"
        },
        "sso": true,
        "ai": true,
        "inviteLinks": true,
        "plan": "free_2024",
        "customHostname": "text",
        "internal_isOnNewTrial": true,
        "object": "organization",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "blocked": {
          "reason": "security"
        },
        "internal_billingMigration": {
          "deadline": "2025-03-09T02:41:11.751Z",
          "discountPercent": 1,
          "discountEndDate": "2025-03-09T02:41:11.751Z"
        },
        "permissions": {
          "admin": true,
          "createContent": true
        },
        "trial": {
          "status": "notapplicable",
          "endDate": "2025-03-09T02:41:11.751Z",
          "decision": "downgrade"
        }
      },
      "contentSecurityPolicy": "text",
      "object": "integration",
      "previewImages": [
        "text"
      ],
      "contentSources": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "configuration": {
            "componentId": "text"
          }
        }
      ],
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true
      }
    }
  ]
}

Listing of integrations enabled in the site.

List the statuses of all integrations installed in an organization

get

/orgs/{organizationId}/integrations/installations-status

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

searchstring

A search string to filter integrations by name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/integrations/installations-status' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "status": "active",
      "integration": {
        "name": "text",
        "version": 1,
        "title": "text",
        "description": "text",
        "summary": "text",
        "target": "all",
        "verified": true,
        "visibility": "public",
        "scopes": [
          "space:views:read"
        ],
        "categories": [
          "analytics"
        ],
        "blocks": [
          {
            "id": "text",
            "title": "text",
            "description": "text",
            "icon": "text",
            "markdown": {
              "codeblock": "text",
              "body": "text"
            },
            "urlUnfurl": [
              "text"
            ]
          }
        ],
        "configurations": {
          "account": {
            "required": [
              "text"
            ],
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "default": "text",
                "type": "string"
              }
            }
          },
          "space": {
            "required": [
              "text"
            ],
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "default": "text",
                "type": "string"
              }
            }
          },
          "site": {
            "required": [
              "text"
            ],
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "title": "text",
                "description": "text",
                "default": "text",
                "type": "string"
              }
            }
          }
        },
        "externalLinks": [
          {
            "url": "https://example.com",
            "label": "text"
          }
        ],
        "owner": {
          "id": "text",
          "title": "text",
          "createdAt": "2025-03-09T02:41:11.751Z",
          "emailDomains": [
            "text"
          ],
          "hostname": "text",
          "type": "business",
          "useCase": "internalDocs",
          "communityType": "nonProfit",
          "defaultRole": "admin",
          "defaultContent": {
            "site": "text",
            "type": "site"
          },
          "sso": true,
          "ai": true,
          "inviteLinks": true,
          "plan": "free_2024",
          "customHostname": "text",
          "internal_isOnNewTrial": true,
          "object": "organization",
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "blocked": {
            "reason": "security"
          },
          "internal_billingMigration": {
            "deadline": "2025-03-09T02:41:11.751Z",
            "discountPercent": 1,
            "discountEndDate": "2025-03-09T02:41:11.751Z"
          },
          "permissions": {
            "admin": true,
            "createContent": true
          },
          "trial": {
            "status": "notapplicable",
            "endDate": "2025-03-09T02:41:11.751Z",
            "decision": "downgrade"
          }
        },
        "contentSecurityPolicy": "text",
        "object": "integration",
        "previewImages": [
          "text"
        ],
        "contentSources": [
          {
            "id": "text",
            "title": "text",
            "description": "text",
            "icon": "text",
            "configuration": {
              "componentId": "text"
            }
          }
        ],
        "urls": {
          "location": "https://example.com",
          "icon": "https://example.com",
          "app": "https://example.com",
          "assets": "https://example.com",
          "publicEndpoint": "https://example.com"
        },
        "permissions": {
          "admin": true
        }
      }
    }
  ]
}

List of integrations.

Create an integration installation API token

Creates a temporary API token of an integration's installation that has access to the installation and it's scopes. You must be authenticated as the integration to obtain this token.

post

/integrations/{integrationName}/installations/{installationId}/tokens

Authorizations

Path parameters

integrationNamestring · max: 100required

Name of the integration.

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

installationIdstringrequired

Identifier of the installation

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/integrations/{integrationName}/installations/{installationId}/tokens' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

default

{
  "token": "text"
}

The API token for the installation

List integrations blocks for a space

Get a specific integration by its name

Publish an integration

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Unpublish an integration

Render an integration UI in the context of an installation.

Render an integration UI in the context of an installation.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Get a specific integration's installation by its ID

Uninstall the integration from a target organization

Update external IDs and configurations of an integration's installation

Show child attributes

Get a specific integration's space installation

Uninstall the integration from a space

Update external IDs and configurations of an integration's installation for a space

Show child attributes

Get a specific integration's site installation

Uninstall the integration from a site

Update external IDs and configurations of an integration's installation for a site

Show child attributes

Update an integration to be in development mode.

Disable the development mode on an integration.

Queue a task for an integration to be executed later

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

Get a specific integration event by its id

Get the status of an integration installation in an organization

List integrations enabled in a space.

List all public integrations

Fetch a list of installations of an integration

Install integration on a target organization

List all integration events

Fetch a list of space installations of an integration

List installations on spaces for an integration in an organization

Install integration on a space using an existing installation

List installations on sites for an integration in an organization

Install integration on a site using an existing installation

List integrations enabled in a site.

List the statuses of all integrations installed in an organization

Create an integration installation API token