Skip to main content

​
API Endpoints

All endpoints are relative to the base URL https://api.convertlyhq.com/v1. Every request requires an Authorization: Bearer {token} header.

​
Affiliates (Creators)

MethodEndpointDescription
GET/affiliatesList all creators in your program
GET/affiliates/:idGet a specific creator
POST/affiliates/inviteInvite a creator by email
PATCH/affiliates/:idUpdate creator details (status, commission override)

​
List Creators

curl https://api.convertlyhq.com/v1/affiliates?limit=20 \
  -H "Authorization: Bearer $TOKEN"

{
  "data": [
    {
      "id": "aff_abc123",
      "name": "Sarah Johnson",
      "email": "sarah@example.com",
      "status": "active",
      "trackingCode": "SARAH15",
      "totalRevenue": 4520.00,
      "totalOrders": 38,
      "commissionEarned": 678.00,
      "createdAt": "2026-01-15T10:00:00Z"
    }
  ],
  "meta": { "total": 42, "cursor": "eyJpZCI6..." }
}

​
Campaigns

MethodEndpointDescription
GET/campaignsList all campaigns
GET/campaigns/:idGet campaign details
POST/campaignsCreate a new campaign
PATCH/campaigns/:idUpdate a campaign
DELETE/campaigns/:idDelete a draft campaign

​
List Campaigns

curl https://api.convertlyhq.com/v1/campaigns?limit=10 \
  -H "Authorization: Bearer $TOKEN"

{
  "data": [
    {
      "id": "camp_def456",
      "name": "Summer Launch 2026",
      "status": "active",
      "creatorsCount": 15,
      "startDate": "2026-06-01",
      "endDate": "2026-08-31",
      "totalRevenue": 12400.00
    }
  ],
  "meta": { "total": 5, "cursor": null }
}

​
Discounts

MethodEndpointDescription
GET/discountsList all discount codes
GET/discounts/:idGet discount details
POST/discountsCreate a discount code
POST/discounts/bulkBulk create discount codes
DELETE/discounts/:idDelete a discount code

​
Create a Discount

curl -X POST https://api.convertlyhq.com/v1/discounts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "SARAH15",
    "type": "percentage",
    "value": 15,
    "affiliateId": "aff_abc123"
  }'

​
Tracking

MethodEndpointDescription
GET/tracking/clicksGet click statistics
POST/tracking/ref/:codeRecord a tracking link click

​
Get Click Stats

curl "https://api.convertlyhq.com/v1/tracking/clicks?from=2026-03-01&to=2026-03-31" \
  -H "Authorization: Bearer $TOKEN"

​
Billing

MethodEndpointDescription
GET/billingGet current subscription info
GET/billing/usageGet usage stats (creators, campaigns)

​
Get Subscription

curl https://api.convertlyhq.com/v1/billing \
  -H "Authorization: Bearer $TOKEN"

{
  "data": {
    "plan": "growth",
    "status": "active",
    "currentPeriodEnd": "2026-04-15T00:00:00Z",
    "creatorsUsed": 23,
    "creatorsLimit": 500
  }
}

​
Commissions

MethodEndpointDescription
GET/commissionsList commissions (filter by status)
PATCH/commissions/:id/approveManually approve a commission

​
List Pending Commissions

curl "https://api.convertlyhq.com/v1/commissions?status=pending" \
  -H "Authorization: Bearer $TOKEN"
All list endpoints support cursor-based pagination with limit and cursor query parameters. See API Overview for details.