Get Loyalty Rule Groups

GET

api

loyalty

rule_groups

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 response = await client.loyalty.ruleGroups.getRuleGroups();

  console.log(response.data);
}

main();

{
  "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": {
              "onlyNonListed": true,
              "hasPaidFullRoyalty": false,
              "hasVerifiedTwitter": true,
              "onlyRewardExistingUser": true,
              "hasNeverSold": false,
              "onlyNative": true,
              "hasFillSource": true,
              "fillSource": "opensea.io",
              "hasOrderSource": true,
              "orderSource": "opensea.io",
              "twitterUsername": "@example_user",
              "twitterUserId": "1234567890",
              "twitterHashtag": "#loyalty",
              "enableVerifiedMultiplier": true,
              "verifiedMultiplier": 1.5,
              "isMultiplierApplied": true,
              "onlyKnownUsers": false,
              "firstReferralReward": 10,
              "referrerReward": 50,
              "secondReferralReward": 5,
              "enableStreaks": true,
              "promoCode": "PROMO123",
              "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
                }
              ],
              "customRewardsApiKey": "api-key-1234",
              "link": "https://example.com",
              "socialPlatform": "X(Twitter)",
              "socialPlatformName": "Twitter",
              "socialPlatformLogo": "https://example.com/logo.png",
              "rewardPerImpression": true,
              "minQty": 1,
              "maxQty": 10,
              "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,
              "checkText": "loyalty",
              "smartContract": {
                "contractId": "123e4567-e89b-12d3-a456-426614174000",
                "abi": "[]",
                "event": "Transfer",
                "criteria": "everyEvent",
                "params": [
                  {
                    "name": "value",
                    "condition": ">=",
                    "value": "100"
                  }
                ],
                "withCustomRange": true,
                "customRange": {
                  "startsAt": "2024-01-01T00:00:00Z",
                  "endsAt": "2024-01-31T23:59:59Z"
                },
                "withMax": true,
                "max": 1000,
                "withBonus": true,
                "bonus": [
                  {
                    "amount": 50,
                    "count": 5
                  }
                ],
                "addressMapping": "0x123...789"
              },
              "walletType": "evm",
              "imageUrl": "https://example.com/image.png",
              "trackAllContracts": true,
              "onlyRewardSingleTokenOwnership": true,
              "skipMultiplier": true,
              "completeProfileConditions": {
                "twitter": true,
                "discord": false
              },
              "steamAppId": "1234567890",
              "trackProgress": true
            },
            "mediaUrl": "<string>"
          }
        }
      ]
    }
  ],
  "hasNextPage": true
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

websiteId

string

organizationId

string

startingAfter

string

limit

integer

Required range: 1 <= x <= 1000

excludeHidden

string

default:true

Response

200

application/json

200

data

object[]

required

Schema for a get loyalty rule groups response

data.id

string

required

data.name

string

required

data.isRequired

boolean

required

data.sortId

number

required

data.isCollapsible

boolean

required

data.subTitle

string | null

required

data.loyaltyGroupItems

object[]

required

data.loyaltyGroupItems.id

string

required

data.loyaltyGroupItems.sortId

number

required

data.loyaltyGroupItems.loyaltyRule

object

required

data.loyaltyGroupItems.loyaltyRule.id

string

required

data.loyaltyGroupItems.loyaltyRule.name

string

required

data.loyaltyGroupItems.loyaltyRule.description

string | null

required

data.loyaltyGroupItems.loyaltyRule.isRequired

boolean

required

data.loyaltyGroupItems.loyaltyRule.deletedAt

string | null

required

data.loyaltyGroupItems.loyaltyRule.loyaltyCurrencyId

string

required

data.loyaltyGroupItems.loyaltyRule.type

enum<string>

required

Available options:

Bonus,

BoughtOn,

BoughtWithRoyalties,

DiscordMessages,

Listing,

Lodging,

MintOn,

PoapClaim,

SnagSocialsConnected,

SnapshotFullset,

SnapshotHold,

SoldOn,

SoldWithRoyalties,

TokenHold,

TwitterBio,

TwitterHashTagPost,

Retweet,

check_in,

code_entry,

connect_wallet,

connected_discord,

connected_email,

