GET
/
api
/
loyalty
/
accounts
JavaScript
import SnagSolutions from '@snagsolutions/sdk';

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

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

console.log(accounts.data);
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174050",
      "amount": "<any>",
      "loyaltyCurrencyId": "123e4567-e89b-12d3-a456-426614174090",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
        "userMetadata": [
          {
            "walletGroupIdentifier": "group123",
            "twitterUser": "@user123",
            "discordUser": "user123#4567",
            "logoUrl": "https://example.com/logo.png",
            "displayName": "John Doe"
          }
        ]
      },
      "lockVersion": "<any>"
    }
  ],
  "hasNextPage": true,
  "message": "Success"
}

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 account ID

Example:

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

​
limit
integer

Maximum number of accounts to return

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

20

​
walletAddress

Wallet address(es) to filter accounts by

Example:
[
  "0x1234567890abcdef1234567890abcdef12345678"
]
​
userId

User ID(s) to filter accounts by. Pass in null to get a currencys main accounts.

Example:
["123e4567-e89b-12d3-a456-426614174000"]
​
walletGroupIdentifier
string

Wallet group identifier to filter accounts by

Example:

"group123"

​
sortDir
enum<string>
default:desc

Order the accounts in ascending or descending order, sorted by amount

Available options:
asc,
desc
Example:

"desc"

​
loyaltyCurrencyId
string<uuid>

Unique identifier for the loyalty currency

Example:

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

​
userGroupExternalIdentifier
string<uuid>

External identifier for the user group controlled by you

​
userGroupId
string<uuid>

Unique identifier for the user group

Example:

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

​
externalIdentifier
string

External identifier for the user

Example:

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

Response

200
application/json

200

Schema for the response of getting loyalty accounts