Below is a list of all the fields related to referrers is Referral Factory.
Attributes
id integer
Unique identifier for the user.
campaign_id integer
The unique identifier of campaign of the current user.
first_name string
The first name of the current user.
email string
The email address for the current user.
code string
The unique code of the current user.
source enum
Shows the source of the user. Possible values could be:Direct, Api, Added, Widget, Popup, Sticky Bar, Zapier, Make.com, N8n, Test.
ip string
Shows IP address where user joined from.
signed_up_at date
Shows when user joins campaign.
unsubscribed_at nullable date
Shows date when user unsubscribed from email notifications. If user still subscribed then property value will be null.
extra_fields array
Details about each extra property of referrer.
extra_fields . * . field
string
Campaign field label which referrer filled when joined campaign.
extra_fields . * . value
mixed
Value of current field which referrer filled when joined campaign.
links associative array
Referral, sharing, submission form, and QR code links.
links . referral_link
string
The participant's unique referral link.
links . submission_form_link
string
Link to the referral submission form.
links . sharing
associative array
Sharing links and message details.
links . sharing . socials
array of associative arrays
Social networks through which the referral link can be shared.
links . sharing . socials . * . social
enum
Social network where the referral link can be shared. Possible values:
email
,
twitter
,
facebook
,
telegram
,
whatsapp
,
messenger
links . sharing . socials . * . url
string
URL that opens the sharing action for the selected social network.
links . sharing . subject
string or null
Subject of the sharing message. Used for email sharing.
links . sharing . text
string or null
Message applied when the referral link is shared.
links . qr
associative array
QR code links for the participant's referral link.
links . qr . src
string
URL of the generated QR code image.
links . qr . download
string
URL for downloading the generated QR code.
promotion array
Promo code properties including sharing
promotion . code
string
Unique promotion code for current user. (Only if stripe connected)
promotion . sharing
associative array
Sharing links and message details.
promotion . sharing . socials
array of associative arrays
Details about each supported sharing channel.
promotion . sharing . socials . * . social
enum
Sharing channel. Possible values:
sms
,
email
promotion . sharing . socials . * . url
string
URL that opens the sharing action for the selected channel.
promotion . sharing . subject
string
Subject of the sharing message. Used only for email sharing. May be an empty string.
promotion . sharing . text
string
Message that will be included when sharing. May be an empty string.
analytics associative array
analytics . reach
integer
Shows number of total unique reaches of current user.
analytics . referrals
integer
Shows number of total referrals of current user.
analytics . qualified_referrals
integer
Shows number of total qualified referrals of current user.