growsurf_get_participant
Retrieve a single GrowSurf participant by ID or email. Optionally target a specific campaign to get accurate participant data.
Instructions
Fetch a single participant by GrowSurf participant ID or email address. Use growsurf_list_participants first if you need to find a participant ID. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | No | Target program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Pass the `id` returned by growsurf_create_campaign to configure or operate a program you just created, without restarting the server. | |
| participantId | No | ||
| participantEmail | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The participant's unique id. | |
| rank | No | All-time leaderboard rank. | |
| No | The participant's email address. | ||
| isNew | No | `true` when the request created the participant. Returned by participant creation calls. | |
| notes | No | Internal notes. Never shown to participants. | |
| rewards | No | Rewards the participant has earned. | |
| isWinner | No | `true` once the participant has earned at least one reward. | |
| lastName | No | The participant's last name. | |
| metadata | No | Custom key/value metadata (single level). | |
| referrer | No | Summary of the participant's referrer (same core fields as a participant). Present only when the participant was referred. | |
| shareUrl | No | The participant's unique referral link. Omitted for affiliate program participants who are not approved affiliates. | |
| createdAt | No | When the participant joined, as a Unix timestamp in milliseconds. | |
| firstName | No | The participant's first name. | |
| ipAddress | No | IP address recorded for the participant, or `null`. | |
| referrals | No | Ids of participants they successfully referred (100 most recent). | |
| referredBy | No | Id of the referrer. Present only when the participant was referred. | |
| shareCount | No | Share counts keyed by channel (e.g. `email`, `facebook`, `twitter`, `copyRefLink`, `iosNativeShare`). | |
| vanityKeys | No | The participant's vanity keys. | |
| fingerprint | No | Browser identifier recorded for the participant, or `null`. | |
| inviteCount | No | Invites sent by the participant. | |
| isAffiliate | No | Affiliate programs only. Whether this participant is an enrolled affiliate. A referred customer who has not joined the program is `false`. | |
| monthlyRank | No | Current-month leaderboard rank (resets monthly). | |
| unsubscribed | No | `true` if the participant unsubscribed from program emails. | |
| referralCount | No | All-time referrals credited to the participant. | |
| fraudRiskLevel | No | The participant's fraud risk level. | |
| payoutSettings | No | Actions the participant must complete before a payout can be released. Always present. | |
| referralSource | No | How the participant joined the program. | |
| referralStatus | No | The referrer's credit status for this participant. Present only when the participant was referred. | |
| affiliateStatus | No | Affiliate programs only. The enrolled affiliate's status (`APPROVED`, `SUSPENDED`, or `BANNED`). `null` for participants who are not affiliates. | |
| fraudReasonCode | No | Reason code behind `fraudRiskLevel` (e.g. `UNIQUE_IDENTITY`, `DUPLICATE_EMAIL`, `MANUAL_UPDATE`). | |
| impressionCount | No | Total views of the participant's referral link. | |
| prevMonthlyRank | No | Previous-month leaderboard rank. | |
| mobileInstanceId | No | App-install scoped identifier supplied by a native app, or `null`. | |
| monthlyReferrals | No | Ids of participants they successfully referred this month (100 most recent). | |
| paypalEmailAddress | No | PayPal email address on file, used for affiliate or PayPal reward payouts. | |
| unreadPayoutsCount | No | Payouts the participant has not yet viewed. Affiliate programs only. | |
| monthlyReferralCount | No | Referrals credited this month (resets monthly). | |
| allMatchingFraudsters | No | Other participants flagged as matching this participant during anti-fraud checks. | |
| uniqueImpressionCount | No | Unique views of the participant's referral link. | |
| unreadCommissionsCount | No | Commissions the participant has not yet viewed. Affiliate programs only. | |
| prevMonthlyReferralCount | No | Referrals credited the previous month. | |
| affiliateEnrollmentSource | No | Affiliate programs only. How the affiliate enrolled (`OPEN_ENROLLMENT`, `APPLICATION`, `PARTICIPANT_AUTH`, `INVITE`, `REST_API`, `CSV`, or `DASHBOARD`). `null` when not recorded. |