Get users for a badge

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

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

fetch('https://admin.snagsolutions.io/api/loyalty/badge_users', 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/badge_users",
  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/badge_users"

	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/badge_users")

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

{
  "id": "a96edeb7-c10f-4e63-9acf-85e277665587",
  "userId": "9b0351c3-71ab-4a45-a36a-f7b35ccd276b",
  "loyaltyBadgeId": "749b1bb0-a607-4010-888b-8321905606b9",
  "websiteId": "42218351-3c75-46af-8453-5ae04b9ad7bb",
  "organizationId": "548b0619-f4b3-4ef6-8dd9-77dfa9260eb2",
  "createdAt": "2025-09-11T13:45:40.123Z",
  "updatedAt": "2025-09-11T13:45:40.123Z",
  "deletedAt": null,
  "status": "active",
  "progress": [],
  "dismissedInUi": false,
  "user": {
    "walletAddress": "0x1234567890abcdef1234567890abcdef12345678"
  }
}

"Forbidden, Could not validate api key"

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

GET

api

loyalty

badge_users

Get users for a badge

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

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

fetch('https://admin.snagsolutions.io/api/loyalty/badge_users', 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/badge_users",
  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/badge_users"

	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/badge_users")

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

{
  "id": "a96edeb7-c10f-4e63-9acf-85e277665587",
  "userId": "9b0351c3-71ab-4a45-a36a-f7b35ccd276b",
  "loyaltyBadgeId": "749b1bb0-a607-4010-888b-8321905606b9",
  "websiteId": "42218351-3c75-46af-8453-5ae04b9ad7bb",
  "organizationId": "548b0619-f4b3-4ef6-8dd9-77dfa9260eb2",
  "createdAt": "2025-09-11T13:45:40.123Z",
  "updatedAt": "2025-09-11T13:45:40.123Z",
  "deletedAt": null,
  "status": "active",
  "progress": [],
  "dismissedInUi": false,
  "user": {
    "walletAddress": "0x1234567890abcdef1234567890abcdef12345678"
  }
}

"Forbidden, Could not validate api key"

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

Authorizations

X-API-KEY

string

header

required

Query Parameters

loyaltyBadgeId

string<uuid>

required

UUID of the loyalty badge (converted to lowercase)

Example:

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

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"

walletAddress

string

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

Example:

"0x1234567890abcdef1234567890abcdef12345678"

status

enum<string>

Status of the badge

Available options:

active,

inactive,

revoked

Example:

"active"

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

Response

200

Response returned upon successful fetching of the badge users.

string<uuid>

required

UUID of the user badge (converted to lowercase)

Example:

"a96edeb7-c10f-4e63-9acf-85e277665587"

userId

string<uuid>

required

UUID of the user (converted to lowercase)

Example:

"9b0351c3-71ab-4a45-a36a-f7b35ccd276b"

loyaltyBadgeId

string<uuid>

required

UUID of the badge (converted to lowercase)

Example:

"749b1bb0-a607-4010-888b-8321905606b9"

websiteId

string<uuid>

required

UUID of the website (converted to lowercase)

Example:

"42218351-3c75-46af-8453-5ae04b9ad7bb"

organizationId

string<uuid>

required

UUID of the organization (converted to lowercase)

Example:

"548b0619-f4b3-4ef6-8dd9-77dfa9260eb2"

createdAt

string<date-time>

required

The date and time the user badge was created

Example:

"2025-09-11T13:45:40.123Z"

updatedAt

string<date-time>

required

The date and time the user badge was updated

Example:

"2025-09-11T13:45:40.123Z"

deletedAt

string<date-time> | null

required

The date and time the user badge was deleted

Example:

null

status

enum<string>

required

The status of the badge

Available options:

active,

inactive,

revoked

Example:

"active"

progress

null[]

required

Array of progress for the badge

Example:

[]

dismissedInUi

boolean

Whether the user has dismissed the badge in the UI

Example:

false

user

User · object | null

User associated with the user badge

Show child attributes

API Documentation

Asset

Auction

Contract

Identity

Loyalty

Badge

Social Posts

Minting

Question

Stratus

Referrals

Website

Landing Page

Token Claims

Get users for a badge

Authorizations

Query Parameters

Response