Skip to main content
GET
/
api
/
v2
/
loyalty
/
programs
/
{id}
Get loyalty program details
curl --request GET \
  --url https://api.zupy.com/api/v2/loyalty/programs/{id}/ \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "enrollment_url": "<string>",
    "description": "<string>",
    "company_id": "<string>",
    "points_name": "<string>",
    "point_expiration_days": 123,
    "points_per_currency": "<string>",
    "minimum_points_redemption": 123,
    "is_public": true,
    "tiers_enabled": true,
    "tier_definitions": "<string>",
    "welcome_reward_type": "none",
    "welcome_points_bonus": 123,
    "profile_completion_enabled": true,
    "profile_completion_points": 123,
    "email": "jsmith@example.com",
    "logo_url": "<string>",
    "rewards_count": 123,
    "active_customers_count": 123,
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.zupy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

API key for partner access via APISIX key-auth plugin

Path Parameters

id
string
required

Unique identifier for this loyalty program.

Response

data
object
required

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

meta
object
required

Cursor-based pagination metadata matching envelope middleware output.