Skip to Content

LoyaltyPointsApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
getCurrentLoyaltyPointsGET /loyalty-point/currentGet current loyalty points balance
getLoyaltyPointReportGET /loyalty-point/reportGet loyalty point transaction history

getCurrentLoyaltyPoints

LoyaltyPointResponse getCurrentLoyaltyPoints()

Get current loyalty points balance

Retrieves the authenticated user’s current loyalty points balance. Creates a new loyalty points account automatically if the user doesn’t have one yet.

Parameters

This endpoint does not need any parameter.

Return type

LoyaltyPointResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

getLoyaltyPointReport

PaginatedResponse_LoyaltyPointReportResponse getLoyaltyPointReport(page, per_page)

Get loyalty point transaction history

Retrieves a paginated list of all loyalty point transactions for the authenticated user showing points earned, redeemed, and any adjustments. Includes transaction reasons and dates.

Parameters

NameTypeDescriptionNotes
pageIntegerPage number for pagination (default: 1)[optional] [default to null]
per_pageIntegerNumber of items per page (default: 20)[optional] [default to null]

Return type

PaginatedResponse_LoyaltyPointReportResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8