GET
/
api
/
referral
/
users
import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const users = await client.referral.users.list({ walletAddress: 'string' });

  console.log(users.data);
}

main();
{
  "data": [
    {
      "referralCode": {
        "referralCode": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "userId": "<string>",
        "tier1Amount": 123,
        "tier2Amount": 123,
        "amount": 123
      },
      "user": {
        "id": "<string>",
        "walletAddress": "<string>"
      },
      "id": "<string>"
    }
  ],
  "hasNextPage": true
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

organizationId
string
websiteId
string
walletAddress
required
limit
integer
Required range: 1 <= x <= 1000
startingAfter
string
includeEligibility
boolean | null
default:false
loyaltyRuleId
string

Response

200
application/json
200
data
object[]
required
hasNextPage
boolean
required