Referrals and Invites
List participant referrals and invites
Retrieves referrals and email invites made by a participant.
get/campaign/{id}/participant/{participantIdOrEmail}/referrals
Request
- Base URLhttps://api.growsurf.com/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
GrowSurf program ID.
participantIdOrEmailstring required
GrowSurf participant ID or URL-encoded participant email address.
Query parameters
sortBy'updatedAt' | 'createdAt' | 'email' | 'firstName' | 'lastName' | 'referralStatus' | 'referralTriggeredAt'
Field used to sort referral results.
descboolean
Return results in descending order when true.
limitinteger
Number of results to return. Maximum 100.
offsetinteger
Offset number used to skip through a result set.
emailstring
URL-encoded email value to filter referral results.
firstNamestring
First name value to filter results.
lastNamestring
Last name value to filter results.
referralStatus'CREDIT_PENDING' | 'CREDIT_AWARDED' | 'CREDIT_EXPIRED' | 'INVITE_SENT'
Referral status to filter results.
nextIdstring
ID to start the next paged result set with.
Response
Participant referrals and invites returned.
Changes
No recorded changes to this operation across all 7 revisions of this API.