The State of Docs Report 2025 is live! Dive in and see why docs matter more than ever:
Read the report
PricingLog inSign up

Integrations

Install and handle third-party integrations for extended GitBook functionality.

Expand the capabilities of GitBook by connecting it with various external platforms—CRM, issue trackers, or CI/CD pipelines—through standardized integration endpoints.

List all public integrations

get
Authorizations
Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

searchstringOptional

A search string to filter integrations by name

categorystring · enumOptional

Filter the integrations by category

Possible values:
blockDomainstring · max: 100Optional

Filter the integrations by block's domains

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

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

contentSourcesbooleanOptional

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

ownerstringOptional

If defined, only list integrations owned by the given organization.

scopestring · enumOptional

Filter the integrations by scope

Possible values:
targetstring · enumOptional

The target on which the integration can operate and needs to be configured for

Possible values:
Responses
200
Paginated list of integrations
application/json
Responseall of
get
GET /v1/integrations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Paginated list of integrations

{
  "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:views: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": "2025-06-21T04:22:40.106Z",
        "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": "2025-06-21T04:22:40.106Z",
          "hasPaymentFailed": true,
          "isScheduledToCancel": true
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "endDate": "2025-06-21T04:22:40.106Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_billingMigration": {
          "deadline": "2025-06-21T04:22:40.106Z",
          "discountPercent": 1,
          "discountEndDate": "2025-06-21T04:22:40.106Z"
        },
        "permissions": {
          "view": true,
          "admin": true,
          "ownTeam": true,
          "createContent": true,
          "createOpenAPISpec": true,
          "ingestConversations": true,
          "viewBilling": true,
          "listMembers": true,
          "listTeams": true,
          "listIntegrations": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true,
        "install": true
      },
      "contentSecurityPolicy": "text"
    }
  ]
}

Get an integration by its name

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$
Responses
200
Integration
application/json
get
GET /v1/integrations/{integrationName} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "integration",
  "name": "text",
  "version": 1,
  "title": "text",
  "description": "text",
  "summary": "text",
  "previewImages": [
    "text"
  ],
  "target": "all",
  "verified": true,
  "visibility": "public",
  "scopes": [
    "space:views: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": "2025-06-21T04:22:40.106Z",
    "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": "2025-06-21T04:22:40.106Z",
      "hasPaymentFailed": true,
      "isScheduledToCancel": true
    },
    "urls": {
      "location": "https://example.com",
      "app": "https://example.com",
      "logo": "https://example.com"
    },
    "trial": {
      "status": "notapplicable",
      "endDate": "2025-06-21T04:22:40.106Z",
      "decision": "downgrade"
    },
    "customHostname": "text",
    "blocked": {
      "reason": "security"
    },
    "internal_billingMigration": {
      "deadline": "2025-06-21T04:22:40.106Z",
      "discountPercent": 1,
      "discountEndDate": "2025-06-21T04:22:40.106Z"
    },
    "permissions": {
      "view": true,
      "admin": true,
      "ownTeam": true,
      "createContent": true,
      "createOpenAPISpec": true,
      "ingestConversations": true,
      "viewBilling": true,
      "listMembers": true,
      "listTeams": true,
      "listIntegrations": true
    }
  },
  "urls": {
    "location": "https://example.com",
    "icon": "https://example.com",
    "app": "https://example.com",
    "assets": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "permissions": {
    "admin": true,
    "install": true
  },
  "contentSecurityPolicy": "text"
}

Publish an integration

post
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$
Body
runtimestring · enumOptional

The runtime version to use for the integration. If not specified, the integration will use the default runtime.

Default: v1Possible values:
iconstring · byteOptional

Base64 content of the icon

titlestring · min: 2 · max: 30Required

Title of the integration

descriptionstring · max: 100Required

Description of the integration

summarystring · max: 2048Optional

Long form markdown summary of the integration

previewImagesstring · byte[] · max: 3Optional

Base64 content of the image

visibilitystring · enumOptionalPossible values:
targetstring · enumOptional

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

Possible values:
scriptstringRequired

Content of the script to use

organizationstringRequired

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

contentSecurityPolicyone ofOptional

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.

stringOptional
or
Responses
200
OK
application/json
post
POST /v1/integrations/{integrationName} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1217

