CampaignsVersion: v3

List Campaigns

GET/affiliate-manager/{locationId}/campaigns

Retrieve the list of affiliate campaigns 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

Query Parameters

querystring

Filter campaigns whose name contains this text

Example:Summer launch

skipnumber

Number of campaigns to skip

Possible values: >= 0

Default:0

Example:0

limitnumber

Number of campaigns to return, maximum 100

Possible values: >= 1 and <= 100

Default:10

Example:10

onlyActiveLiveModeboolean

Return only campaigns in live mode

Default:false

Example:false

trackTypesstring[]

Comma separated track types

Available optionsformssurveyscalendersfunnelswebsitesstoreexternal_sourcecommunity

Example:["funnels","websites"]

Response

application/json

Successful response

campaignsobject[]required

Campaigns for the location

campaigns[]._idstringrequired

Campaign id

Example:6385d230f6d19db03eef6fb2

campaigns[].locationIdstringrequired

Location id the campaign belongs to

Example:ve9EPM428h8vShlRW1KT

campaigns[].namestringrequired

Campaign name

Example:Summer launch

campaigns[].descriptionstring

Campaign description

Example:Affiliate campaign for the summer launch

campaigns[].trackTypestring

What the campaign tracks

Available optionsformssurveyscalendersfunnelswebsitesstoreexternal_sourcecommunity

Example:funnels

campaigns[].subTrackTypestring

Sub track type

Available optionsleadproductdonation

Example:product

campaigns[].liveModebooleanrequired

Whether the campaign is live

Example:true

campaigns[].currencystring

Campaign currency

Example:USD

campaigns[].payoutFrequencystring

How often affiliates are paid out

Available optionsPAY_7PAY_15PAY_30PAY_45PAY_60PAY_90

Example:PAY_30

campaigns[].cookieLifenumberrequired

Referral cookie lifetime in days

Example:30

campaigns[].commissionTypestring

First tier commission type

Available optionsflatpercentage

Example:percentage

campaigns[].commissionnumber

First tier commission value

Example:10

campaigns[].commissionTiernumber

Number of commission tiers

Example:1

campaigns[].leadCommissionTiernumber

Number of lead commission tiers

Example:1

campaigns[].isGlobalCommissionboolean

Whether one commission applies to every product on the campaign

Example:true

campaigns[].secondTierCommissionTypestring

Second tier commission type

Available optionsflatpercentage

Example:percentage

campaigns[].secondTierCommissionnumber

Second tier commission value

Example:5

campaigns[].calculateSetupFeeboolean

Whether setup fees count towards commission

Example:false

campaigns[].referralPermalinkstring

Referral link slug

Example:summer-launch

campaigns[].referralRealLinkstring

Full referral link

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

campaigns[].domainstring

Domain the referral link points at

Example:example.com

campaigns[].stepIdstring

Funnel or page step id being tracked

Example:6385d230f6d19db03eef6fb3

campaigns[].subAfLinkstring

Sub affiliate signup link

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

campaigns[].enableSubAffiliateLinkboolean

Whether sub affiliate signup is enabled

Example:false

campaigns[].enableAutoEnrollSubAffiliateboolean

Whether sub affiliates are auto enrolled

Example:true

campaigns[].createdAtstring

Campaign creation timestamp

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

campaigns[].updatedAtstring

Campaign update timestamp

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

campaigns[].customernumber

Customers attributed to the campaign

Example:12

campaigns[].leadsnumber

Leads attributed to the campaign

Example:34

campaigns[].droppedOutnumber

Customers who dropped out

Example:2

campaigns[].revenuenumber

Revenue attributed to the campaign

Example:1500

campaigns[].commissionAmountnumber

Commission accrued on the campaign

Example:150

metaobjectrequired

Pagination metadata

List Campaigns

Authorizations

Request​

Headers

Path Parameters

Query Parameters

Response

Request