---
title: "Read a marketplace listing"
method: GET
path: "/v1/marketplace/listings/{kind}/{slug}"
tags: ["Marketplace"]
---

# Read a marketplace listing

`GET /v1/marketplace/listings/{kind}/{slug}`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/marketplace/listings/{kind}/{slug}`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

One listing by kind and slug: its description, approved media, current release and changelog. An unverified listing answers only with its private-link token (`?link=`) and says `unlisted: true`; it is never in search.

## Path parameters

- `kind` 'template' | 'app' | 'widget' | 'service', required: `template`, `app`, `widget` or `service`
- `slug` string, required: The listing’s slug, from a search result or its URL

## Query parameters

- `link` string: The private-link token of a listing that is not publicly listed (its `?link=`)

## Response `200`

The listing

- object
  - `success` true, required
  - `data` object, required
    - `listing` object, required
      - `id` string, required: Listing id — the `listingId` an install plan takes
      - `kind` 'template' | 'app' | 'widget' | 'service', required
      - `slug` string, required
      - `title` string, required
      - `tagline` string, nullable, required
      - `category` string, required
      - `tags` string[], required
      - `pricingNote` string, nullable, required
      - `logoUrl` string, nullable, required
      - `verified` boolean, required
      - `featured` boolean, required
      - `creatorId` string, nullable, required
      - `path` string, required
      - `installs` 'none' | '1-10' | '11-50' | '51-200' | '200+', required: How many workspaces use it, as a coarse bucket — never an exact count
      - `updatedAt` string, nullable, required
      - `description` string, required
      - `links` object, required
      - `facets` object, required
      - `service` object, nullable, required
    - `media` object[], required
      - `id` string, required
      - `kind` string, required
      - `caption` string, nullable, required
      - `embedProvider` string, nullable, required
      - `embedId` string, nullable, required
      - `width` integer, nullable, required
      - `height` integer, nullable, required
    - `release` object, nullable, required
      - `id` string, required
      - `number` integer, required
      - `changes` string[], required
      - `approvedAt` string, nullable, required
    - `unlisted` 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)