{
  "runtime": "v1",
  "icon": "Ynl0ZXM=",
  "title": "text",
  "description": "text",
  "summary": "text",
  "previewImages": [
    "Ynl0ZXM="
  ],
  "visibility": "public",
  "target": "all",
  "scopes": [
    "space:views: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"
      }
    }
  ],
  "externalLinks": [
    {
      "url": "https://example.com",
      "label": "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"
      ]
    }
  },
  "script": "text",
  "organization": "text",
  "secrets": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "contentSecurityPolicy": "text"
}
{
  "object": "integration",
  "name": "text",
  "version": 1,
  "title": "text",
  "description": "text",
  "summary": "text",
  "previewImages": [
    "text"
  ],
  "target": "all",
  "verified": true,
  "visibility": "public",
  "scopes": [
    "space:views: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": "2025-06-21T04:22:40.106Z",
    "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": "2025-06-21T04:22:40.106Z",
      "hasPaymentFailed": true,
      "isScheduledToCancel": true
    },
    "urls": {
      "location": "https://example.com",
      "app": "https://example.com",
      "logo": "https://example.com"
    },
    "trial": {
      "status": "notapplicable",
      "endDate": "2025-06-21T04:22:40.106Z",
      "decision": "downgrade"
    },
    "customHostname": "text",
    "blocked": {
      "reason": "security"
    },
    "internal_billingMigration": {
      "deadline": "2025-06-21T04:22:40.106Z",
      "discountPercent": 1,
      "discountEndDate": "2025-06-21T04:22:40.106Z"
    },
    "permissions": {
      "view": true,
      "admin": true,
      "ownTeam": true,
      "createContent": true,
      "createOpenAPISpec": true,
      "ingestConversations": true,
      "viewBilling": true,
      "listMembers": true,
      "listTeams": true,
      "listIntegrations": true
    }
  },
  "urls": {
    "location": "https://example.com",
    "icon": "https://example.com",
    "app": "https://example.com",
    "assets": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "permissions": {
    "admin": true,
    "install": true
  },
  "contentSecurityPolicy": "text"
}

Unpublish an integration

delete
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$
Responses
204
Integration has been deleted
delete
DELETE /v1/integrations/{integrationName} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

Integration has been deleted

No content

List all integration installations

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

externalIdstringOptional

External Id to filter by

Responses
200
OK
application/json
Responseall of
get
GET /v1/integrations/{integrationName}/installations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Install an integration

post
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$
Body
organizationstringRequired
Responses
201
Integration installed successfully
application/json
post
POST /v1/integrations/{integrationName}/installations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "organization": "text"
}
{
  "id": "text",
  "status": "active",
  "space_selection": "all",
  "site_selection": "all",
  "spaces": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-06-21T04:22:40.106Z",
  "updatedAt": "2025-06-21T04:22:40.106Z",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "externalIds": [
    "text"
  ],
  "target": {
    "organization": "text"
  }
}

List all integration events

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses
200
Paginated list of integration events
application/json
Responseall of
get
GET /v1/integrations/{integrationName}/events HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Paginated list of integration events

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "integrationId": "text",
      "installationId": "text",
      "createdAt": "2025-06-21T04:22:40.106Z",
      "payload": {
        "eventId": "text",
        "type": "installation_setup",
        "installationId": "text",
        "status": "active",
        "previous": {
          "status": "active",
          "configuration": {}
        }
      },
      "status": "success"
    }
  ]
}

Get an integration event by its ID

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

ID of the integration event

Responses
200
Integration event
application/json
get
GET /v1/integrations/{integrationName}/events/{eventId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "event": {
    "id": "text",
    "integrationId": "text",
    "installationId": "text",
    "createdAt": "2025-06-21T04:22:40.106Z",
    "payload": {
      "eventId": "text",
      "type": "installation_setup",
      "installationId": "text",
      "status": "active",
      "previous": {
        "status": "active",
        "configuration": {}
      }
    },
    "status": "success"
  },
  "trace": {
    "logs": [
      {
        "message": "text",
        "timestamp": "2025-06-21T04:22:40.106Z",
        "level": "debug"
      }
    ]
  }
}

List all integration space installations

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

externalIdstringOptional

External Id to filter by

extendedbooleanOptional

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

Default: false
Responses
200
OK
application/json
Responseall of
get
GET /v1/integrations/{integrationName}/spaces HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

List all integration site installations

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

externalIdstringOptional

External ID to filter by

extendedbooleanOptional

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

Default: false
Responses
200
OK
application/json
Responseall of
get
GET /v1/integrations/{integrationName}/sites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Enable integration dev mode

put
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

allbooleanOptional

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

Default: false
Responses
204
Updated development mode successfully
put
PUT /v1/integrations/{integrationName}/dev HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "tunnelUrl": "text",
  "all": false
}
No content

Disable integration dev mode

delete
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$
Responses
205
Disabled development mode successfully
delete
DELETE /v1/integrations/{integrationName}/dev HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
205