connected_epic,

connected_steam,

connected_telegram,

connected_twitter,

create_partner_account,

discord_member,

drip_x_follow,

drip_x_new_tweet,

drip_x_text_in_bio,

drip_x_text_in_comment,

drip_x_text_in_name,

drip_x_tweet,

external_rule,

link_click,

manual_upload,

profile_completed,

referred_user,

smart_contract_event,

snapshot_governance,

telegram_join,

telegram_messages,

text_input,

token_hold_erc20,

tweet_liked_by_project,

twitter_comment,

twitter_follow,

twitter_followers,

twitter_like,

twitter_post_hashtag,

quiz,

poll,

steam_wishlist

data.loyaltyGroupItems.loyaltyRule.amount

number | null

required

data.loyaltyGroupItems.loyaltyRule.hideInUi

boolean

required

data.loyaltyGroupItems.loyaltyRule.startTime

string | null

required

data.loyaltyGroupItems.loyaltyRule.endTime

string | null

required

data.loyaltyGroupItems.loyaltyRule.rewardType

enum<string>

required

Available options:

points,

multiplier

data.loyaltyGroupItems.loyaltyRule.frequency

enum<string> | null

required

Available options:

none,

once,

daily,

weekly,

monthly,

immediately

data.loyaltyGroupItems.loyaltyRule.metadata

object

required

data.loyaltyGroupItems.loyaltyRule.metadata.onlyNonListed

boolean

Flag indicating whether to include only non-listed items.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.hasPaidFullRoyalty

boolean

Indicates if the full royalty has been paid for items.

Example:

false

data.loyaltyGroupItems.loyaltyRule.metadata.hasVerifiedTwitter

boolean

Indicates if the user has a verified Twitter account.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.onlyRewardExistingUser

boolean

Indicates if only existing users are rewarded.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.hasNeverSold

boolean

Indicates if the item has never been sold.

Example:

false

data.loyaltyGroupItems.loyaltyRule.metadata.onlyNative

boolean

Flag indicating whether to include only native tokens.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.hasFillSource

boolean

Flag indicating whether the fill source is included.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.fillSource

string

Fill source of the order for the token sale

Example:

"opensea.io"

data.loyaltyGroupItems.loyaltyRule.metadata.hasOrderSource

boolean

Flag indicating whether the order source is included.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.orderSource

string

Order source of the order for the token sale

Example:

"opensea.io"

data.loyaltyGroupItems.loyaltyRule.metadata.twitterUsername

string

Twitter username of the user.

Example:

"@example_user"

data.loyaltyGroupItems.loyaltyRule.metadata.twitterUserId

string

Unique identifier of the Twitter user.

Example:

"1234567890"

data.loyaltyGroupItems.loyaltyRule.metadata.twitterHashtag

string

Hashtag associated with the Twitter post.

Example:

"#loyalty"

data.loyaltyGroupItems.loyaltyRule.metadata.enableVerifiedMultiplier

boolean

Flag indicating whether the verified multiplier is enabled.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.verifiedMultiplier

number | null

Multiplier applied to rewards for verified users.

Example:

1.5

data.loyaltyGroupItems.loyaltyRule.metadata.isMultiplierApplied

boolean

Indicates if the multiplier has been applied to rewards.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.onlyKnownUsers

boolean

Flag indicating whether to include only known users.

Example:

false

data.loyaltyGroupItems.loyaltyRule.metadata.firstReferralReward

number | null

Percentage reward given to a user for their first referral.

Example:

10

data.loyaltyGroupItems.loyaltyRule.metadata.referrerReward

number | null

Lump sum reward given to a referrer.

Example:

50

data.loyaltyGroupItems.loyaltyRule.metadata.secondReferralReward

number | null

Percentage reward given for a second-level referral.

Example:

5

data.loyaltyGroupItems.loyaltyRule.metadata.enableStreaks

boolean | null

Flag indicating whether streaks are enabled.

Example:

true

Promotional code associated with the rule.

Example:

"PROMO123"

data.loyaltyGroupItems.loyaltyRule.metadata.enableJoinDiscordServers

boolean | null

Flag indicating whether joining Discord servers is required.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.discordServersToJoin

object[] | null

