Members APILoyalty
Get Perk Group
Get details of a specific perk group
GET
/members/me/loyalty/perk-groups/{id}Overview
Returns detailed information about a specific perk group including its configuration and status.
Authentication
Requires a valid Clerk JWT token in the Authorization header.
Path Parameters
idpathnumberrequiredPerk group ID
Request
curl -X GET "http://localhost:3000/v1/members/me/loyalty/perk-groups/1" \
-H "Authorization: Bearer YOUR_CLERK_JWT"Response
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
Response
{
"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"
}Related Endpoints
- Get Perk Groups - List all available perk groups
- Get Perks for Group - Get all perks within this group