Promoter Campaigns
Get available promoter campaigns
API Documentation
Tracking Api
Referrals
Promoters
Promoter Campaigns
Commissions
Promo Codes
Payouts
Promoter Campaigns
Get available promoter campaigns
With this endpoint you can list all promoter campaigns.
HTTP Request
GET https://v2.firstpromoter.com/api/v2/company/promoter_campaigns
GET
/
promoter_campaigns
curl --request GET \
--url https://v2.firstpromoter.com/api/v2/company/promoter_campaigns \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>'
[
{
"id": 123,
"campaign_id": 123,
"promoter_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"promoter": {
"id": 123,
"email": "<string>",
"name": "<string>"
},
"campaign": {
"id": 123,
"name": "<string>",
"color": "<string>"
},
"state": "pending",
"stats": {
"clicks_count": 123,
"referrals_count": 123,
"sales_count": 123,
"customers_count": 123,
"revenue_amount": 123
},
"coupon": "<string>",
"display_coupon": "<string>",
"ref_token": "<string>",
"ref_link": "<string>",
"is_customized": true,
"direct_url": "<string>",
"referral_rewards_customized": true,
"promoter_rewards_customized": true,
"rewards_for_promoters": [
{
"apply_on": "<string>",
"product_ids": [
123
],
"reward_id": 123,
"reward": {
"name": "<string>",
"promoter_reward_type": "<string>",
"hide_reward": true,
"tier_level": 123,
"coupon": "<string>"
},
"products": [
{
"id": 123,
"name": "<string>"
}
]
}
],
"rewards_for_referrals": [
{
"apply_on": "<string>",
"product_ids": [
123
],
"reward_id": 123,
"reward": {
"name": "<string>",
"promoter_reward_type": "<string>",
"hide_reward": true,
"tier_level": 123,
"coupon": "<string>"
},
"products": [
{
"id": 123,
"name": "<string>"
}
]
}
],
"promo_codes": [
"<string>"
]
}
]
Authorizations
Access token passed as a Bearer token in the Authorization header
Headers
Account identifier that specifies which account is making the request
Example:
"acc_123456"
Response
200
application/json
List of promoter campaigns
The response is of type object[]
.
curl --request GET \
--url https://v2.firstpromoter.com/api/v2/company/promoter_campaigns \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>'
[
{
"id": 123,
"campaign_id": 123,
"promoter_id": 123,
"created_at": "2023-11-07T05:31:56Z",
"promoter": {
"id": 123,
"email": "<string>",
"name": "<string>"
},
"campaign": {
"id": 123,
"name": "<string>",
"color": "<string>"
},
"state": "pending",
"stats": {
"clicks_count": 123,
"referrals_count": 123,
"sales_count": 123,
"customers_count": 123,
"revenue_amount": 123
},
"coupon": "<string>",
"display_coupon": "<string>",
"ref_token": "<string>",
"ref_link": "<string>",
"is_customized": true,
"direct_url": "<string>",
"referral_rewards_customized": true,
"promoter_rewards_customized": true,
"rewards_for_promoters": [
{
"apply_on": "<string>",
"product_ids": [
123
],
"reward_id": 123,
"reward": {
"name": "<string>",
"promoter_reward_type": "<string>",
"hide_reward": true,
"tier_level": 123,
"coupon": "<string>"
},
"products": [
{
"id": 123,
"name": "<string>"
}
]
}
],
"rewards_for_referrals": [
{
"apply_on": "<string>",
"product_ids": [
123
],
"reward_id": 123,
"reward": {
"name": "<string>",
"promoter_reward_type": "<string>",
"hide_reward": true,
"tier_level": 123,
"coupon": "<string>"
},
"products": [
{
"id": 123,
"name": "<string>"
}
]
}
],
"promo_codes": [
"<string>"
]
}
]