Skip to main content
GET
/
api
/
v2
/
loyalty
/
programs
/
List loyalty programs
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>",
      "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",
      "welcome_campaign_id": "<string>",
      "how_it_works": "<string>"
    }
  ],
  "meta": {
    "cursor": "<string>",
    "has_next": true,
    "count": 123
  }
}

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.

Query Parameters

cursor
string

Pagination cursor value from previous response.

page_size
integer

Number of results to return per page.

Response

data
object[]
required
meta
object
required