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

# Fetch Invited Sub-merchants

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

## Path parameters

- `mkey` string, required

## Headers

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

## Response `200`

Successful response

- object
  - `content` FetchInvitedSubMerchantContent[] — The array of objects containing the list of invited sub-merchant & their details.
    - `email_address` string — The email_address of the invited SubMerchant.
    - `status` string — The onboarding status of the invited SubMerchant.
    - `created_at` string — The timestamp of the invited SubMerchant.
    - `invite_link` string — The invite link of the invited SubMerchant
    - `use_master_merchant_creds` string — The boolean value if sub-merchant can use master credentials
    - `is_login_allowed` string — The boolean value if sub-merchant can login.
    - `is_invite_merchant` string — The boolean value if sub-merchant was invited.
    - `send_kyc_link_email` string — The boolean vale if KYC email is sent to sub-merchant.
    - `country` string — The country of the invited SubMerchant.
    - `name` string — The brand name of the invited SubMerchant.
  - `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.net/portone/apis/payment-apis.md) · [All operations](https://skmtc.net/portone/apis/payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portone/payment-apis/revisions/f3ccea652555/schema)