Get Perk Groups
Get paginated list of perk groups
/members/me/loyalty/perk-groupsOverview
Returns a paginated list of available perk groups. Perk groups organize related perks and benefits within the loyalty program.
Authentication
Requires a valid Clerk JWT token in the Authorization header.
Query Parameters
limitquerynumberMaximum number of perk groups to return (default: 20, max: 100)
offsetquerynumberNumber of perk groups to skip for pagination (default: 0)
enabledquerybooleanFilter by enabled status - only return active perk groups
stayRequiredquerybooleanFilter by stay requirement - only return perk groups that require an active reservation
Request
curl -X GET "http://localhost:3000/v1/members/me/loyalty/perk-groups?enabled=true&limit=10" \
-H "Authorization: Bearer YOUR_CLERK_JWT"Response
itemsarrayrequiredList of perk groups
array items
idnumberrequiredUnique perk group ID
documentIdstringrequiredDocument identifier for the perk group
namestringrequiredDisplay name of the perk group
descriptionstringDescription of the perk group and its benefits
enabledbooleanrequiredWhether this perk group is currently active
stayRequiredbooleanrequiredWhether perks in this group require an active reservation
createdAtstringrequiredISO 8601 timestamp when perk group was created
updatedAtstringrequiredISO 8601 timestamp when perk group was last updated
totalnumberrequiredTotal number of perk groups matching filters
limitnumberrequiredCurrent pagination limit
offsetnumberrequiredCurrent pagination offset
Response
{
"items": [
{
"id": 1,
"documentId": "pg_suite_benefits",
"name": "Suite Benefits",
"description": "Exclusive perks and upgrades for suite accommodations",
"enabled": true,
"stayRequired": true,
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-03-20T14:30:00Z"
},
{
"id": 2,
"documentId": "pg_dining_credits",
"name": "Dining Credits",
"description": "Food and beverage credits at partner properties",
"enabled": true,
"stayRequired": false,
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-02-10T09:15:00Z"
}
],
"total": 8,
"limit": 10,
"offset": 0
}Related Endpoints
- Get Perk Group - Get details of a specific perk group
- Get Perks for Group - Get all perks within a perk group