Listar templates de wallet de un programa
Templates
GET /v1/loyalty/templates
List the wallet card designs of a program, newest version first.
GET
Listar templates de wallet de un programa
Lists the wallet card designs belonging to one program, newest version first. A template is what the customer sees in Apple Wallet or Google Wallet: colours, logo, the fields on the front and back, and the barcode.
Templates are designed and published in the Keebai portal. Here they are read-only — useful for checking which version is live before issuing passes, or for rendering a preview in your own back office.
Endpoint
Required scope
loyalty:read
Headers
Query parameters
Example request
Response
200 OK
400 Bad Request
program_id is missing or is not a valid ObjectId.
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
- This response is not paginated. It returns every template version of the program, with a
totalfor convenience. Programs accumulate a handful of versions, not thousands. - Exactly one version is normally
published— the one new passes are issued from. Passes already in a customer’s wallet stay pinned to the version they were issued with. - A program with no published template cannot issue passes. Both pass endpoints fail with
400until one exists. Checkpublishedhere first if issuance is failing. fields[].valuemay contain bindings —{{balancePoints}},{{stampsCount}},{{tier}},{{serialNumber}}— resolved per membership at issue time. What you read here is the template, not the rendered card.- Geofences and iBeacon settings are not exposed. Store proximity configuration lives on the template but stays in the portal; it is physical deployment configuration rather than integration data.
Authorizations
Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.
Query Parameters
ObjectId del programa cuyos templates se listan. Los templates siempre se consultan por programa