useLoyalty
Api reference

Get Referral Statistics

Get a member's referral program data including their code and stats

GET/referrals/stats/{externalId}

Get a member's referral program data including their code and stats

AuthorizationBearer <token>

Use your private API key (sk_xxx) as the bearer token

In: header

Path Parameters

externalId*string

Response Body

application/json

curl -X GET "https://app.useloyalty.app/api/v1/referrals/stats/string"
{
  "referralCode": "string",
  "shareLink": "string",
  "stats": {
    "totalReferrals": 0,
    "pendingReferrals": 0,
    "convertedReferrals": 0,
    "totalPointsEarned": 0
  },
  "rewards": {},
  "limits": {}
}