Skip to main content
GET
Get loyalty program details

Authorizations

X-API-Key
string
header
required

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

id
string
required

Unique identifier for this loyalty program.

Response

Loyalty program details including configuration, rewards catalog, and customer statistics.

id
string
required
read-only
name
string
required
read-only
slug
string
required
read-only

Used in public URL (e.g., zupy.com/@slug). Only superusers can modify.

Pattern: ^[-a-zA-Z0-9_]+$
enrollment_url
string<uri> | null
required
read-only

Public enrollment URL for this loyalty program

description
string
required
read-only
company_id
string
required
read-only
points_name
string
required
read-only

Custom name for points in this program (e.g., Stars, Coins).

point_expiration_days
integer
required
read-only

Number of days before points expire. 0 means never.

points_per_currency
string<decimal>
required
read-only

How many points are earned per currency unit spent.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
minimum_points_redemption
integer
required
read-only

Minimum points required for any redemption.

is_public
boolean
required
read-only

If enabled, this program will be visible in the public directory.

tiers_enabled
boolean
required
read-only

If enabled, this program will use the tier system with Bronze/Silver/Gold tiers. If disabled, all users will use the default tier.

tier_definitions
string
required
read-only
status
enum<string>
required
read-only

Per-program lifecycle status. Distinct from is_active (which is the legacy boolean kept for backwards compat).

Available options:
draft,
published,
archived
profile_completion_enabled
boolean
required
read-only

When enabled, users receive points upon completing 100% of their profile

profile_completion_points
integer
required
read-only

Number of points the user receives upon completing 100% of their profile

email
string<email>
required
read-only
logo_url
string | null
required
read-only
rewards_count
integer
required
read-only
active_customers_count
integer
required
read-only
is_active
boolean
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
welcome_campaign_id
string | null
read-only

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.

how_it_works
string
read-only

Custom 'Como Funciona' wallet-card text override. Empty string means use the FE-derived default ("A cada R$X você ganha N pontos…").