---
title: "Merchant: List"
method: GET
path: "/merchants"
tags: ["Platform Model"]
---

# Merchant: List

`GET /merchants`

Retrieves a paginated list of sub-merchants. Results can be filtered by `live` status,
`platform_role`, account `status`, and whether payments or payouts are enabled.

## Query parameters

- `start_time` string, date-time
- `end_time` string, date-time
- `per_page` integer
- `page` integer
- `live` boolean
- `platform_role` 'seller' | 'payout'
- `status` string
- `payments_enabled` boolean
- `payouts_enabled` boolean

## Response `200`

200 response

- SubmerchantsList
  - `resource` string, required — Resource type name for this list.
  - `total` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
  - `page` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
  - `per_page` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
  - `last_page` integer, required — Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
  - `data` SubmerchantListItem[], required — Array of sub-merchant list items for this page.
    - `id` string, required — Unique identifier for this sub-merchant.
    - `live` boolean, required — Whether this merchant is operating in live (production) mode.
    - `created_at` string, date-time, required — Timestamp when this merchant was created.
    - `updated_at` string, date-time, required — Timestamp when this merchant record was last updated.
    - `account_id` string, required — Account identifier associated with this merchant.
    - `name` string, required — Display name of the sub-merchant.
    - `platform_role` 'seller' | 'payout', required
    - `status` 'accepted' | 'declined', required — Account application status of the merchant.
    - `payments_enabled` boolean, required — Whether payments are enabled for this merchant.
    - `payouts_enabled` boolean, required — Whether payouts are enabled for this merchant.

---

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