Get loyalty accounts

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

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://admin.snagsolutions.io/api/loyalty/accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.snagsolutions.io/api/loyalty/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://admin.snagsolutions.io/api/loyalty/accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://admin.snagsolutions.io/api/loyalty/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "message": "Request body is invalid"
}

"Forbidden, Could not validate api key"

{
  "message": "Too many requests"
}

{
  "success": false,
  "message": "Internal server error",
  "debugInfo": "Stack trace or additional error details"
}

GET

api

loyalty

accounts

Get loyalty accounts

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

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://admin.snagsolutions.io/api/loyalty/accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.snagsolutions.io/api/loyalty/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://admin.snagsolutions.io/api/loyalty/accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://admin.snagsolutions.io/api/loyalty/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "message": "Request body is invalid"
}

"Forbidden, Could not validate api key"

{
  "message": "Too many requests"
}

{
  "success": false,
  "message": "Internal server error",
  "debugInfo": "Stack trace or additional error details"
}

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

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

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"

API Documentation

Asset

Auction

Contract

Identity

Loyalty

Badge

Social Posts

Minting

Question

Stratus

Referrals

Website

Landing Page

Token Claims

Get loyalty accounts

Authorizations

Query Parameters

Response