Referrals
Get referrals
API Documentation
Identity
- POSTCreate user device
- GETGet user metadata
- POSTCreate user metadata
- GETGet users
- GETUser count
- POSTConnect a user to User Group
- POSTDisconnect a user from User Group
- GETConnect Auth
- POSTPost apiusersverify
- GETGet all website user attributes
- POSTCreate a new website user attribute
- DELDelete a website user attribute
- GETGet all website user attribute values
- POSTCreate a new website user attribute value
Loyalty
- GETGet loyalty accounts
- GETGet the rank of a user based on their loyalty points
- GETGet loyalty currencies
- POSTCreate a loyalty currency
- GETGet Loyalty Multipliers
- POSTCreate Loyalty Multiplier
- DELDelete Loyalty Multiplier by External Identifier
- POSTUpdate Loyalty Multiplier
- DELDelete Loyalty Multiplier by ID
- GETGet Loyalty Rule Edits
- POSTRestore Loyalty Rule Edit
- GETGet Loyalty Rule Groups
- POSTCreate Loyalty Rule Groups
- POSTUpdate Loyalty Rule Group
- DELDelete Loyalty Rule Group
- GETGet Loyalty Rules
- POSTCreate Loyalty Rule
- POSTUpdate Loyalty Rule
- DELDelete Loyalty Rule
- POSTComplete Loyalty Rule
- GETGet Processing status for a specific user on loyalty rules
- POSTCreate Loyalty Transaction
- GETGet Loyalty Transaction Entries
- GETGet Loyalty Rule Chains
- GETGet Loyalty Rule Statuses
- POSTUpdate Loyalty Rule Status
Badge
Minting
Question
Website
Landing Page
Referrals
Get referrals
This endpoint allows you to get referrals
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
Query Parameters
Required range:
1 <= x <= 1000
Response
200
application/json
200
This will only return data for earnings after 2025-04-24
This will only return data for earnings after 2025-04-24
This will only return data for earnings after 2025-04-24
Was this page helpful?
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
}