List all integration statuses

Returns integration installations in the organization. Use site or space with the matching target to efficiently scope the result to one resource. The target of each installation says whether it is installed on the organization, a space or a site.

Available in MCP

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

targetstring · enumOptional

Filter installations by their target (organization, space, or site). When not provided, defaults to organization-level installations for backwards compatibility

Default: organizationPossible values:

sitestringOptional

Return installations for this site. Only valid when target is site.

spacestringOptional

Return installations for this space. Only valid when target is space.

Responses

200

List of installed integrations and their statuses

application/json

countnumberOptional

Total count of objects in the list

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

GET /v1/orgs/{organizationId}/integrations/installations-status HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of installed integrations and their statuses

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