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

# Fetch All Sub-merchants Paginated

`POST /api/master-merchant/{mkey}/merchants/paginated`

## Path parameters

- `mkey` string, required

## Headers

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

## Request body

- object
  - `page` string, required — The page number of the data to be fetched.
  - `pagesize` string, required — The page size of the data to be fetched.
  - `to` string, required — The to Date to fetch the sub-merchant.
  - `from` string, required — The from Date to fetch the sub-merchant.
  - `filters` object, required — The filters to apply to the sub-merchant, check examples.
  - `environment` 'live' | 'sandbox', required — The environment of the transaction is either live OR sandbox

## Response `200`

Successful response

- object
  - `content` FetchAllSubMerchantContent — The object containing the fetch Invited sub merchant API response data.
    - `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.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)