Skip to main content
GET
Listar membresías
Lists memberships. This is how you get from something you know about a customer — their id in your system, or their phone number — to the membership_id that every other loyalty write needs.

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

  • Phone search does not need normalising. The lookup matches on a subsequence of digits, so 912345678 finds a membership stored as +56 9 1234 5678. Strip or keep the country code as you like.
  • A customer can hold one membership per program. Searching by customer_id alone across several programs returns one row per program they belong to; add program_id to narrow it.
  • balance_points may read 0 on a program with point expiry even when the ledger shows movements. That is the display value, not a correction — see the overview.
  • customer may be absent on memberships created before an identifier was required, or through the portal’s bulk import without a matching row. Treat it as optional when reading.
  • Reads span the whole company, across every project.

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
program_id
string

ObjectId del programa

customer_id
string

Identificador del cliente elegido por el integrador al inscribir

phone
string

Teléfono del cliente. Busca por subsecuencia de dígitos, así que +56 9 1234 5678 matchea con 912345678

name
string

Búsqueda parcial por nombre

status
enum<string>
Available options:
active,
suspended,
revoked

Response

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