---
title: "List installs"
method: GET
path: "/v1/installs"
tags: ["Installs"]
---

# List installs

`GET /v1/installs`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/installs`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

This workspace’s installs, newest first. `planIncludesMore: true` on an install that left out a step because the plan did not include it, and whose plan includes it now: `PATCH` it with `action: "addPlanIncluded"`. Keyset pagination: pass `meta.cursor` back as `cursor` while `meta.hasMore` is true.

## Query parameters

- `listingId` string: Only installs of this listing
- `includeRemoved` 'true' | 'false': `true` to include removed installs
- `limit` integer: Page size (default 50, at most 100)
- `cursor` string: `meta.cursor` of the previous page, while `meta.hasMore` is true

## Response `200`

The installs

- object
  - `success` true, required
  - `data` object[], required
    - `id` string, required: Install id — the `installId` other operations take
    - `name` string, required
    - `source` 'listing' | 'app' | 'workspace' | 'preset' | 'inline', required
    - `listingId` string, nullable, required
    - `releaseId` string, nullable, required
    - `blueprintId` string, nullable, required
    - `blueprintKey` string, nullable, required
    - `status` 'installing' | 'installed' | 'partial' | 'removing' | 'removed', required
    - `generation` integer, required
    - `error` string, nullable, required
    - `createdAt` string, nullable, required
    - `updatedAt` string, nullable, required
    - `removedAt` string, nullable, required
    - `removeMode` 'keep' | 'trash' | 'null', nullable, required
    - `planIncludesMore` boolean
  - `meta` object, required
    - `count` integer, required
    - `cursor` string, nullable, required
    - `hasMore` boolean, required

## Other responses

- `400`: Invalid input — `code` names it: `VALIDATION_FAILED`, `INVALID`, `INVALID_BLUEPRINT` (not a blueprint this workspace can read), `PORTABILITY_VIOLATION` (it still carries workspace ids), `UNSAFE_BLUEPRINT`, `INVALID_BINDINGS` (an input is missing or does not fit), `RESTORE_WINDOW_PASSED`; `details[]` names each field
- `401`: Unauthorized
- `403`: Forbidden — a missing `marketplace:read` / `marketplace:write` scope, a role below editor for a change, an installed app outside the public marketplace, an unverified listing already installed in ten workspaces (`INSTALL_CAP_REACHED`), or a template that needs more tables, feeds or enrichments than the workspace plan has left (`PLAN_LIMIT_REACHED`)
- `404`: Not found — something this workspace may not see answers exactly as something that does not exist; or the marketplace is not enabled for this workspace
- `409`: Conflict — it changed since you read it (`STALE`), it is busy or in the wrong state (`INVALID_STATE`), the listing cannot be installed (`NOT_INSTALLABLE`), a key is taken (`KEY_TAKEN`), or an existing container does not fit (`ADOPTION_CONFLICT`)
- `429`: Too many — the key’s rate limit, or a marketplace quota (`QUOTA_EXCEEDED`: 200 saved templates per workspace, 50 installs per hour). `Retry-After` says when to come back.
- `503`: The marketplace is temporarily unavailable; retry shortly

---

[API](https://skmtc.dev/banksync/apis/banksync-api.md) · [All operations](https://skmtc.dev/banksync/apis/banksync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/banksync/apis/banksync-api/revisions/94465f5ee922?raw)