Skip to main content
GET
/
marketplace
/
merchants
curl "https://api.khaime.com/api/v1/partner/marketplace/merchants?page=1&limit=20" \
  -H "X-API-Key: pk_sandbox_your_key"

Documentation Index

Fetch the complete documentation index at: https://docs.khaime.com/llms.txt

Use this file to discover all available pages before exploring further.

​
List Merchants

Retrieve all sub-merchants registered under your marketplace, with pagination.

​
Query Parameters

​
status
string
default:"active"
Filter by merchant status. Default: active.
​
page
integer
default:"1"
Page number for pagination. Default: 1.
​
limit
integer
default:"20"
Number of results per page. Maximum: 100. Default: 20.

​
Response

{
  "success": true,
  "message": "Merchants retrieved successfully",
  "data": {
    "merchants": [
      {
        "id": 3,
        "marketplace_id": 1042,
        "merchant_id": 1676,
        "commission_rate": "0.0800",
        "status": "active",
        "invite_token": null,
        "invited_at": null,
        "joined_at": "2026-03-28T11:33:21.646Z",
        "created_at": "2026-03-28T11:33:21.646Z",
        "updated_at": "2026-03-28T11:33:21.646Z",
        "merchant": {
          "id": 1676,
          "educator_email": "merchant@example.com"
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "pages": 1
    }
  }
}

​
Response Fields

FieldTypeDescription
merchants[].idintegerMarketplace-merchant relationship ID
merchants[].marketplace_idintegerOperator’s business ID
merchants[].merchant_idintegerSub-merchant’s business ID
merchants[].commission_ratestringDecimal commission rate (e.g., "0.0800" = 8%)
merchants[].statusstringactive or suspended
merchants[].joined_atstringISO 8601 timestamp when the merchant was linked
merchants[].merchantobjectNested merchant details
merchants[].merchant.idintegerMerchant’s business ID
merchants[].merchant.educator_emailstringMerchant’s email address
paginationobjectPagination metadata
curl "https://api.khaime.com/api/v1/partner/marketplace/merchants?page=1&limit=20" \
  -H "X-API-Key: pk_sandbox_your_key"