| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique ID of the member. |
globally unique identifier |
None. |
| displayName |
Member's display Name |
string |
None. |
| firstName |
First name |
string |
None. |
| lastName |
Last Name |
string |
None. |
|
Email Address |
string |
None. |
|
| phone |
Phone |
string |
None. |
| externalIdentifier |
An alternative ID provided to help link the member to relevant data in external systems. |
string |
None. |
| dateOfBirth | date |
None. |
|
| addressLine1 | string |
None. |
|
| addressLine2 | string |
None. |
|
| city | string |
None. |
|
| countrySubdivision |
A subdivision of a country, such as a state or province. |
string |
None. |
| country | string |
None. |
|
| postalCode | string |
None. |
|
| disabledFlag |
This flag is set if the member is NOT enabled for use in referral programs. |
boolean |
None. |
| disabledReason |
If the member is disabled, this field will hold the reason why |
string |
None. |
| customOverrideURL |
Custom Override URL. |
string |
None. |
| payoutInfo | MemberPayoutInfo |
None. |
|
| customOption1Name |
Custom Option 1 Name |
string |
None. |
| customOption1Value |
Custom Option 1 Value |
string |
None. |
| customText1Name |
Custom Text 1 Name |
string |
None. |
| customText1Value |
Custom Text 1 Value |
string |
None. |
| customText2Name |
Custom Text 2 Name |
string |
None. |
| customText2Value |
Custom Text 2 Value |
string |
None. |
| programId |
The referral program that the member is a part of. |
globally unique identifier |
None. |
| programTitle | string |
None. |
|
| programName | string |
None. |
|
| referralCode |
A unique code set up to identify shares from a particular member. |
string |
None. |
| referralUrl |
A unique link set up to help a member share referrals. |
string |
None. |
| memberUrl |
[DEPRECATED] (Please use the memberaccessurls endpoint instead: https://api.referralrock.com/Help/Api/POST-api-memberaccessurls) A unique link set up to help a member manage their activity in the referral program. |
string |
None. |
| emailShares |
A count of shares of the referral program from the member via email. |
integer |
None. |
| socialShares |
A count of shares of the referral program from the member via social media. |
integer |
None. |
| views |
A count of views of the referral program from shares by the member. |
integer |
None. |
| referrals |
A count of referrals from the member. |
integer |
None. |
| lastShare |
the datetime of the last share from the member. |
date |
None. |
| referralsApproved |
A count of approved referrals from the member. |
integer |
None. |
| referralsQualified |
A count of qualified referrals from the member. |
integer |
None. |
| referralsPending |
A count of pending referrals from the member. |
integer |
None. |
| referralsApprovedAmount |
The approved referrals total amount the member. |
decimal number |
None. |
| rewardsPendingAmount |
The amount of pending rewards for the member. |
decimal number |
None. |
| rewardsIssuedAmount |
The amount of issued rewards for the member. |
decimal number |
None. |
| rewardAmountTotal |
The total amount of rewards for the member. |
decimal number |
None. |
| rewards |
A count of rewards from the member. |
integer |
None. |
| createDt |
the datetime of the last share from the member. |
date |
None. |
| utmSource | string |
None. |
|
| utmMedium | string |
None. |
|
| utmCampaign | string |
None. |
|
| browserReferrerUrl | string |
None. |
|
| lastViewIPAddress | string |
None. |
|
| firstMemberShareDate | date |
None. |
|
| firstMemberViewDate | date |
None. |
|
| firstReferralViewDate | date |
None. |
|
| lastReferralAddDate | date |
None. |
|
| firstReferralAddDate | date |
None. |
|
| lastMemberRewardAddDate | date |
None. |
|
| firstMemberRewardAddDate | date |
None. |
|
| activatedDate | date |
None. |
|
| lastActiveDate | date |
None. |
|
| status | string |
None. |