H!HOPPA
GET/api/v2/referrals/programs/{programId}/members/{userId}/report

What one partner produced: counts, volume, rewards and pseudonymised friends.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
programId (path)string (uuid)Yes
userId (path)integer (int32)Yes

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
UserIdunknownYes
NamestringYes
AttributedunknownYes
QualifiedunknownYes
EarningunknownYes
EligibleVolumeunknownYes
RewardsPendingunknownYes
RewardsPaidunknownYes
CurrencystringYes
Friendsarray of ReferralFriendResponseYes

Example request

curl -X GET "https://{base_url}/api/v2/referrals/programs/{programId}/members/{userId}/report" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.