Disabled development mode successfully

No content

Render an integration UI with GET method

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

LZ-string compressed JSON request

Responses
200
ContentKit element to render
application/json
Responseone of

Output of the integration when rendering a UI.

or
get
GET /v1/integrations/{integrationName}/render HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

ContentKit element to render

{
  "type": "element",
  "element": {
    "type": "block",
    "children": [
      {
        "type": "button",
        "style": "primary",
        "onPress": "[Circular Reference]",
        "icon": "close",
        "trailingIcon": "close",
        "label": "text",
        "tooltip": "text",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        },
        "disabled": true
      }
    ],
    "controls": [
      {
        "icon": "close",
        "label": "text",
        "onPress": "[Circular Reference]",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        }
      }
    ]
  },
  "state": {},
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    }
  }
}

Render an integration UI with POST method

post
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.

stateobjectOptional

Current local state of the UI.

contextone ofRequired

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

all ofOptional
and
or
all ofOptional
and
or
all ofOptional
and
or
all ofOptional
and
or
all ofOptional
and
actionany ofOptional
or
one ofOptional
or
or
or
or
Responses
200
ContentKit element to render
application/json
Responseone of

Output of the integration when rendering a UI.

or
post
POST /v1/integrations/{integrationName}/render HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "componentId": "text",
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
      }
    }
  },
  "state": {},
  "context": {
    "theme": "dark",
    "type": "configuration_account",
    "organizationId": "text"
  },
  "action": {
    "action": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200

ContentKit element to render

{
  "type": "element",
  "element": {
    "type": "block",
    "children": [
      {
        "type": "button",
        "style": "primary",
        "onPress": "[Circular Reference]",
        "icon": "close",
        "trailingIcon": "close",
        "label": "text",
        "tooltip": "text",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        },
        "disabled": true
      }
    ],
    "controls": [
      {
        "icon": "close",
        "label": "text",
        "onPress": "[Circular Reference]",
        "confirm": {
          "title": "text",
          "text": "text",
          "confirm": "text",
          "style": "primary"
        }
      }
    ]
  },
  "state": {},
  "props": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
    }
  }
}

Queue an integration task

post
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Payload for the integration task

schedulenumber · max: 86400Optional

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

Responses
204
Integration task created successfully
post
POST /v1/integrations/{integrationName}/tasks HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "task": {},
  "schedule": 1
}
No content

Get an integration installation by its ID

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the installation

Responses
200
Integration installation
application/json
get
GET /v1/integrations/{integrationName}/installations/{installationId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "status": "active",
  "space_selection": "all",
  "site_selection": "all",
  "spaces": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-06-21T04:22:40.106Z",
  "updatedAt": "2025-06-21T04:22:40.106Z",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "externalIds": [
    "text"
  ],
  "target": {
    "organization": "text"
  }
}

Uninstall an integration

delete
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the installation

Responses
204
Integration uninstalled successfully
delete
DELETE /v1/integrations/{integrationName}/installations/{installationId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update an integration installation

patch
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the installation

Body
externalIdsstring[] · max: 5Optional

External IDs assigned by the integration.

space_selectionstring · enumOptional

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

Possible values:
site_selectionstring · enumOptional

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

Possible values:
Responses
200
The installation has been updated.
application/json
patch
PATCH /v1/integrations/{integrationName}/installations/{installationId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "externalIds": [
    "text"
  ],
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "space_selection": "all",
  "site_selection": "all"
}
200

The installation has been updated.

{
  "id": "text",
  "status": "active",
  "space_selection": "all",
  "site_selection": "all",
  "spaces": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-06-21T04:22:40.106Z",
  "updatedAt": "2025-06-21T04:22:40.106Z",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "publicEndpoint": "https://example.com"
  },
  "externalIds": [
    "text"
  ],
  "target": {
    "organization": "text"
  }
}

Create an integration installation API token

post

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.

Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the installation

Responses
200
The API token for the installation
application/json
post
POST /v1/integrations/{integrationName}/installations/{installationId}/tokens HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "text"
}

List all space integration installations

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the installation

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

extendedbooleanOptional

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

Default: false
Responses
200
OK
application/json
Responseall of
get
GET /v1/integrations/{integrationName}/installations/{installationId}/spaces HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Get an integration space installation

get
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
extendedbooleanOptional

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

Default: false
Responses
200
Integration space installation
application/json
Responseall of
get
GET /v1/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Uninstall an integration from a space

delete
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
204
The space installation has been deleted.
delete
DELETE /v1/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

The space installation has been deleted.

No content

Update an integration space installation

patch
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
extendedbooleanOptional

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

