Get loyalty accounts

Get loyalty accounts

GET /api/loyalty/accounts

Get loyalty accounts

cURL

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

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174050",
      "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"
          }
        ],
        "websiteUserAttributeValues": [
          {
            "value": "Website User Attribute Value",
            "websiteUserAttribute": {
              "id": "123e4567-e89b-12d3-a456-426614174004",
              "label": "Website User Attribute Label"
            }
          }
        ]
      },
      "amount": 1500,
      "lockVersion": 1
    }
  ],
  "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 · string string[]

Wallet address(es) to filter accounts by

Example:

[
  "0x1234567890abcdef1234567890abcdef12345678"
]

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

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> string<uuid>[]

Loyalty currency ID(s) to filter accounts by. Accepts a single id or a list.

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"

excludeDeletedCurrency · enum<string>

Pass true to drop accounts belonging to deleted loyalty currencies. Defaults to false, so they are included. Ignored when loyaltyCurrencyId names a currency — a deleted currency returns its accounts either way.

Available options: true, false

Example:

"true"

Response

200

application/json

200

Schema for the response of getting loyalty accounts

data · Loyalty Account · object[] · required

Array of loyalty accounts

Show child attributes

hasNextPage · boolean · required

Indicates if there is a next page of results

Example:

true

message · string

Optional message

Example:

"Success"