rewardful_list_campaigns
List campaigns
List the affiliate program's campaigns with their reward rules (percent or fixed commission, payout minimum, referral expiry) and totals (visitors, leads, conversions, affiliates). Rewardful: GET /v1/campaigns.
Parameterspagelimit
rewardful_get_campaign
Get one campaign
Fetch a single campaign by id. Rewardful: GET /v1/campaigns/:id.
Parameterscampaign_idrequired
rewardful_list_affiliates
List affiliates
List affiliates, newest first, with visitors/leads/conversions. Filter by campaign, or look one up by email or Stripe customer id (returns zero or one). Expand campaign, links or commission_stats for more detail. Rewardful: GET /v1/affiliates.
Parameterspageemaillimitexpandcampaign_idstripe_customer_id
rewardful_get_affiliate
Get one affiliate
Fetch a single affiliate by id, including their campaign, links, coupon and visitor/lead/conversion counts. Rewardful: GET /v1/affiliates/:id.
Parametersaffiliate_idrequired
rewardful_list_affiliate_links
List affiliate links
List affiliate links (URL, token, visitors, leads, conversions, affiliate_id), newest first. Rewardful: GET /v1/affiliate_links.
Parameterspagelimit
rewardful_get_affiliate_link
Get one affiliate link
Fetch a single affiliate link by id. Rewardful: GET /v1/affiliate_links/:id.
Parameterslink_idrequired
rewardful_list_affiliate_coupons
List affiliate coupons
List affiliate coupon / promotion codes (token, Stripe id, leads, conversions, archived), optionally for one affiliate. Rewardful: GET /v1/affiliate_coupons.
Parameterspagelimitaffiliate_id
rewardful_get_affiliate_coupon
Get one affiliate coupon
Fetch a single affiliate coupon by id. Rewardful: GET /v1/affiliate_coupons/:id.
Parameterscoupon_idrequired
rewardful_list_referrals
List referrals
List referrals — visitors who arrived via an affiliate link — newest first, with their conversion state (visitor, lead, conversion), customer and link. Filter by affiliate, state, email, Stripe customer or an updated-at window. Rewardful: GET /v1/referrals.
Parameterspageemaillimitexpandaffiliate_idupdated_sinceupdated_untilconversion_statestripe_customer_id
rewardful_list_commissions
List commissions
List commissions (rewards owed for referred customers' payments) newest first, with amount in cents, currency and state (pending, due, paid, voided). Filter by affiliate or state; expand the sale (with referral, customer and affiliate) or campaign. Rewardful: GET /v1/commissions.
Parameterspagelimitstateexpandaffiliate_id
rewardful_get_commission
Get one commission
Fetch a single commission by id, with its campaign and the sale (charge, refund and tax amounts, referral, customer, affiliate) that earned it. Rewardful: GET /v1/commissions/:id.
Parameterscommission_idrequired
rewardful_list_payouts
List payouts
List payouts — bundles of an affiliate's payable commissions — newest first, with amount, currency and state (pending, due, processing, paid). Filter by affiliate or state; expand affiliate or commissions. Rewardful: GET /v1/payouts.
Parameterspagelimitstateexpandaffiliate_id
rewardful_get_payout
Get one payout
Fetch a single payout by id, with the affiliate and the commissions it bundles. Rewardful: GET /v1/payouts/:id.
Parameterspayout_idrequired
rewardful_create_campaign
Create a campaign
Create a new affiliate campaign with its reward rule. For reward_type percent pass commission_percent; for amount pass commission_amount_cents and commission_amount_currency. Rewardful: POST /v1/campaigns.
Parametersurlrequirednamerequiredprivatereward_typerequiredstripe_coupon_idcommission_percentminimum_payout_centscommission_amount_centscommission_amount_currency
rewardful_update_campaign
Update a campaign
Change a campaign's name, URL, visibility, reward rule, payout minimum or coupon. Only the fields you pass change. Rewardful: PUT /v1/campaigns/:id.
Parametersurlnameprivatecampaign_idrequiredreward_typestripe_coupon_idcommission_percentminimum_payout_centscommission_amount_centscommission_amount_currency
rewardful_create_affiliate
Create an affiliate
Add an affiliate (or a customer referrer, by passing stripe_customer_id). Rewardful sends NO welcome email for API-created affiliates. Rewardful: POST /v1/affiliates.
Parametersemailrequiredstatetokenlast_namerequiredfirst_namerequiredwise_emailcampaign_idpaypal_emailstripe_customer_idreceive_new_commission_notifications
rewardful_update_affiliate
Update an affiliate
Change an affiliate's name, email, payout emails, notifications, campaign (moves them) or state. Setting state to disabled stops tracking and earning; set it back to active to undo. Rewardful: PUT /v1/affiliates/:id.
Parametersemailstatelast_namefirst_namewise_emailcampaign_idaffiliate_idrequiredpaypal_emailstripe_customer_idreceive_new_commission_notifications
rewardful_create_affiliate_link
Create an affiliate link
Give an affiliate an additional tracking link. A token is generated if omitted. Growth/Enterprise plans only. Rewardful: POST /v1/affiliate_links.
Parameterstokenaffiliate_idrequired
rewardful_update_affiliate_link
Change an affiliate link's token
Change the token of an existing affiliate link. WARNING: the old token stops tracking immediately — links already shared with it break. Prefer rewardful_create_affiliate_link to add a second token. Rewardful: PUT /v1/affiliate_links/:id.
Parameterstokenrequiredlink_idrequired
rewardful_create_affiliate_coupon
Create an affiliate coupon
Assign a coupon / promotion code to an affiliate so sales using it are credited to them. The code must match one defined in Stripe, and the affiliate's campaign must have a campaign coupon set in the dashboard. Rewardful: POST /v1/affiliate_coupons.
Parameterstokenrequiredaffiliate_idrequired