Skip to main content
GET
/
api
/
loyalty
/
badges
JavaScript
import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: 'My API Key',
});

const badges = await client.loyalty.badges.list();

console.log(badges.data);
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174333",
      "name": "Example Badge",
      "description": "Example description",
      "imageUrl": "https://example.com/image.png",
      "loyaltyConditions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174333",
          "type": "rule",
          "description": "Example description",
          "amount": 10,
          "repeatCount": 5,
          "requiredCount": 5,
          "loyaltyRuleGroupId": "123e4567-e89b-12d3-a456-426614174333",
          "association": [
            {
              "loyaltyRule": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              },
              "loyaltyBadge": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              },
              "loyaltyRuleGroup": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              },
              "loyaltyCurrency": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              },
              "loyaltyLeaderboardView": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>"
              }
            }
          ],
          "loyaltyCurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "csvUrl": "https://example.com/csv",
          "csvFiles": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174333",
              "url": "https://example.com/file.csv",
              "name": "file.csv",
              "description": "Example description"
            }
          ]
        }
      ],
      "loyaltyBadgeUsers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174333",
          "userId": "123e4567-e89b-12d3-a456-426614174222",
          "websiteId": "123e4567-e89b-12d3-a456-426614174111",
          "organizationId": "123e4567-e89b-12d3-a456-426614174222",
          "status": "active",
          "loyaltyBadgeId": "123e4567-e89b-12d3-a456-426614174333",
          "progress": "<any>",
          "dismissedInUi": false,
          "user": {
            "id": "123e4567-e89b-12d3-a456-426614174222",
            "walletAddress": "0x1234567890abcdef1234567890abcdef12345678"
          },
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z"
        }
      ],
      "loyaltyRules": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174333",
          "name": "Example Rule"
        }
      ],
      "dataJobs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174333",
          "status": "pending",
          "message": "Data job is pending",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z"
        }
      ],
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z"
    }
  ],
  "hasNextPage": true
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
organizationId
string<uuid>

UUID of the organization (optional, converted to lowercase)

Example:

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

​
websiteId
string<uuid>

UUID of the website (optional, converted to lowercase)

Example:

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

​
badgeIds

Array of badge IDs (converted to lowercase) to fetch

Example:
["123e4567-e89b-12d3-a456-426614174333"]
​
walletAddress

Wallet Address of the user, or array of wallet addresses.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

​
userId

UUID of the user, or array of UUID.

Example:

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

​
userGroupId
string

UUID of the user group

Example:

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

​
userGroupExternalIdentifier
string

External identifier of the user group

Example:

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

​
startingAfter
string<uuid>

UUID of the badge to start after (converted to lowercase)

Example:

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

​
limit
integer

Number of badges to fetch

Required range: 1 <= x <= 1000
Example:

10

​
includeDeleted
boolean | null
default:false

Include deleted badges in the response

Example:

false

Response

200

​
data
Get Badges Success Response · object[]
required
​
hasNextPage
boolean
required

Indicates if there is a next page of results