---
title: "POST /merchant/list"
method: POST
path: "/merchant/list"
---

# POST /merchant/list

`POST /merchant/list`

Retrieve a list of available merchants.

## Request body

- object
  - `type` 'card_switcher' | 'transaction_link' | 'shopping' | 'vault' | 'subscription_manager', required — Product for which the merchants are available.
  - `platform` 'ios' | 'android' | 'web' — Platform for which the merchants are available.
  - `search` string — Name of a specific merchant.
  - `external_user_id` string — Your unique identifier for the user. The values of the `status` parameter returned in the response when sending `external_user_id` can be found [here](https://docs.knotapi.com/api-reference/merchants/list-merchants-status).

## Response `200`

Successful request.

- union — Array of available merchants.
  - object[] — `Platform` included in the request
    - `id` integer — Static unique ID of the merchant (across all environments). This ID remains constant and does not change.
    - `name` string — Name of the merchant.
    - `category` string — Category of the merchant.
    - `logo` string — Logo URL for the merchant.
    - `popular` boolean — Whether the merchant is a popular merchant amongst your unique audience.
    - `min_sdk_version` string — The minimum SDK version (on the platform provided in the request) for which the merchant is available.
  - object[] — No `platform` in the request
    - `id` integer — Static unique ID of the merchant (across all environments). This ID remains constant and does not change.
    - `name` string — Name of the merchant.
    - `category` string — Category of the merchant.
    - `logo` string — Logo URL for the merchant.
    - `popular` boolean — Whether the merchant is a popular merchant amongst your unique audience.

## Other responses

- `401` — Unauthorized request.
- `403` — Forbidden request.
- `500` — Internal server error.

---

[API](https://skmtc.net/knotapi/apis/knot-api.md) · [All operations](https://skmtc.net/knotapi/apis/knot-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knotapi/knot-api/versions/4610832c2087/schema)