Listar programas de fidelidad
Programs
GET /v1/loyalty/programs
List the loyalty programs of your company, newest first, with the rules that govern each one.
GET
Listar programas de fidelidad
Lists the loyalty programs of your company. This is the starting point for everything else: a membership, a template, and a ledger movement all hang off a program id.
A program is one of three kinds —
points, stamps, or tiers — and only the matching entry inside rules is populated.
Endpoint
Required scope
loyalty:read
Headers
Query parameters
Example request
Response
200 OK
401 Unauthorized
Missing, invalid, revoked, or expired token.403 Forbidden
The token does not have theloyalty:read scope.
502 Bad Gateway
The loyalty service is unreachable.Operational notes
- Only one
rulesvariant is present. Astampsprogram carriesrules.stampsand nothing else; the other keys are absent, not empty objects. Switch ontyperather than probing for keys. - Reads span the whole company. Loyalty has no notion of a project, so this returns every program in your company regardless of which project the token belongs to.
- Programs are created in the portal. There is no
POSThere — the API reads program configuration, it does not author it. archivedprograms still list. Filter bystatus=activeif you only want the ones currently running.
Authorizations
Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.
Query Parameters
Required range:
1 <= x <= 200Required range:
x >= 0Available options:
draft, active, archived Available options:
points, stamps, tiers