Skip to main content
GET
/
api
/
referral
/
users
Get referrals
curl --request GET \
  --url https://admin.snagsolutions.io/api/referral/users \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "referralCode": {
        "id": "<string>",
        "referralCode": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "userId": "<string>",
        "loyaltyRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "user": {
        "id": "<string>",
        "walletAddress": "<string>"
      },
      "id": "<string>",
      "tier1Amount": 123,
      "tier2Amount": 123,
      "amount": 123,
      "eligible": true
    }
  ],
  "hasNextPage": true
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

organizationId
string<uuid>
websiteId
string<uuid>
walletAddress
limit
integer
Required range: 1 <= x <= 1000
startingAfter
string<uuid>
loyaltyRuleId
string<uuid>

Response

200

data
object[]
required
hasNextPage
boolean
required