Attributes

id integer
Unique identifier for the user.

campaign_id integer
The unique identifier of campaign of the current user.

referrer_id integer
The unique identifier of referrer of the current user.

code string
The unique code of the current user.

url string
The unique join link for the current user.

qr array
The qr image src and download urls.

qr . src string
QR code of referral link source url.

qr . download string
QR code of referral link download url.

first_name string
The first name of the current user.

email string
The email address for the current user.

reach string
The reach of the current user (how many people it’s reached)

source enum
Shows the source of the user. Possible values could be:
Direct, Referred, Api, Added, Zapier, Widget, Popup, Embed, Test.

type enum
Shows the type of the user. Possible values could be: person_referring, person_invited.

ip string
Shows IP address where user joined from.

signed_up_at date
Shows when user joins campaign.

qualified_at nullable date
Shows date when user qualified. If user not qualified property value will be null.

unsubscribed_at nullable date
Shows date when user unsubscribed from email notifications. If user still subscribed then property value will be null.

meta array

Details about each meta object.

meta . * . field string
Campaign field label which user filled when joined campaign.

meta . * . value mixed
Value of current field which user filled when joined campaign.

sharing associative array

Shows extra fields added in campaign.

sharing . socials array of associative arrays
Details about each object.

sharing . socials . * . social enum
Social where link can be shared. Possible values could be: sms, lineme, email, wechat, twitter, facebook, linkedin, telegram, whatsapp, messenger

sharing . socials . * . url string
URL which will share user's link in current social.

sharing . subject string
Subject for sharing message, useful only for email sharing.

sharing . text string
Sharing message which will be applied to shared link.

analytics associative array

🚧
This property will be in response only if you have with=user.analytics parameter in request.

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.