Skip to main content
CampaignsVersion: v3

Get Campaign

GET/affiliate-manager/{locationId}/campaigns/{campaignId}

Retrieve a single affiliate campaign by id for a location.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:affiliate-manager.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT
campaignIdstringrequired

Campaign Id

Example:6385d230f6d19db03eef6fb2

Response

application/json

Successful response

_idstringrequired

Campaign id

Example:6385d230f6d19db03eef6fb2
locationIdstringrequired

Location id the campaign belongs to

Example:ve9EPM428h8vShlRW1KT
namestringrequired

Campaign name

Example:Summer launch
descriptionstring

Campaign description

Example:Affiliate campaign for the summer launch
trackTypestring

What the campaign tracks

Available optionsformssurveyscalendersfunnelswebsitesstoreexternal_sourcecommunity
Example:funnels
subTrackTypestring

Sub track type

Available optionsleadproductdonation
Example:product
liveModebooleanrequired

Whether the campaign is live

Example:true
currencystring

Campaign currency

Example:USD
payoutFrequencystring

How often affiliates are paid out

Available optionsPAY_7PAY_15PAY_30PAY_45PAY_60PAY_90
Example:PAY_30
cookieLifenumberrequired

Referral cookie lifetime in days

Example:30
commissionTypestring

First tier commission type

Available optionsflatpercentage
Example:percentage
commissionnumber

First tier commission value

Example:10
commissionTiernumber

Number of commission tiers

Example:1
leadCommissionTiernumber

Number of lead commission tiers

Example:1
isGlobalCommissionboolean

Whether one commission applies to every product on the campaign

Example:true
secondTierCommissionTypestring

Second tier commission type

Available optionsflatpercentage
Example:percentage
secondTierCommissionnumber

Second tier commission value

Example:5
calculateSetupFeeboolean

Whether setup fees count towards commission

Example:false
referralPermalinkstring

Referral link slug

Example:summer-launch
referralRealLinkstring

Full referral link

Example:https://example.com/summer-launch
domainstring

Domain the referral link points at

Example:example.com
stepIdstring

Funnel or page step id being tracked

Example:6385d230f6d19db03eef6fb3
subAfLinkstring

Sub affiliate signup link

Example:https://example.com/sub-affiliate-signup
enableSubAffiliateLinkboolean

Whether sub affiliate signup is enabled

Example:false
enableAutoEnrollSubAffiliateboolean

Whether sub affiliates are auto enrolled

Example:true
createdAtstring

Campaign creation timestamp

Example:2026-01-01T00:00:00.000Z
updatedAtstring

Campaign update timestamp

Example:2026-01-02T00:00:00.000Z
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.