Skip to main content
Offers are the catalog of experiences a member can redeem. listOffers returns the offers available to the calling member, each with its points price and optional expiry, paged with a cursor.
These are member-mode calls: they use the member token, not the Org-API-Key. See Authentication. Whether you read the sandbox demo catalog or your live catalog is selected by the key the token was minted from - see Environments.

List offers

listOffers(limit?, cursor?) calls GET /v1/offers and returns an OfferList. The snippet below pages through the entire catalog by following nextCursor until it comes back null:
curl

The Offer schema

Each entry in data is an Offer:
pointsPrice of null is distinct from 0: it means the offer carries no points price at all. An offer past its expiresAt is no longer redeemable - attempting to redeem it returns OFFER_UNAVAILABLE. See Redemptions.

Pagination

OfferList is cursor-paginated:
Pagination is cursor-based, not page-numbered. Pass the previous response’s nextCursor as the next request’s cursor, and stop when nextCursor is null. Do not assume a fixed page size or construct cursors yourself - treat the cursor as an opaque token.

Next steps

Redemptions

Redeem an offer, spend points, and follow the redemption lifecycle.

Points and wallet

How points are minted, spent, and tracked against pointsPrice.

API reference

The full GET /v1/offers schema and an interactive playground.