---
title: "IntegrationInstall"
description: "The `IntegrationInstall` entity."
section: "Reference"
group: "Types"
order: 130
---

## Definition

```ts
interface IntegrationInstall {
  id: string;
  integrationId: string;
  integrationVersionId: string;
  workspaceId: string;
  variables: Record<string, unknown>;
  authStateId: string | null;
  memberPolicy: "manual" | "auto_all" | "auto_defaults";
  parentInstallId: string | null;
  solutionId: string | null;
  installedBy: string;
  installedAt: string;
  lastUpgradedAt: string | null;
  deletedAt: string | null;
  retentionTier: "short" | "medium" | "long" | "none" | null;
}
```

## Fields

| Field                  | Type                                              | Notes                                                                                                                                          |
| ---------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                   | `string`                                          | `readonly` `required`                                                                                                                          |
| `integrationId`        | `string`                                          | `required`                                                                                                                                     |
| `integrationVersionId` | `string`                                          | `required`                                                                                                                                     |
| `workspaceId`          | `string`                                          | `required` — Destination workspace — where the install materializes / references entities.                                                     |
| `variables`            | `Record<string, unknown>`                         | `required` — Resolved values for the integration's variables_schema.                                                                           |
| `authStateId`          | `string \| null`                                  | `required` — Pointer into workspace secret storage holding OAuth tokens / API key. NEVER the raw value. NULL when auth_config.type === 'none'. |
| `memberPolicy`         | `"manual" \| "auto_all" \| "auto_defaults"`       | `required`                                                                                                                                     |
| `parentInstallId`      | `string \| null`                                  | `required` — For add-ons: the parent install this one extends. NULL for primary installs.                                                      |
| `solutionId`           | `string \| null`                                  | `required` — Grouping Solution materialized for this install; removed by the uninstall cascade.                                                |
| `installedBy`          | `string`                                          | `required`                                                                                                                                     |
| `installedAt`          | `string`                                          | `required`                                                                                                                                     |
| `lastUpgradedAt`       | `string \| null`                                  | `required`                                                                                                                                     |
| `deletedAt`            | `string \| null`                                  | `required`                                                                                                                                     |
| `retentionTier`        | `"short" \| "medium" \| "long" \| "none" \| null` | `required`                                                                                                                                     |