> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/developers/gitbook-api/api-reference/integrations/get-an-integration-installation-by-its-id.md).

# Get an integration installation by its ID

Returns the organization-level installation of an integration, including its account configuration and how many spaces it manages. The configuration can contain credentials the integration stored for third-party services.

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"integrations","description":"Expand the capabilities of GitBook by connecting it with various external platforms—CRM, finding trackers, or CI/CD pipelines—through standardized integration endpoints.\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]},{"integration":[]},{"integration-installation":[]},{"oauth":["integration:installations:read"]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"},"integration":{"type":"http","scheme":"bearer"},"integration-installation":{"type":"http","scheme":"bearer"},"oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://oauth.gitbook.com/authorize","tokenUrl":"https://oauth.gitbook.com/token","scopes":{"user:read":"Read your GitBook user profile.","organization:read":"Read organization settings and metadata.","organization:write":"Create and update organization settings.","organization:members:read":"Read organization members, invites and link invites.","organization:members:write":"Manage organization members, invites and link invites.","organization:ask":"Ask AI questions across an organization's content.","organization:search":"Search across an organization's content.","space:read":"Read spaces and their content.","space:write":"Create, update and delete spaces and their content, including imports.","space:permissions:read":"Read space permissions.","space:permissions:write":"Manage space permissions.","change-request:merge":"Merge change requests, publishing their changes to the space.","site:read":"Read sites and their settings.","site:write":"Create, update and delete sites, sections and their settings.","site:publish":"Publish and unpublish sites, controlling their public exposure.","site:permissions:read":"Read site permissions.","site:permissions:write":"Manage site permissions.","site:auth:read":"Read site authentication and security configuration.","site:auth:write":"Manage site authentication and security configuration.","site:insights:read":"Read site analytics and insights.","site:ask":"Ask AI questions across a site's content.","site:search":"Search across a site's content.","integration:read":"Read integrations and where they are installed.","integration:installations:read":"Read integration installations and their configuration, which can include credentials for third-party services.","integration:installations:write":"Install and configure integrations on an organization, its spaces and its sites.","integration:publish":"Publish integrations, which can request their own permissions on your content, and route their events to a development tunnel.","integration:delete":"Unpublish integrations, permanently deleting them and every installation of them.","openapi:read":"Read OpenAPI specifications.","openapi:write":"Create, update and delete OpenAPI specifications."}}}}},"parameters":{"integrationName":{"name":"integrationName","in":"path","required":true,"description":"Name of the integration.","schema":{"type":"string","pattern":"^[a-zA-Z0-9-_.]+$","maxLength":100}},"installationId":{"name":"installationId","in":"path","required":true,"description":"Identifier of the installation","schema":{"type":"string"}}},"schemas":{"IntegrationInstallation":{"type":"object","description":"Installation of an integration on an account","properties":{"id":{"type":"string"},"status":{"$ref":"#/components/schemas/IntegrationInstallationStatus"},"space_selection":{"$ref":"#/components/schemas/IntegrationInstallationSpaceSelection"},"site_selection":{"$ref":"#/components/schemas/IntegrationInstallationSiteSelection"},"spaces":{"type":"number","description":"Count of spaces, the installation is managing"},"configuration":{"$ref":"#/components/schemas/IntegrationInstallationConfiguration"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"urls":{"type":"object","description":"URLs associated with the object","properties":{"location":{"type":"string","description":"URL of the installation in the API","format":"uri"},"app":{"type":"string","description":"URL of the integration's installation in the application","format":"uri"},"publicEndpoint":{"type":"string","description":"Public HTTP endpoint for the integration's installation","format":"uri"},"publicContentEndpoint":{"type":"string","description":"Public endpoint serving the integration's rendered content (e.g. WebFrames), isolated from the cookie-bearing publicEndpoint origin. Equals publicEndpoint when no separate content origin is configured.","format":"uri"}},"required":["location","app","publicEndpoint","publicContentEndpoint"]},"externalIds":{"$ref":"#/components/schemas/IntegrationInstallationExternalIds"},"target":{"$ref":"#/components/schemas/IntegrationInstallationTarget","description":"Target of the integration installation"},"network":{"$ref":"#/components/schemas/IntegrationNetwork","description":"Network configuration for the installation"}},"required":["id","status","space_selection","site_selection","spaces","configuration","urls","externalIds","target","createdAt","updatedAt"]},"IntegrationInstallationStatus":{"type":"string","enum":["active","pending","paused"]},"IntegrationInstallationSpaceSelection":{"type":"string","description":"Describe whether all spaces have been selected or there's a selection involved","enum":["all","selected"]},"IntegrationInstallationSiteSelection":{"type":"string","description":"Describe whether all sites have been selected or there's a selection involved","enum":["all","selected"]},"IntegrationInstallationConfiguration":{"type":"object","description":"Configuration of the integration at the account level","additionalProperties":true},"Timestamp":{"type":"string","format":"date-time"},"IntegrationInstallationExternalIds":{"type":"array","description":"External IDs assigned by the integration.","maxItems":5,"items":{"type":"string"}},"IntegrationInstallationTarget":{"oneOf":[{"$ref":"#/components/schemas/OrganizationTarget"}]},"OrganizationTarget":{"type":"object","required":["organization"],"properties":{"organization":{"type":"string"}}},"IntegrationNetwork":{"type":"object","description":"Network configuration for the installation","properties":{"proxy":{"type":"boolean","description":"Whether the installation is proxied through the backend"}}}},"responses":{"NotFoundError":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","enum":[404]},"message":{"type":"string"}},"required":["code","message"]}}}}}}}},"paths":{"/integrations/{integrationName}/installations/{installationId}":{"get":{"operationId":"getIntegrationInstallationById","summary":"Get an integration installation by its ID","description":"Returns the organization-level installation of an integration, including its account configuration and how many spaces it manages. The configuration can contain credentials the integration stored for third-party services.","tags":["integrations"],"parameters":[{"$ref":"#/components/parameters/integrationName"},{"$ref":"#/components/parameters/installationId"}],"responses":{"200":{"description":"Integration installation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstallation"}}}},"404":{"$ref":"#/components/responses/NotFoundError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gitbook.com/docs/developers/gitbook-api/api-reference/integrations/get-an-integration-installation-by-its-id.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.