Get loyalty program details
Retrieve a loyalty program’s configuration including tiers, points rules, and enrollment URL.
Authorizations
Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.
Path Parameters
Unique identifier for this loyalty program.
Response
Loyalty program details including configuration, rewards catalog, and customer statistics.
Used in public URL (e.g., zupy.com/@slug). Only superusers can modify.
^[-a-zA-Z0-9_]+$Public enrollment URL for this loyalty program
Custom name for points in this program (e.g., Stars, Coins).
Number of days before points expire. 0 means never.
How many points are earned per currency unit spent.
^-?\d{0,8}(?:\.\d{0,2})?$Minimum points required for any redemption.
If enabled, this program will be visible in the public directory.
If enabled, this program will use the tier system with Bronze/Silver/Gold tiers. If disabled, all users will use the default tier.
Per-program lifecycle status. Distinct from is_active (which is the legacy boolean kept for backwards compat).
draft, published, archived When enabled, users receive points upon completing 100% of their profile
Number of points the user receives upon completing 100% of their profile
ID of the welcome campaign that fires on enrollment (null if no campaign attached). Replaces the legacy welcome_points_bonus / welcome_reward_type fields — point awards and gifts are now configured via the campaign object.
Custom 'Como Funciona' wallet-card text override. Empty string means use the FE-derived default ("A cada R$X você ganha N pontos…").