Get User Points API - Loyalty Balance Endpoint
Retrieve a user's current loyalty points balance with our Points API. Check point totals, verify balances before redemptions, and display reward currency in your application.
Essential for loyalty programs, reward systems, point-based economies, gamification platforms, and any application using virtual currency or engagement points. Simple REST API endpoint for real-time balance queries.
This endpoint allows you to retrieve a user's current loyalty point balance from the Lynes Loyalty platform.
Endpoint
GET /user/{userId}/pointsAuthentication
⚠️
Authentication Required
This endpoint requires a valid JWT token with appropriate permissions.
See our JWT Authentication guide for more details.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
userId | string | Yes | The unique identifier of the user |
Example Request
curl -X GET "https://api.lynesapp.de/user/user_123/points" \
-H "Authorization: Bearer YOUR_JWT_TOKEN"Response
Success Response (200 OK)
{
"points": 123
}Status Codes
| Status Code | Description |
|---|---|
200 | Successfully retrieved user points |
401 | Unauthorized - Invalid or missing authentication token |
403 | Forbidden - Insufficient permissions |
404 | User not found |
500 | Internal server error |
Use Cases
- Display a user's current point balance in your application
- Check if a user has enough points before offering rewards
- Track point accumulation over time when combined with historical data
Related Endpoints
- Get User History - Retrieve a user's activity history
- Get User - Retrieve complete user information
- Update User Points - Manually adjust a user's point balance