Array of Discord servers, channels, and roles to join.

data.loyaltyGroupItems.loyaltyRule.metadata.streakArray

object[] | null

Array of streak milestones and corresponding rewards.

data.loyaltyGroupItems.loyaltyRule.metadata.dripQuestsToComplete

object[] | null

Array of drip quests required to complete the rule.

data.loyaltyGroupItems.loyaltyRule.metadata.collection

object[]

Array of collections associated with the rule.

data.loyaltyGroupItems.loyaltyRule.metadata.range

object[]

Array defining ranges and corresponding rewards.

data.loyaltyGroupItems.loyaltyRule.metadata.customRewardsApiKey

string

API key for custom rewards integration.

Example:

"api-key-1234"

data.loyaltyGroupItems.loyaltyRule.metadata.link

string | null

Optional link associated with the metadata.

Example:

"https://example.com"

Social media platform associated with the rule.

Available options:

Custom,

Discord,

EpicGames,

Instagram,

Steam,

Telegram,

TikTok,

Twitch,

X(Twitter),

YouTube

Example:

"X(Twitter)"

Name of the social platform.

Example:

"Twitter"

URL of the social platform's logo.

Example:

"https://example.com/logo.png"

data.loyaltyGroupItems.loyaltyRule.metadata.rewardPerImpression

boolean | null

Flag indicating if rewards are given per impression.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.minQty

number | null

Minimum quantity constraint for token holding.

Example:

1

data.loyaltyGroupItems.loyaltyRule.metadata.maxQty

number | null

Maximum quantity constraint for token holding.

Example:

10

data.loyaltyGroupItems.loyaltyRule.metadata.snapshotProposals

object[] | null

Array of snapshot proposals for the rule.

data.loyaltyGroupItems.loyaltyRule.metadata.cta

object | null

Object containing details for the call-to-action.

data.loyaltyGroupItems.loyaltyRule.metadata.hasSaleCurrency

boolean

Flag indicating if the sale currency is included.

Example:

false

data.loyaltyGroupItems.loyaltyRule.metadata.isTokenHoldMultiplier

boolean

default:true

Flag indicating if the token hold multiplier is applied.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.saleCurrency

string

Currency associated with sales.

Example:

"USD"

data.loyaltyGroupItems.loyaltyRule.metadata.isRetroactive

boolean | null

Flag indicating if rewards are applied retroactively.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.timeDelayToVerifySeconds

number

Time delay in seconds to verify actions.

Example:

300

data.loyaltyGroupItems.loyaltyRule.metadata.referralRequirements

object | null

Object defining referral requirements.

data.loyaltyGroupItems.loyaltyRule.metadata.multiplierLoyaltyCurrencyIds

string[] | null

Array of loyalty currency IDs used for multipliers.

Example:

["currency123", "currency456"]

data.loyaltyGroupItems.loyaltyRule.metadata.verifyPlaceHolderText

string | null

Placeholder text for verification input fields.

Example:

"Enter your verification code here."

data.loyaltyGroupItems.loyaltyRule.metadata.verificationTextMinimumLength

integer | null

Minimum length of the verification text.

Example:

10

data.loyaltyGroupItems.loyaltyRule.metadata.buttonText

string | null

Text displayed on the action button.

Example:

"Verify Now"

data.loyaltyGroupItems.loyaltyRule.metadata.telegramChannelId

string | null

ID of the Telegram channel.

Example:

"telegram-channel-123"

data.loyaltyGroupItems.loyaltyRule.metadata.twitterAccountUrl

string

URL of the associated Twitter account.

Example:

"https://twitter.com/example_user"

data.loyaltyGroupItems.loyaltyRule.metadata.twitterPostUrl

string

URL of the associated Twitter post.

Example:

"https://twitter.com/example/status/1234567890"

data.loyaltyGroupItems.loyaltyRule.metadata.checkLike

boolean | null

Flag indicating if liking the post is required.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.checkRepost

boolean | null

Flag indicating if reposting is required.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.checkComment

boolean | null

Flag indicating if commenting is required.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.checkText

string | null

Text to check in the Twitter post, username, or bio.

Example:

"loyalty"

data.loyaltyGroupItems.loyaltyRule.metadata.smartContract

