Skip to main content
GET
Obtener un programa de fidelidad
Returns a single program. Read it when you need the rules behind a balance — how many points a purchase is worth, how many stamps the reward takes, or where the tier thresholds sit.

Endpoint

Required scope

loyalty:read

Headers

Path parameters

Example request

Response

200 OK

A tiers program, showing the level thresholds:

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the loyalty:read scope.

404 Not Found

No program with that id in your company.

502 Bad Gateway

The loyalty service is unreachable.

Operational notes

  • Tier thresholds are read against balance_points. A membership’s tier is recomputed on every movement by finding the highest level whose threshold the point balance reaches.
  • A tiers program with no levels never assigns a tier. tier stays an empty string.
  • rules.points.expiration_days of 0 means no expiry. Any positive value makes the balance read as zero once that many days have passed since the member enrolled — see the overview for why that reading can disagree with the ledger.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Path Parameters

id
string
required

Response

200 - application/json
program
object
required