Structure

Below is a list of all the fields related to the rewards you have due.

Attributes


id integer
Unique identifier for the due reward.


campaign_id integer
Unique identifier for the campaign of due reward.


can_be_issued boolean
Shows if reward can be issued or not.


count integer
Shows number of rewards are due in current line.


value string
Shows user friendly total value eg: $50.


total integer
Shows value of rewards are due in current line.


due_at date
Shows date when reward becomes due in current line.


details associative array
Shows extra details about current reward.

details . name string
Name of reward you set up during reward creation.


details . metric string
Shows metric of rewards, possible values: amount|commission|custom.


details . reward_for string
Shows who will be recipient, possible values: referrer|lead.


details . method string
Shows method how will reward will be issued, possible values: tremendous|stripe|paypal|webhook|zapier|make|n8n|manual.


details . value string
Shows user friendly value for single reward, eg: $50.


details . currency string
Shows currency for current reward, present only when metric is amount|commission.



details . amount number
Shows amount of value for current reward, present only when metric is amount.



details . commission integer
Shows commision percent for current reward, present only when metric is commission.



details . commission_cap number
Shows commision cap for current reward, present only when metric is commission.



details . metric_amount integer
Shows metric amount for current reward, present only when metric is commission.



details . metric_name string
Shows metric name for current reward, present only when metric is commission.


recipient associative array
Shows details of recipient for current reward.

recipient . id integer
Shows unique identifier of the user which will get the reward.


recipient . first_name string
Shows name of the user which will get the reward.


recipient . email string
Shows email of the user which will get the reward.


leads array
Details about each lead whose action triggered reward.

📘

This array present only when reward created for referrer

leads . * . id integer
Unique identifier of the lead.


leads . * . first_name string
First name of the lead.


leads . * . email string
Email of the lead.


leads . * . qualified_at date
Qualification date of the lead.