Sign in

v1

latestOpenAPI 3.0.02026-07-247251950.2 KB
Loyalty Program

Fetch a guest's loyalty points

Overview

Get a guest's current available points and upcoming points (points pending from confirmed bookings).

When to Use

  • Points display - Show points balance on guest account pages
  • Points checking - Quick lookup of available points
  • Pending points - Display points that will be awarded after stays
  • Balance verification - Verify points before redemption

What You Get

  • Current points - Points available for immediate redemption
  • Upcoming points - Points that will be awarded from confirmed bookings

Quick Start

Provide the guest ID in the URL path. Returns both current and upcoming points balances.

get/guests/{guestId}/loyalty-points

Path parameters

guestIdinteger required

Numeric ID of the guest to fetch

Response

OK

Example response

{
  "data": {
    "currentPoints": 1540,
    "upcomingPoints": 900
  }
}