Get User Balance (SDK)

GET /v1/users/:userId/sdk-balance

Returns a user’s current point balance. This is the lightweight SDK-facing variant; see Get User Balance for the server-side version with full profile data.

Authentication

Header	Required	Value
X-API-Key	Yes	Your public key

Path Parameters

Param	Type	Description
userId	string	The user’s external ID

Request Examples

cURL

curl -X GET https://api.gamifyhost.com/v1/users/user_12345/sdk-balance \
  -H "X-API-Key: pk_live_your_public_key"

JavaScript

const userId = 'user_12345';

const response = await fetch(
  `https://api.gamifyhost.com/v1/users/${userId}/sdk-balance`,
  {
    method: 'GET',
    headers: {
      'X-API-Key': 'pk_live_your_public_key',
    },
  }
);

const data = await response.json();
console.log(data.data.totalPoints);

Python

import requests

user_id = "user_12345"

response = requests.get(
    f"https://api.gamifyhost.com/v1/users/{user_id}/sdk-balance",
    headers={"X-API-Key": "pk_live_your_public_key"},
)

data = response.json()
print(data["data"]["totalPoints"])

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

String userId = "user_12345";

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.gamifyhost.com/v1/users/" + userId + "/sdk-balance"))
    .header("X-API-Key", "pk_live_your_public_key")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Go

userId := "user_12345"
url := fmt.Sprintf("https://api.gamifyhost.com/v1/users/%s/sdk-balance", userId)

req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("X-API-Key", "pk_live_your_public_key")

resp, err := http.DefaultClient.Do(req)
if err != nil {
    log.Fatal(err)
}
defer resp.Body.Close()

var result map[string]interface{}
json.NewDecoder(resp.Body).Decode(&result)
fmt.Println(result["data"])

PHP

$userId = 'user_12345';

$ch = curl_init("https://api.gamifyhost.com/v1/users/{$userId}/sdk-balance");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-API-Key: pk_live_your_public_key',
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
echo $data['data']['totalPoints'];

Ruby

require 'net/http'
require 'json'

user_id = 'user_12345'

uri = URI("https://api.gamifyhost.com/v1/users/#{user_id}/sdk-balance")
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = 'pk_live_your_public_key'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
puts data['data']['totalPoints']

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "pk_live_your_public_key");

var userId = "user_12345";
var response = await client.GetAsync($"https://api.gamifyhost.com/v1/users/{userId}/sdk-balance");
var json = await response.Content.ReadAsStringAsync();
Console.WriteLine(json);

Dart

import 'dart:convert';
import 'package:http/http.dart' as http;

const userId = 'user_12345';

final response = await http.get(
  Uri.parse('https://api.gamifyhost.com/v1/users/$userId/sdk-balance'),
  headers: {'X-API-Key': 'pk_live_your_public_key'},
);

final data = jsonDecode(response.body);
print(data['data']['totalPoints']);

Response

Status: 200 OK

{
  "message": "User balance retrieved",
  "code": 200,
  "status": "success",
  "data": {
    "userId": "user_12345",
    "totalPoints": 5000,
    "displayName": "Alice"
  }
}

Response Fields

Field	Type	Description
userId	string	The user’s external ID
totalPoints	integer	Current point balance
displayName	string	Display name (if set)

Errors

Code	Message
404	User not found