Snag Docs home page
Search or ask...
Support
Admin Dashboard
Admin Dashboard
Search...
Navigation
Loyalty
Get Loyalty Rule Groups
Documentation
API Reference
API Documentation
Snag API
Snag SDK
API Deprecation
Assets
POST
Get Asset upload URL
Identity
POST
Creates or updates a user metadata
GET
Get users
POST
Connect user
POST
Disconnect user
Loyalty
GET
Get Loyalty Rules
POST
Create Loyalty Rule
POST
Update Loyalty Rule
DEL
Delete Loyalty Rule
POST
Complete Loyalty Rule
GET
Get Processing status for a specific user on loyalty rules
GET
Get Loyalty Rule Groups
GET
Get Loyalty Rule Edits
POST
Restore Loyalty Rule Edit
GET
Get loyalty accounts
GET
Get loyalty currencies
POST
Create a loyalty currency
GET
Get Loyalty Multipliers
POST
Create Loyalty Multiplier
DEL
Delete Loyalty Multiplier by External Identifier
POST
Update Loyalty Multiplier
DEL
Delete Loyalty Multiplier by ID
GET
Get Loyalty Transaction Entries
Loyalty Badges
GET
Get badges (all or by id)
POST
Create new badge
POST
Update badge (by id)
DEL
Delete badge (by id)
User Badges
POST
Reward badge for account
POST
Revoke badge from account
Auctions
GET
Get auction bids
POST
Create a bid
Websites
GET
Get websites
POST
Create website
Questions
GET
Get questions for a loyalty rule
POST
Create a new question
POST
Update an existing question
Questions Responses
GET
Get user's question responses
POST
Submit a response to a question
Loyalty
Get Loyalty Rule Groups
Retrieve configured loyalty rule groups
GET
/
api
/
loyalty
/
rule_groups
Try it
Authorizations
X-API-KEY
string
header
required
Query Parameters
websiteId
string
organizationId
string
startingAfter
string
limit
integer | null
excludeHidden
string
default:
true
Response
200 - application/json
data
object[]
required
Show child attributes
data.
id
string
required
data.
isCollapsible
boolean
required
data.
isRequired
boolean
required
data.
loyaltyGroupItems
object[]
required
Show child attributes
data.loyaltyGroupItems.
id
string
required
data.loyaltyGroupItems.
loyaltyRule
object
required
Show child attributes
data.loyaltyGroupItems.loyaltyRule.
description
string | null
required
data.loyaltyGroupItems.loyaltyRule.
id
string
required
data.loyaltyGroupItems.loyaltyRule.
name
string
required
data.loyaltyGroupItems.
sortId
number
required
data.
name
string
required
data.
sortId
number
required
data.
subTitle
string | null
required
hasNextPage
boolean
required
Get Processing status for a specific user on loyalty rules
Get Loyalty Rule Edits