object

Object containing details of the associated smart contract.

data.loyaltyGroupItems.loyaltyRule.metadata.walletType

enum<string> | null

Type of wallet associated with the rule.

Available options:

evm,

solana,

imx,

sui,

ton

Example:

"evm"

data.loyaltyGroupItems.loyaltyRule.metadata.imageUrl

string | null

URL of the image associated with the rule.

Example:

"https://example.com/image.png"

data.loyaltyGroupItems.loyaltyRule.metadata.trackAllContracts

boolean | null

Flag indicating if all contracts are tracked.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.onlyRewardSingleTokenOwnership

boolean | null

give points for only one token ownership per contract

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.skipMultiplier

boolean | null

Flag indicating if the multiplier is skipped.

Example:

true

data.loyaltyGroupItems.loyaltyRule.metadata.completeProfileConditions

object | null

Conditions for completing the profile.

Example:

{ "twitter": true, "discord": false }

data.loyaltyGroupItems.loyaltyRule.metadata.steamAppId

string | null

ID of the Steam app.

Example:

"1234567890"

data.loyaltyGroupItems.loyaltyRule.metadata.trackProgress

boolean | null

Flag indicating if the progress is tracked. If enabled, the rule can only be completed once the progress is 100%.

Example:

true

data.loyaltyGroupItems.loyaltyRule.mediaUrl

string | null

required

hasNextPage

boolean

required

Was this page helpful?

Restore Loyalty Rule Edit Create Loyalty Rule Groups

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 response = await client.loyalty.ruleGroups.getRuleGroups();

  console.log(response.data);
}

main();

{
  "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": {
              "onlyNonListed": true,
              "hasPaidFullRoyalty": false,
              "hasVerifiedTwitter": true,
              "onlyRewardExistingUser": true,
              "hasNeverSold": false,
              "onlyNative": true,
              "hasFillSource": true,
              "fillSource": "opensea.io",
              "hasOrderSource": true,
              "orderSource": "opensea.io",
              "twitterUsername": "@example_user",
              "twitterUserId": "1234567890",
              "twitterHashtag": "#loyalty",
              "enableVerifiedMultiplier": true,
              "verifiedMultiplier": 1.5,
              "isMultiplierApplied": true,
              "onlyKnownUsers": false,
              "firstReferralReward": 10,
              "referrerReward": 50,
              "secondReferralReward": 5,
              "enableStreaks": true,
              "promoCode": "PROMO123",
              "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
                }
              ],
              "customRewardsApiKey": "api-key-1234",
              "link": "https://example.com",
              "socialPlatform": "X(Twitter)",
              "socialPlatformName": "Twitter",
              "socialPlatformLogo": "https://example.com/logo.png",
              "rewardPerImpression": true,
              "minQty": 1,
              "maxQty": 10,
              "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,
              "checkText": "loyalty",
              "smartContract": {
                "contractId": "123e4567-e89b-12d3-a456-426614174000",
                "abi": "[]",
                "event": "Transfer",
                "criteria": "everyEvent",
                "params": [
                  {
                    "name": "value",
                    "condition": ">=",
                    "value": "100"
                  }
                ],
                "withCustomRange": true,
                "customRange": {
                  "startsAt": "2024-01-01T00:00:00Z",
                  "endsAt": "2024-01-31T23:59:59Z"
                },
                "withMax": true,
                "max": 1000,
                "withBonus": true,
                "bonus": [
                  {
                    "amount": 50,
                    "count": 5
                  }
                ],
                "addressMapping": "0x123...789"
              },
              "walletType": "evm",
              "imageUrl": "https://example.com/image.png",
              "trackAllContracts": true,
              "onlyRewardSingleTokenOwnership": true,
              "skipMultiplier": true,
              "completeProfileConditions": {
                "twitter": true,
                "discord": false
              },
              "steamAppId": "1234567890",
              "trackProgress": true
            },
            "mediaUrl": "<string>"
          }
        }
      ]
    }
  ],
  "hasNextPage": true
}

API Documentation

Asset

Auction

Identity

Loyalty

Badge

Minting

Question

Referrals

Website

Landing Page

Get Loyalty Rule Groups

Authorizations

Query Parameters

Response