Skip to main content
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 the loyalty:read scope.

502 Bad Gateway

The loyalty service is unreachable.

Operational notes

  • Only one rules variant is present. A stamps program carries rules.stamps and nothing else; the other keys are absent, not empty objects. Switch on type rather 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 POST here — the API reads program configuration, it does not author it.
  • archived programs still list. Filter by status=active if you only want the ones currently running.

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:50
Required range: 1 <= x <= 200
offset
number
default:0
Required range: x >= 0
status
enum<string>
Available options:
draft,
active,
archived
type
enum<string>
Available options:
points,
stamps,
tiers

Response

200 - application/json
total
number
required
limit
number
required
offset
number
required
data
object[]
required