Kamaiyo API

Build on Kamaiyo.

Generate trackable links, list the campaigns you can promote, and pull your orders — the same data the Kamaiyo app runs on, from your own code.

Base URL

https://api.kamaiyo.com/v1

Auth

x-api-key header

Format

JSON · { success, data }

Authentication

Every request needs your API key in the x-api-key header. Sign in below to create one — it’s shown once, so store it safely. Rotating replaces it and immediately disables the old key.

Playground API key

Used by the “Try it” panels. Stored only in this browser — never sent to our docs server.

Example request

curl

curl https://api.kamaiyo.com/v1/campaigns \
  -H "x-api-key: YOUR_API_KEY"

GET/v1/campaigns

List campaigns

Every campaign you can promote right now — live, brand-approved offers with their commission, allowed channels and the store domains they cover.

Parameters

`limit`	integer query	Page size (default 50, max 200).
`offset`	integer query	Rows to skip for paging.

Example response

json

{
  "success": true,
  "data": {
    "campaigns": [
      {
        "id": "c316e04e-8a76-4064-a675-e4ac4f6ff0d9",
        "brand_name": "Flipkart",
        "category": null,
        "brand_logo_url": null,
        "commission": {
          "type": "percentage",
          "value": "8",
          "currency": "INR",
          "display": "Up to 8%"
        },
        "allowed_channels": [
          "whatsapp",
          "telegram",
          "website"
        ],
        "destination_domains": [
          "www.flipkart.com",
          "dl.flipkart.com"
        ],
        "terms_url": null,
        "link_mode": "kamaiyo_tracked_redirect"
      }
    ],
    "count": 1
  }
}

Try it

limitqueryoffsetquery

curl

curl "https://api.kamaiyo.com/v1/campaigns?limit=20" \
  -H "x-api-key: YOUR_API_KEY"

POST/v1/links

Generate a link

Turn a product page into a trackable link. Paste the product URL — we match its store to a live campaign and return a short link that credits clicks and orders to you. If no active campaign covers that store, you get no_campaign_for_url.

Parameters

url*

string

body

The product page you want to promote, e.g. a Flipkart product URL.

Example response

json

{
  "success": true,
  "data": {
    "link": {
      "id": "bebdac1d-e282-40bf-95ec-68cfa40ebc71",
      "link_code": "34vy7xaegb",
      "short_url": "https://kmyo.link/r/34vy7xaegb",
      "campaign_id": "c316e04e-8a76-4064-a675-e4ac4f6ff0d9",
      "brand_name": "Flipkart",
      "created_at": "2026-08-12T21:12:23.568Z"
    }
  }
}

Try it

urlbody*

curl

curl -X POST "https://api.kamaiyo.com/v1/links" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://www.flipkart.com/apple-iphone-15/p/itm6ac6485515ae4"}'

GET/v1/links

List your links

Every link you have generated, each with its live click count.

Parameters

`campaign_id`	string (uuid) query	Only links for this campaign.
`limit`	integer query	Page size (default 50, max 200).
`offset`	integer query	Rows to skip for paging.

Example response

json

{
  "success": true,
  "data": {
    "links": [
      {
        "id": "3369a6df-c778-43e7-a1c3-ed43f375c7c8",
        "link_code": "avyrk5z4jr",
        "short_url": "https://kmyo.link/r/avyrk5z4jr",
        "campaign_id": "c316e04e-8a76-4064-a675-e4ac4f6ff0d9",
        "brand_name": "Flipkart",
        "status": "active",
        "clicks": 12,
        "created_at": "2026-08-05T09:14:00Z",
        "expires_at": null
      }
    ],
    "count": 1
  }
}

Try it

campaign_idquerylimitqueryoffsetquery

curl

curl "https://api.kamaiyo.com/v1/links?limit=20" \
  -H "x-api-key: YOUR_API_KEY"

GET/v1/conversions

Track orders

Your orders, straight from Kamaiyo’s own records. Newest first. Filter by campaign, by a specific link (its short code or id), or look up a single order by its reference.

Parameters

`campaign_id`	string (uuid) query	Only orders for this campaign.
`link_code`	string query	Only orders on this short link (the code in …/r/CODE).
`link_id`	string (uuid) query	Only orders on this generated-link id.
`order_reference`	string query	Look up one order by its store reference.
`status`	string query	validated, awaiting_validation, received, reversed or rejected.
`start_date`	string (date) query	Only orders reported on/after this date.
`end_date`	string (date) query	Only orders reported on/before this date.
`limit`	integer query	Page size (default 50, max 200).

Example response

json

{
  "success": true,
  "data": {
    "conversions": [
      {
        "order_reference": "OD338333937551273100",
        "campaign_id": "c316e04e-8a76-4064-a675-e4ac4f6ff0d9",
        "brand_name": "Flipkart",
        "link_code": "avyrk5z4jr",
        "channel": "whatsapp",
        "sale_amount": {
          "minor": 86900,
          "amount": "869.00",
          "currency": "INR"
        },
        "commission": {
          "minor": 5985,
          "amount": "59.85",
          "currency": "INR"
        },
        "status": "awaiting_validation",
        "source": "whatsapp",
        "order_date": "2026-08-11T21:34:33+00:00",
        "reported_at": "2026-08-12T06:40:48.28+00:00"
      }
    ],
    "count": 1
  }
}

Try it

campaign_idquerylink_codequerylink_idqueryorder_referencequerystatusquerystart_datequeryend_datequerylimitquery

curl

curl "https://api.kamaiyo.com/v1/conversions?link_code=avyrk5z4jr&order_reference=OD338333937551273100&start_date=2026-08-01&limit=20" \
  -H "x-api-key: YOUR_API_KEY"

Errors

Failures use the same envelope with success: false and an error.code you can branch on.

401 missing_api_key / invalid_api_key	No x-api-key header, or the key is wrong or revoked.
400 invalid_input / invalid_url	A parameter is missing or malformed (the message says which).
422 no_campaign_for_url	No active campaign covers that product link’s store.
403 account_suspended	The account behind the key is suspended.
500 internal_error	Something went wrong on our side — retry, then contact support.

Need help? Email hello@kamaiyo.com.