Get Loyalty Rule Groups
curl --request GET \
--url https://admin.snagsolutions.io/api/loyalty/rule_groups \
--header 'X-API-KEY: <api-key>'import requests
url = "https://admin.snagsolutions.io/api/loyalty/rule_groups"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://admin.snagsolutions.io/api/loyalty/rule_groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://admin.snagsolutions.io/api/loyalty/rule_groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://admin.snagsolutions.io/api/loyalty/rule_groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://admin.snagsolutions.io/api/loyalty/rule_groups")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://admin.snagsolutions.io/api/loyalty/rule_groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"isRequired": true,
"sortId": 123,
"isCollapsible": true,
"subTitle": "<string>",
"loyaltyGroupItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortId": 123,
"loyaltyRule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"isRequired": true,
"deletedAt": "2023-11-07T05:31:56Z",
"loyaltyCurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Bonus",
"amount": 123,
"hideInUi": true,
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"rewardType": "points",
"frequency": "none",
"metadata": {
"isCheckInOnEveryTxn": true,
"hasPaidFullRoyalty": false,
"royaltyAddress": "0x1234567890abcdef1234567890abcdef12345678",
"royaltyPercentage": 5,
"hasVerifiedTwitter": true,
"onlyRewardExistingUser": true,
"hasNeverSold": false,
"onlyNative": true,
"hasFillSource": true,
"fillSource": "opensea.io",
"liquidity": {
"network": "mainnet",
"protocol": "Uniswap V2",
"onlyRewardInRangeLiquidity": true,
"liquidityPerDay": 1000,
"customFunction": "x = y * 1000",
"calculationType": "fixed",
"pools": [
{
"id": "0xabcdefabcdefabcdefabcdefabcdefabcdef"
}
]
},
"twitterUsername": "@example_user",
"twitterUserId": "1234567890",
"twitterHashtag": "#loyalty",
"enableVerifiedMultiplier": true,
"verifiedMultiplier": 1.5,
"isMultiplierApplied": true,
"onlyKnownUsers": false,
"firstReferralReward": 10,
"referrerReward": 50,
"referrerRewardLoyaltyCurrencyId": "1234567890",
"secondReferralReward": 5,
"enableStreaks": true,
"promoCode": "PROMO123",
"promoCodeType": "code",
"promoCodeLength": 10,
"promoCodeCsvUrl": "https://example.com/promo_codes.csv",
"enableJoinDiscordServers": true,
"discordServersToJoin": [
{
"id": "123456789012345678",
"channels": [
{
"id": "987654321098765432",
"text": "Hello",
"emojis": [
{
"id": "1f600"
}
]
}
],
"roles": [
{
"id": "role123"
}
]
}
],
"streakArray": [
{
"streakMilestone": 5,
"streakAmount": 10
}
],
"dripQuestsToComplete": [
{
"id": "drip123"
}
],
"collection": [
{
"address": "0xabcdefabcdefabcdefabcdefabcdefabcdef",
"network": "mainnet",
"multiplier": 2
}
],
"range": [
{
"startRange": 1,
"endRange": 10,
"amount": 5,
"loyaltyBadgeId": "badge123",
"loyaltyMultiplierAmount": 1.5
}
],
"customRewardsApiKey": "api-key-1234",
"link": "https://example.com",
"socialPlatform": "X(Twitter)",
"socialPlatformName": "Twitter",
"socialPlatformLogo": "https://example.com/logo.png",
"rewardPerImpression": true,
"snapshotProposals": [
{
"id": "proposal123",
"space": "space123"
}
],
"cta": {
"label": "Click Here",
"href": "https://example.com"
},
"hasSaleCurrency": false,
"isTokenHoldMultiplier": true,
"saleCurrency": "USD",
"isRetroactive": true,
"timeDelayToVerifySeconds": 300,
"referralRequirements": {
"points": {
"amount": 50,
"loyaltyCurrecyId": "currency123"
},
"achievePoints": true,
"completeProfile": false,
"connectTwitter": true,
"connectDiscord": true,
"connectEmail": true
},
"multiplierLoyaltyCurrencyIds": [
"currency123",
"currency456"
],
"verifyPlaceHolderText": "Enter your verification code here.",
"verificationTextMinimumLength": 10,
"buttonText": "Verify Now",
"telegramChannelId": "telegram-channel-123",
"twitterAccountUrl": "https://twitter.com/example_user",
"twitterPostUrl": "https://twitter.com/example/status/1234567890",
"checkLike": true,
"checkRepost": true,
"checkComment": true,
"maxLikes": 200,
"maxReposts": 200,
"maxComments": 200,
"reactionStats": {
"likeCount": 123,
"repostCount": 123,
"commentCount": 123,
"syncedAt": "<string>"
},
"checkText": "loyalty",
"requirePostLink": true,
"requirePostMediaLink": true,
"preGeneratedPostText": true,
"rewardCriteria": "IMPRESSIONS_COUNT",
"smartContract": {
"contractId": "123e4567-e89b-12d3-a456-426614174000",
"event": "Transfer",
"type": "event",
"criteria": "everyEvent",
"params": [
{
"name": "value",
"condition": ">=",
"value": "100"
}
],
"addressMapping": "0x123...789",
"amountMultiplier": {
"valueMapping": "amount"
}
},
"walletType": "evm",
"imageUrl": "https://example.com/image.png",
"onlyRewardSingleTokenOwnership": true,
"skipMultiplier": true,
"completeProfileConditions": {
"twitter": true,
"discord": false
},
"steamAppId": "1234567890",
"githubRepoUrl": "https://github.com/owner/repo",
"githubBranchName": "main",
"resetProgressOnClaim": true,
"rewardPerAction": true,
"rewardByBatch": true,
"batchSize": 100,
"youtubeVideoId": "1234567890",
"youtubeChannelId": "1234567890",
"redditPostId": "1234567890",
"isRestrictedToNewUsers": false,
"allowMultipleRedemptions": false,
"rewardBadgePerRange": false,
"swap": {
"provider": "any",
"relayReferrerId": "<string>",
"from": {
"mode": "any",
"chain": 123,
"tokens": [
{
"address": "<string>",
"chainId": "<string>"
}
],
"trackAmount": true
},
"to": {
"mode": "any",
"chain": 123,
"tokens": [
{
"address": "<string>",
"chainId": "<string>"
}
],
"trackAmount": true
},
"requireCrossChainSwap": true
},
"rewardPerValue": false,
"conditionDescription": "Complete the specific task on external platform",
"directRpc": false,
"erc20Type": "erc20",
"rewardQualityPosts": false,
"minimumFollowerCount": 25,
"autoCheckInRuleIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"robinhoodSymbols": [
"<string>"
]
},
"mediaUrl": "<string>",
"loyaltyBadge": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>"
}
}
}
]
}
],
"hasNextPage": true
}"Forbidden, Could not validate api key"Loyalty
Get Loyalty Rule Groups
Retrieve configured loyalty rule groups
GET
/
api
/
loyalty
/
rule_groups
Get Loyalty Rule Groups
curl --request GET \
--url https://admin.snagsolutions.io/api/loyalty/rule_groups \
--header 'X-API-KEY: <api-key>'import requests
url = "https://admin.snagsolutions.io/api/loyalty/rule_groups"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://admin.snagsolutions.io/api/loyalty/rule_groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://admin.snagsolutions.io/api/loyalty/rule_groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://admin.snagsolutions.io/api/loyalty/rule_groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://admin.snagsolutions.io/api/loyalty/rule_groups")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://admin.snagsolutions.io/api/loyalty/rule_groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"isRequired": true,
"sortId": 123,
"isCollapsible": true,
"subTitle": "<string>",
"loyaltyGroupItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortId": 123,
"loyaltyRule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"isRequired": true,
"deletedAt": "2023-11-07T05:31:56Z",
"loyaltyCurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "Bonus",
"amount": 123,
"hideInUi": true,
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"rewardType": "points",
"frequency": "none",
"metadata": {
"isCheckInOnEveryTxn": true,
"hasPaidFullRoyalty": false,
"royaltyAddress": "0x1234567890abcdef1234567890abcdef12345678",
"royaltyPercentage": 5,
"hasVerifiedTwitter": true,
"onlyRewardExistingUser": true,
"hasNeverSold": false,
"onlyNative": true,
"hasFillSource": true,
"fillSource": "opensea.io",
"liquidity": {
"network": "mainnet",
"protocol": "Uniswap V2",
"onlyRewardInRangeLiquidity": true,
"liquidityPerDay": 1000,
"customFunction": "x = y * 1000",
"calculationType": "fixed",
"pools": [
{
"id": "0xabcdefabcdefabcdefabcdefabcdefabcdef"
}
]
},
"twitterUsername": "@example_user",
"twitterUserId": "1234567890",
"twitterHashtag": "#loyalty",
"enableVerifiedMultiplier": true,
"verifiedMultiplier": 1.5,
"isMultiplierApplied": true,
"onlyKnownUsers": false,
"firstReferralReward": 10,
"referrerReward": 50,
"referrerRewardLoyaltyCurrencyId": "1234567890",
"secondReferralReward": 5,
"enableStreaks": true,
"promoCode": "PROMO123",
"promoCodeType": "code",
"promoCodeLength": 10,
"promoCodeCsvUrl": "https://example.com/promo_codes.csv",
"enableJoinDiscordServers": true,
"discordServersToJoin": [
{
"id": "123456789012345678",
"channels": [
{
"id": "987654321098765432",
"text": "Hello",
"emojis": [
{
"id": "1f600"
}
]
}
],
"roles": [
{
"id": "role123"
}
]
}
],
"streakArray": [
{
"streakMilestone": 5,
"streakAmount": 10
}
],
"dripQuestsToComplete": [
{
"id": "drip123"
}
],
"collection": [
{
"address": "0xabcdefabcdefabcdefabcdefabcdefabcdef",
"network": "mainnet",
"multiplier": 2
}
],
"range": [
{
"startRange": 1,
"endRange": 10,
"amount": 5,
"loyaltyBadgeId": "badge123",
"loyaltyMultiplierAmount": 1.5
}
],
"customRewardsApiKey": "api-key-1234",
"link": "https://example.com",
"socialPlatform": "X(Twitter)",
"socialPlatformName": "Twitter",
"socialPlatformLogo": "https://example.com/logo.png",
"rewardPerImpression": true,
"snapshotProposals": [
{
"id": "proposal123",
"space": "space123"
}
],
"cta": {
"label": "Click Here",
"href": "https://example.com"
},
"hasSaleCurrency": false,
"isTokenHoldMultiplier": true,
"saleCurrency": "USD",
"isRetroactive": true,
"timeDelayToVerifySeconds": 300,
"referralRequirements": {
"points": {
"amount": 50,
"loyaltyCurrecyId": "currency123"
},
"achievePoints": true,
"completeProfile": false,
"connectTwitter": true,
"connectDiscord": true,
"connectEmail": true
},
"multiplierLoyaltyCurrencyIds": [
"currency123",
"currency456"
],
"verifyPlaceHolderText": "Enter your verification code here.",
"verificationTextMinimumLength": 10,
"buttonText": "Verify Now",
"telegramChannelId": "telegram-channel-123",
"twitterAccountUrl": "https://twitter.com/example_user",
"twitterPostUrl": "https://twitter.com/example/status/1234567890",
"checkLike": true,
"checkRepost": true,
"checkComment": true,
"maxLikes": 200,
"maxReposts": 200,
"maxComments": 200,
"reactionStats": {
"likeCount": 123,
"repostCount": 123,
"commentCount": 123,
"syncedAt": "<string>"
},
"checkText": "loyalty",
"requirePostLink": true,
"requirePostMediaLink": true,
"preGeneratedPostText": true,
"rewardCriteria": "IMPRESSIONS_COUNT",
"smartContract": {
"contractId": "123e4567-e89b-12d3-a456-426614174000",
"event": "Transfer",
"type": "event",
"criteria": "everyEvent",
"params": [
{
"name": "value",
"condition": ">=",
"value": "100"
}
],
"addressMapping": "0x123...789",
"amountMultiplier": {
"valueMapping": "amount"
}
},
"walletType": "evm",
"imageUrl": "https://example.com/image.png",
"onlyRewardSingleTokenOwnership": true,
"skipMultiplier": true,
"completeProfileConditions": {
"twitter": true,
"discord": false
},
"steamAppId": "1234567890",
"githubRepoUrl": "https://github.com/owner/repo",
"githubBranchName": "main",
"resetProgressOnClaim": true,
"rewardPerAction": true,
"rewardByBatch": true,
"batchSize": 100,
"youtubeVideoId": "1234567890",
"youtubeChannelId": "1234567890",
"redditPostId": "1234567890",
"isRestrictedToNewUsers": false,
"allowMultipleRedemptions": false,
"rewardBadgePerRange": false,
"swap": {
"provider": "any",
"relayReferrerId": "<string>",
"from": {
"mode": "any",
"chain": 123,
"tokens": [
{
"address": "<string>",
"chainId": "<string>"
}
],
"trackAmount": true
},
"to": {
"mode": "any",
"chain": 123,
"tokens": [
{
"address": "<string>",
"chainId": "<string>"
}
],
"trackAmount": true
},
"requireCrossChainSwap": true
},
"rewardPerValue": false,
"conditionDescription": "Complete the specific task on external platform",
"directRpc": false,
"erc20Type": "erc20",
"rewardQualityPosts": false,
"minimumFollowerCount": 25,
"autoCheckInRuleIds": [
"123e4567-e89b-12d3-a456-426614174000"
],
"robinhoodSymbols": [
"<string>"
]
},
"mediaUrl": "<string>",
"loyaltyBadge": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"imageUrl": "<string>"
}
}
}
]
}
],
"hasNextPage": true
}"Forbidden, Could not validate api key"Authorizations
Query Parameters
Required range:
1 <= x <= 1000Was this page helpful?