Get Campaign

GET 
/affiliate-manager/:locationId/campaigns/:campaignId

Retrieve a single affiliate campaign by id for a location.

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location Id

campaignId stringrequired

Campaign Id

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Campaign id

locationIdstringrequired

Location id the campaign belongs to

namestringrequired

Campaign name

descriptionstring

Campaign description

trackTypestring
What the campaign tracks
Available optionsformssurveyscalendersfunnelswebsitesstoreexternal_sourcecommunity
subTrackTypestring
Sub track type
Available optionsleadproductdonation
liveModebooleanrequired

Whether the campaign is live

currencystring

Campaign currency

payoutFrequencystring
How often affiliates are paid out
Available optionsPAY_7PAY_15PAY_30PAY_45PAY_60PAY_90
cookieLifenumberrequired

Referral cookie lifetime in days

commissionTypestring
First tier commission type
Available optionsflatpercentage
commissionnumber

First tier commission value

commissionTiernumber

Number of commission tiers

leadCommissionTiernumber

Number of lead commission tiers

isGlobalCommissionboolean

Whether one commission applies to every product on the campaign

secondTierCommissionTypestring
Second tier commission type
Available optionsflatpercentage
secondTierCommissionnumber

Second tier commission value

calculateSetupFeeboolean

Whether setup fees count towards commission

referralPermalinkstring

Referral link slug

referralRealLinkstring

Full referral link

domainstring

Domain the referral link points at

stepIdstring

Funnel or page step id being tracked

subAfLinkstring

Sub affiliate signup link

enableSubAffiliateLinkboolean

Whether sub affiliate signup is enabled

enableAutoEnrollSubAffiliateboolean

Whether sub affiliates are auto enrolled

createdAtstring

Campaign creation timestamp

updatedAtstring

Campaign update timestamp

commissionV2object[]

Per-tier commission configuration. This is what the commission engine applies; the flat commissionType and commission fields are the legacy fallback used only when this is empty.

leadCommissionV2object[]

Per-tier lead commission configuration, applied to lead-tracking campaigns

productsobject[]

Products and prices attached to the campaign. For commission calculation use commissionV2[].productBasedCommission, which is typed and authoritative.

Example (auto)

{
  "_id": "6385d230f6d19db03eef6fb2",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "Summer launch",
  "description": "Affiliate campaign for the summer launch",
  "trackType": "funnels",
  "subTrackType": "product",
  "liveMode": true,
  "currency": "USD",
  "payoutFrequency": "PAY_30",
  "cookieLife": 30,
  "commissionType": "percentage",
  "commission": 10,
  "commissionTier": 1,
  "leadCommissionTier": 1,
  "isGlobalCommission": true,
  "secondTierCommissionType": "percentage",
  "secondTierCommission": 5,
  "calculateSetupFee": false,
  "referralPermalink": "summer-launch",
  "referralRealLink": "https://example.com/summer-launch",
  "domain": "example.com",
  "stepId": "6385d230f6d19db03eef6fb3",
  "subAfLink": "https://example.com/sub-affiliate-signup",
  "enableSubAffiliateLink": false,
  "enableAutoEnrollSubAffiliate": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-02T00:00:00.000Z",
  "commissionV2": [
    {
      "tier": 1,
      "defaultCommission": {
        "commissionType": "percentage",
        "commission": 10
      },
      "productBasedCommission": [
        {
          "productId": "6385d230f6d19db03eef6fb9",
          "productName": "Starter Course",
          "priceId": "price_1MoBy5AbCdEfGhIj",
          "commissionType": "flat",
          "commission": 25
        }
      ],
      "commissionLength": {
        "lengthType": "by-count",
        "length": 3
      },
      "variableCommission": {
        "enabled": "yes",
        "count": 2,
        "commissionType": "flat",
        "commission": 5
      }
    }
  ],
  "leadCommissionV2": [
    {
      "tier": 1,
      "defaultCommission": {
        "commissionType": "percentage",
        "commission": 10
      }
    }
  ],
  "products": [
    {
      "_id": "6385d230f6d19db03eef6fc1",
      "productId": "6385d230f6d19db03eef6fb9",
      "priceId": "price_1MoBy5AbCdEfGhIj",
      "productName": "Starter Course",
      "commission": 25,
      "commissionType": "flat"
    }
  ]
}