Snag Docs logo

Get referrals

This endpoint allows you to get referrals

GEThttps://admin.snagsolutions.io/api/referral/users
Loading code example
Loading code example

Authorizations

apiKeyAuthstringheaderrequired

API key passed in the header.

Query Parameters

organizationIdstring<uuid>
websiteIdstring<uuid>
walletAddressany
limitinteger
Required range: x >= 1, x <= 1000
startingAfterstring<uuid>
loyaltyRuleIdstring<uuid>

Response

application/json

200

dataarray<object>required
data.referralCodeobjectrequired
data.userobjectrequired
data.eligibleboolean
data.idstringrequired
data.tier1Amountnumberrequired

This will only return data for earnings after 2025-04-24

data.tier2Amountnumberrequired

This will only return data for earnings after 2025-04-24

data.amountnumberrequired

This will only return data for earnings after 2025-04-24

hasNextPagebooleanrequired

GET /api/referral/users — query parameters: organizationId, websiteId, walletAddress, limit, startingAfter, loyaltyRuleId