Get Loyalty Transaction Entries

Fetch loyalty transaction entries for wallets or users, representing account balance changes.

GET /api/loyalty/transaction_entries

Get Loyalty Transaction Entries

cURL

curl --request GET \
  --url https://admin.snagsolutions.io/api/loyalty/transaction_entries \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174040",
      "organizationId": "123e4567-e89b-12d3-a456-426614174001",
      "websiteId": "123e4567-e89b-12d3-a456-426614174002",
      "loyaltyAccountId": "123e4567-e89b-12d3-a456-426614174050",
      "direction": "credit",
      "type": "loyalty_rule",
      "createdAt": "2023-10-01T12:34:56Z",
      "updatedAt": "2023-10-05T15:30:00Z",
      "amount": 100,
      "loyaltyTransaction": {
        "id": "123e4567-e89b-12d3-a456-426614174060",
        "type": "order",
        "loyaltyRule": {
          "id": "123e4567-e89b-12d3-a456-426614174070",
          "type": "purchase",
          "name": "First Purchase Bonus",
          "description": "Bonus points for the first purchase",
          "metadata": {
            "category": "electronics"
          },
          "loyaltyRuleGroupItem": {
            "loyaltyRuleGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      },
      "metadata": {
        "orderId": "order123"
      }
    }
  ],
  "hasNextPage": true
}

Authorizations

X-API-KEY · string · header · required

Query Parameters

organizationId · string<uuid>

Unique identifier for the organization to filter by

Example:

"123e4567-e89b-12d3-a456-426614174001"

websiteId · string<uuid>

Unique identifier for the website to filter by

Example:

"123e4567-e89b-12d3-a456-426614174002"

startingAfter · string<uuid>

Pagination cursor to start after a specific resource ID

Example:

"123e4567-e89b-12d3-a456-426614174010"

limit · integer · default: 10

Maximum number of records to return (max 100)

Required range: 1 <= x <= 100

Example:

50

walletAddress · string string[]

Wallet address or array of wallet addresses to filter by

Example:

[
  "0x1234567890abcdef1234567890abcdef12345678"
]

userId · string<uuid> string<uuid>[]

User ID or array of User IDs to filter by

Example:

["123e4567-e89b-12d3-a456-426614174000"]

walletGroupIdentifier · string

Identifier for the wallet group to filter by

Example:

"group123"

loyaltyTransactionId · string

Unique identifier for the loyalty transaction to filter by

Example:

"123e4567-e89b-12d3-a456-426614174020"

loyaltyRuleId · string

Unique identifier for the loyalty rule to filter by

Example:

"123e4567-e89b-12d3-a456-426614174030"

loyaltyRuleType · enum<string> enum<string>[]

Available options: Bonus, BoughtOn, BoughtWithRoyalties, DiscordMessages, Listing, Lodging, PoapClaim, SnagSocialsConnected, SnapshotFullset, SnapshotHold, SoldWithRoyalties, TwitterBio, TwitterHashTagPost, MintOn, SoldOn, TokenHold, Retweet, check_in, code_entry, connect_wallet, connected_discord, connected_email, connected_epic, connected_github, 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, liquidity_uniswap_v2, liquidity_uniswap_v3, points_airdrop, youtube_subscribers, youtube_comment, shopify_spend, swap, tiktok_post, post_impressions, discord_join, connected_youtube, stratus_function, connected_tiktok, tiktok_follow, github_repo_star, github_repo_fork, github_repo_collaborator, github_merge_PR, discord_role_grant, connected_reddit, reddit_comment, robinhood_token_hold, connected_instagram, instagram_post, instagram_follow, connected_phone, dapps_by_gas_spent, dapps_by_active_users, dapps_by_new_users, dapps_by_transaction_count, dapps_by_user_retention

idempotencyKey · string

Key to ensure idempotency of the request

Example:

"idempkey123"

type · enum<string>

Type of the loyalty transaction to filter by

Available options: auction_bid, direct_mint, loyalty_rule, api_key, order

Example:

"loyalty_rule"

sortBy · enum<string> · default: createdAt

Field to sort the results by

Available options: createdAt, updatedAt, loyaltyAccountLockVersion

Example:

"createdAt"

sortDir · enum<string> · default: desc

Direction to sort the results by

Available options: asc, desc

Example:

"desc"

userCompletedLoyaltyRuleId · string<uuid> string<uuid>[]

When passed in return the list of fulfilled entries for loyalty rules. If a loyalty rule has a fulfilled entry this means the user cannot currently complete the rule. Must be passed in with userId or walletAddress.

Example:

"123e4567-e89b-12d3-a456-426614174030"

userGroupExternalIdentifier · string

External identifier for the user group controlled by you.

userGroupId · string<uuid>

Unique identifier for the user group

Example:

"123e4567-e89b-12d3-a456-426614174090"

createdAtStart · string<date-time>

Start date to filter by (inclusive, greater than or equal to)

Example:

"2023-10-01T12:34:56Z"

createdAtEnd · string<date-time>

End date to filter by (exclusive, less than)

Example:

"2023-10-01T12:34:56Z"

loyaltyRuleGroupId · string<uuid>

UUID of the rule group (converted to lowercase)

Example:

"123e4567-e89b-12d3-a456-426614174333"

loyaltyCurrencyId · string<uuid> string<uuid>[]

UUID of the loyalty currency IDs to filter by. Use this to exclude deleted currencies

Example:

"123e4567-e89b-12d3-a456-426614174333"

Response

200

application/json

200

data · Loyalty Transaction Entry · object[] · required

Show child attributes

hasNextPage · boolean · required