V 1 Loyalty Programs Controller List

GET

///api/v1/loyalty-programs

GET

/api/v1/loyalty-programs

$ curl /api/v1/loyalty-programs \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "loyaltyPrograms": [
3     {
4       "createdAt": "2024-04-01T10:00:00Z",
5       "description": "Earn points on every purchase and redeem for exclusive discounts.",
6       "id": "lp_9f8b7c6d5e4a3b2c1d0e",
7       "name": "Perkss Rewards",
8       "pointsPerDollar": 10,
9       "status": "active",
10       "tiers": [
11         {
12           "benefits": [
13             "5% off on all items",
14             "Early access to sales"
15           ],
16           "minPoints": 0,
17           "tierName": "Silver"
18         },
19         {
20           "benefits": [
21             "10% off on all items",
22             "Free shipping",
23             "Birthday bonus points"
24           ],
25           "minPoints": 5000,
26           "tierName": "Gold"
27         }
28       ]
29     },
30     {
31       "createdAt": "2023-11-15T08:30:00Z",
32       "description": "Exclusive membership with premium rewards and events.",
33       "id": "lp_1a2b3c4d5e6f7g8h9i0j",
34       "name": "VIP Club",
35       "pointsPerDollar": 15,
36       "status": "active",
37       "tiers": [
38         {
39           "benefits": [
40             "Access to VIP events",
41             "Monthly newsletter"
42           ],
43           "minPoints": 0,
44           "tierName": "Member"
45         },
46         {
47           "benefits": [
48             "20% off select items",
49             "Personal shopping assistant",
50             "Exclusive gifts"
51           ],
52           "minPoints": 10000,
53           "tierName": "Platinum"
54         }
55       ]
56     }
57   ]
58 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Authentication

Response