Default: false
Body
externalIdsstring[] · max: 5Optional

External IDs assigned by the integration.

Responses
200
The space installation has been updated.
application/json
Responseall of
patch
PATCH /v1/integrations/{integrationName}/installations/{installationId}/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "externalIds": [
    "text"
  ],
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200

The space installation has been updated.

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

List all site integration installations

get
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the installation

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

extendedbooleanOptional

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

Default: false
Responses
200
OK
application/json
Responseall of
get
GET /v1/integrations/{integrationName}/installations/{installationId}/sites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

Install an integration on a site

post
Authorizations
Path parameters
integrationNamestring · max: 100Required

Name of the integration.

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

Identifier of the installation

Query parameters
extendedbooleanOptional

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

Default: false
Body
siteIdstringRequired

ID of the site to install the integration on

Responses
201
Integration installed successfully on site
application/json
Responseall of
post
POST /v1/integrations/{integrationName}/installations/{installationId}/sites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

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

Get an integration site installation

get
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
extendedbooleanOptional

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

Default: false
Responses
200
Integration site installation
application/json
Responseall of
get
GET /v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Uninstall an integration from a site

delete
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
204
The site installation has been deleted.
delete
DELETE /v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

The site installation has been deleted.

No content

Update an integration site installation

patch
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
extendedbooleanOptional

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

Default: false
Body
externalIdsstring[] · max: 5Optional

External IDs assigned by the integration.

Responses
200
The site installation has been updated.
application/json
Responseall of
patch
PATCH /v1/integrations/{integrationName}/installations/{installationId}/sites/{siteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "externalIds": [
    "text"
  ],
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
200

The site installation has been updated.

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

List all public integrations along with private ones trusted by the specific org.

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

searchstringOptional

A search string to filter integrations by name

categorystring · enumOptional

Filter the integrations by category

Possible values:
blockDomainstring · max: 100Optional

Filter the integrations by block's domains

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

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

contentSourcesbooleanOptional

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

ownerstringOptional

If defined, only list integrations owned by the given organization.

scopestring · enumOptional

Filter the integrations by scope

Possible values:
targetstring · enumOptional

The target on which the integration can operate and needs to be configured for

Possible values:
Responses
200
List of integrations.
application/json
Responseall of
get
GET /v1/orgs/{organizationId}/integrations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

List of integrations.

{
  "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:views: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": "2025-06-21T04:22:40.106Z",
        "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": "2025-06-21T04:22:40.106Z",
          "hasPaymentFailed": true,
          "isScheduledToCancel": true
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "endDate": "2025-06-21T04:22:40.106Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_billingMigration": {
          "deadline": "2025-06-21T04:22:40.106Z",
          "discountPercent": 1,
          "discountEndDate": "2025-06-21T04:22:40.106Z"
        },
        "permissions": {
          "view": true,
          "admin": true,
          "ownTeam": true,
          "createContent": true,
          "createOpenAPISpec": true,
          "ingestConversations": true,
          "viewBilling": true,
          "listMembers": true,
          "listTeams": true,
          "listIntegrations": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true,
        "install": true
      },
      "contentSecurityPolicy": "text"
    }
  ]
}

Get the status of an integration

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$
Responses
200
Integration installation status
application/json
get
GET /v1/orgs/{organizationId}/integrations/{integrationName}/installation_status HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "active"
}

List all integration installations

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

searchstringOptional

A search string to filter integrations by name

Responses
200
List of integrations with the associated installations.
application/json
Responseall of
get
GET /v1/orgs/{organizationId}/installations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

List of integrations with the associated installations.

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "installation": {
        "id": "text",
        "status": "active",
        "space_selection": "all",
        "site_selection": "all",
        "spaces": 1,
        "configuration": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "createdAt": "2025-06-21T04:22:40.106Z",
        "updatedAt": "2025-06-21T04:22:40.106Z",
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "publicEndpoint": "https://example.com"
        },
        "externalIds": [
          "text"
        ],
        "target": {
          "organization": "text"
        }
      },
      "integration": {
        "object": "integration",
        "name": "text",
        "version": 1,
        "title": "text",
        "description": "text",
        "summary": "text",
        "previewImages": [
          "text"
        ],
        "target": "all",
        "verified": true,
        "visibility": "public",
        "scopes": [
          "space:views: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": "2025-06-21T04:22:40.106Z",
          "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": "2025-06-21T04:22:40.106Z",
            "hasPaymentFailed": true,
            "isScheduledToCancel": true
          },
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trial": {
            "status": "notapplicable",
            "endDate": "2025-06-21T04:22:40.106Z",
            "decision": "downgrade"
          },
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_billingMigration": {
            "deadline": "2025-06-21T04:22:40.106Z",
            "discountPercent": 1,
            "discountEndDate": "2025-06-21T04:22:40.106Z"
          },
          "permissions": {
            "view": true,
            "admin": true,
            "ownTeam": true,
            "createContent": true,
            "createOpenAPISpec": true,
            "ingestConversations": true,
            "viewBilling": true,
            "listMembers": true,
            "listTeams": true,
            "listIntegrations": true
          }
        },
        "urls": {
          "location": "https://example.com",
          "icon": "https://example.com",
          "app": "https://example.com",
          "assets": "https://example.com",
          "publicEndpoint": "https://example.com"
        },
        "permissions": {
          "admin": true,
          "install": true
        },
        "contentSecurityPolicy": "text"
      }
    }
  ]
}

