Members APILoyalty
Get Perks for Group
Get all perks belonging to a perk group
GET
/members/me/loyalty/perk-groups/{id}/perksOverview
Returns all individual perks that belong to a specific perk group. This shows the detailed benefits available within that group.
Authentication
Requires a valid Clerk JWT token in the Authorization header.
Path Parameters
idpathnumberrequiredPerk group ID to get perks for
Request
curl -X GET "http://localhost:3000/v1/members/me/loyalty/perk-groups/1/perks" \
-H "Authorization: Bearer YOUR_CLERK_JWT"Response
itemsarrayrequiredList of perks in this group
array items
idnumberrequiredUnique perk ID
documentIdstringDocument identifier for the perk
namestringrequiredDisplay name of the perk
descriptionstringDescription of what this perk provides
headlinestringShort marketing headline for the perk
totalnumberrequiredTotal number of perks in this group
Response
{
"items": [
{
"id": 15,
"documentId": "perk_suite_upgrade",
"name": "Complimentary Suite Upgrade",
"description": "Upgrade to the next available suite category at no additional charge",
"headline": "Elevate Your Stay"
},
{
"id": 16,
"documentId": "perk_late_checkout",
"name": "Late Checkout",
"description": "Extended checkout time until 4:00 PM subject to availability",
"headline": "Extra Time to Unwind"
},
{
"id": 17,
"documentId": "perk_vip_amenities",
"name": "VIP Welcome Amenities",
"description": "Luxury welcome amenities delivered to your suite upon arrival",
"headline": "Premium Welcome Experience"
}
],
"total": 3
}Related Endpoints
- Get Perk Group - Get details of this perk group
- Get Available Perks - Get all perks available to member