Skip to main content
Retrieve the list of commissions for a account. 
GET https://services.leadconnectorhq.com/affiliate-manager/{locationId}/commissions

​
Autorización

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
​
Version
string
default:"2021-07-28"
required
Versión de la API.

​
Path parameters

​
locationId
string
default:"ve9EPM428h8vShlRW1KT"
required
Account Id

​
Query parameters

​
campaignId
string
default:"6385d230f6d19db03eef6fb2"
Campaign Id
​
affiliateId
string
default:"6385d230f6d19db03eef6fb2"
Affiliate Id
​
status
string
default:"pending"
Status
​
query
string
default:"affiliate@gmail.com"
Query
​
skip
number
default:"1"
​
limit
number
default:"10"
Maximum number of records to return. Maximum allowed value is 100.
​
fromDate
string
default:"2023-10-01"
​
toDate
string
default:"2023-10-01"

​
Respuestas

​
commissions
object[]
required
Commission list
​
meta
object
Pagination metadata
{
  "commissions": [
    {
      "_id": "6385d230f6d19db03eef6fb2",
      "productId": "6385d230f6d19db03eef6fb2",
      "productName": "Basic Plan",
      "qty": 1,
      "productCommission": 25,
      "commissionAmount": 25,
      "amount": 100,
      "unitDiscount": 5,
      "campaignName": "Summer Promo",
      "commission": 25,
      "commissionType": "percentage",
      "transactionAt": "2024-06-16T00:00:00.000Z",
      "transactionId": "txn_123",
      "affiliateId": "6385d230f6d19db03eef6fb2",
      "payoutId": "6385d230f6d19db03eef6fb2",
      "status": "pending",
      "currency": "USD",
      "isTrial": false,
      "createdAt": "2024-06-16T00:00:00.000Z",
      "eventId": "evt_123",
      "dueAt": "2024-06-30T00:00:00.000Z",
      "liveMode": true,
      "tier": 1
    }
  ]
}

{}

{}

{}

​
Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);