List all integration statuses

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

searchstringOptional

A search string to filter integrations by name

Responses
200
List of integrations.
application/json
Responseall of
get
GET /v1/orgs/{organizationId}/integrations/installations-status HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

List of integrations.

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "status": "active",
      "integration": {
        "object": "integration",
        "name": "text",
        "version": 1,
        "title": "text",
        "description": "text",
        "summary": "text",
        "previewImages": [
          "text"
        ],
        "target": "all",
        "verified": true,
        "visibility": "public",
        "scopes": [
          "space:views: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": "2025-06-21T04:22:40.106Z",
          "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": "2025-06-21T04:22:40.106Z",
            "hasPaymentFailed": true,
            "isScheduledToCancel": true
          },
          "urls": {
            "location": "https://example.com",
            "app": "https://example.com",
            "logo": "https://example.com"
          },
          "trial": {
            "status": "notapplicable",
            "endDate": "2025-06-21T04:22:40.106Z",
            "decision": "downgrade"
          },
          "customHostname": "text",
          "blocked": {
            "reason": "security"
          },
          "internal_billingMigration": {
            "deadline": "2025-06-21T04:22:40.106Z",
            "discountPercent": 1,
            "discountEndDate": "2025-06-21T04:22:40.106Z"
          },
          "permissions": {
            "view": true,
            "admin": true,
            "ownTeam": true,
            "createContent": true,
            "createOpenAPISpec": true,
            "ingestConversations": true,
            "viewBilling": true,
            "listMembers": true,
            "listTeams": true,
            "listIntegrations": true
          }
        },
        "urls": {
          "location": "https://example.com",
          "icon": "https://example.com",
          "app": "https://example.com",
          "assets": "https://example.com",
          "publicEndpoint": "https://example.com"
        },
        "permissions": {
          "admin": true,
          "install": true
        },
        "contentSecurityPolicy": "text"
      }
    }
  ]
}

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

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Responses
200
OK
application/json
get
GET /v1/orgs/{organizationId}/sites/{siteId}/integration-scripts HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List integrations enabled in a site.

get
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Query parameters
searchstringOptional

A search string to filter integrations by name

Responses
200
Listing of integrations enabled in the site.
application/json
Responseall of
get
GET /v1/orgs/{organizationId}/sites/{siteId}/integrations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Listing of integrations enabled in the site.

{
  "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:views: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": "2025-06-21T04:22:40.106Z",
        "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": "2025-06-21T04:22:40.106Z",
          "hasPaymentFailed": true,
          "isScheduledToCancel": true
        },
        "urls": {
          "location": "https://example.com",
          "app": "https://example.com",
          "logo": "https://example.com"
        },
        "trial": {
          "status": "notapplicable",
          "endDate": "2025-06-21T04:22:40.106Z",
          "decision": "downgrade"
        },
        "customHostname": "text",
        "blocked": {
          "reason": "security"
        },
        "internal_billingMigration": {
          "deadline": "2025-06-21T04:22:40.106Z",
          "discountPercent": 1,
          "discountEndDate": "2025-06-21T04:22:40.106Z"
        },
        "permissions": {
          "view": true,
          "admin": true,
          "ownTeam": true,
          "createContent": true,
          "createOpenAPISpec": true,
          "ingestConversations": true,
          "viewBilling": true,
          "listMembers": true,
          "listTeams": true,
          "listIntegrations": true
        }
      },
      "urls": {
        "location": "https://example.com",
        "icon": "https://example.com",
        "app": "https://example.com",
        "assets": "https://example.com",
        "publicEndpoint": "https://example.com"
      },
      "permissions": {
        "admin": true,
        "install": true
      },
      "contentSecurityPolicy": "text"
    }
  ]
}

Was this helpful?