curl --request GET \
--url https://api.zupy.com/api/v2/loyalty/programs/ \
--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
}
}List all loyalty programs for the authenticated company.
curl --request GET \
--url https://api.zupy.com/api/v2/loyalty/programs/ \
--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
}
}API key for partner access via APISIX key-auth plugin
Pagination cursor value from previous response.
Number of results to return per page.