Get Loyalty Rules

Retrieve configured loyalty rules with optional pagination and filters

GET /api/loyalty/rules

Get Loyalty Rules

cURL

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

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Loyalty Rule",
      "description": "Loyalty Rule Description",
      "endTime": "2023-10-01T12:34:56Z",
      "startTime": "2023-10-01T12:34:56Z",
      "rewardType": "points",
      "organizationId": "123e4567-e89b-12d3-a456-426614174001",
      "websiteId": "123e4567-e89b-12d3-a456-426614174002",
      "type": "purchase",
      "frequency": "daily",
      "amount": 10,
      "createdAt": "2023-10-01T12:34:56Z",
      "updatedAt": "2023-10-05T15:30:00Z",
      "deletedAt": null,
      "loyaltyRuleChain": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174001",
          "name": "My Rule Chain",
          "loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174111",
          "loyaltyConditions": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174001",
              "type": "rule",
              "description": "My Condition",
              "amount": 100,
              "repeatCount": 1,
              "requiredCount": 1,
              "csvUrl": "https://example.com/csv",
              "association": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174001",
                  "loyaltyRuleGroupId": "123e4567-e89b-12d3-a456-426614174001",
                  "loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174111",
                  "loyaltyCurrencyId": "123e4567-e89b-12d3-a456-426614174001",
                  "loyaltyBadgeId": "123e4567-e89b-12d3-a456-426614174001",
                  "loyaltyRule": {
                    "name": "My Loyalty Rule"
                  },
                  "loyaltyCurrency": {
                    "name": "My Loyalty Currency"
                  }
                }
              ]
            }
          ],
          "operatorType": "AND"
        }
      ],
      "collectionAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "mediaUrl": "https://assets.snagsolutions.io/media.png",
      "metadata": {
        "key": "value"
      },
      "dappDeployedWithin": "daily",
      "dappDataWindow": "daily",
      "trackProgress": true,
      "progressType": "percentage"
    }
  ],
  "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"

collectionAddress · string

Address of the collection to filter by

Example:

"0x1234567890abcdef1234567890abcdef12345678"

loyaltyRuleGroupId · string<uuid> string<uuid>[]

ID(s) of the loyalty rule group(s) to filter results. Single ID or array for multiple groups (shared cursor when multiple).

Example:

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

startingAfter · string

Pagination cursor to start after a specific resource ID

Example:

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

limit · number · default: 10

Maximum number of records to return (max 100)

Required range: 1 <= x <= 100

Example:

50

loyaltyRuleId · string<uuid> string<uuid>[]

The IDs of the loyalty rule

Example:

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

isActive · enum<string>

If true this will only return active rules, the rules for which the startTime is in the past and the endTime is in the future

Available options: true, false

Example:

true

allotedToUserId · string<uuid> string<uuid>[]

IDs of the users to filter results by

Example:

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

allotedUserGroupId · string<uuid>

ID of the user group to filter results by

Example:

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

isSpecial · enum<string>

If true this will only return special rules, special rules are the rules that are used for anti sybil as honey pot

Available options: true, false

Example:

true

includeDeleted · boolean · default: false

Whether to include deleted/archived records

Example:

false

Response

200

application/json

200

data · object[] · required

Show child attributes

hasNextPage · boolean · required