---
title: "Fetch All Sub-merchants"
method: GET
path: "/api/master-merchant/{mkey}/merchants"
tags: ["MasterMerchant APIs"]
---

# Fetch All Sub-merchants

`GET /api/master-merchant/{mkey}/merchants`

## Request

- Base URL: `https://api.portone.cloud`
- URL: `https://api.portone.cloud/api/master-merchant/{mkey}/merchants`
- Auth: none declared

## Path parameters

- `mkey` string, required

## Query parameters

- `environment` string, required

## Headers

- `X-Portone-Client-Key` string
- `Authorization` string

## Response `200`

Successful response

- object
  - `content` FetchAllSubMerchantContent[]: The array of objects containing the list of sub-merchant & their details.
    - `uuid` string: The unique identifier of the invited SubMerchant.
    - `name` string: The name of the invited SubMerchant.
    - `email_address` string: The email_address of the invited SubMerchant.
    - `merchant_status` string: The status of the invited SubMerchant.
    - `key` string: The PortOne key of the invited SubMerchant.
    - `master_merchant_access` boolean: The boolean flag indicating whether master_merchant_access can access sub_merchant.
    - `use_master_merchant_creds` boolean: The boolean flag indicating whether sub-merchant can use the Master Merchant credentials.
    - `is_login_allowed` boolean: The boolean flag indicating whether sub-merchant can login to PortOne admin console.
    - `is_invite_merchant` boolean: The boolean flag indicating whether the merchant was invited.
    - `kyc_link` string: The URL of the dedicated KYC page for the sub-merchant.
    - `kyc_status` string: The KYC status of the merchant.
    - `send_kyc_link_email` boolean: The boolean flag indicating whether sub-merchant was sent email containing the KYC details.
  - `message` string: The description of the API request execution result
  - `status_code` string: The status_code for API request execution result
  - `status_reason` string: The status_reason for API request execution result

## Other responses

- `400`: Failure response
- `401`: Failure response

---

[API](https://skmtc.dev/portone/apis/master-merchant-apis.md) - [All operations](https://skmtc.dev/portone/apis/master-merchant-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/portone/apis/master-merchant-apis/revisions/bc3593c8539c?raw)