Jump to Content
User Guide
Gamification Guide
Developer Guide
API Reference
Home
User Guide
API Reference
Changelog
User Guide
Gamification Guide
Developer Guide
API Reference
Xtremepush.com
API Reference
Xtremepush.com
API Reference
Get all perks
All
Pages
Start typing to search…
JUMP TO
External API
Campaign methods
Campaign model properties
Create
post
Send
post
Update
post
Info
post
List
post
Execute
post
Cancel journey
post
Start
post
Stop
post
Remove inbox
post
Expire inbox
post
User profile methods
Import
post
Info
post
List
post
Profile subscription
post
Profile attribute
post
Profile consent preference
post
Device methods
Info
post
List
post
Event methods
Hit event
post
Batch hit
post
Tag methods
Create
post
Batch create
post
Hit
post
Hit tags
post
List
post
List hit
post
List attribute client
post
List methods
Create
post
Import
post
Update
post
Delete
post
Info
post
List
post
List items
post
Suppression import
post
Segmentation methods
Segment model properties
Create
post
Update
post
Delete
post
Info
post
List
post
PII deletion methods
Delete personal data
post
Delete device personal data
post
Task methods
List
post
Info
post
Message methods
Info
post
List push
post
List push devices
post
Analytics methods
New users
post
Total sessions
post
Unique sessions
post
Total sessions time
post
Average sessions time
post
Statistics
post
Campaigns stats
post
Location hits
post
Real-time methods
Follow
post
Unfollow
post
Promotion methods
List promotions
post
One-Time Password (OTP) Methods
OTP Generate
post
OTP Execute
post
OTP Verify
post
OTP History List
post
OTP History Info
post
Trigger Segment Export
post
Download File by ID
post
Loyalty API
Perks
Get all perks
get
Get perk by id
get
Rewards
Get all reward definitions
get
Get all modifiers definitions
get
Get all promotions
get
Leaderboards
Get all leaderboards for the current player
get
Get leaderboard details with rankings
get
Get current player position in a leaderboard
get
Get player position with neighboring entries
get
Get top positions for a leaderboard
get
Feedback
Create a feedback
post
I18n
Get a language bundle
get
Widgets
Get the active widget config
get
Redeem Options
Get redeem options available for user
get
Get transaction by id
get
Redeem Providers
Handle external event
post
Handle user event
post
P2e
Get information about all game levels
get
Player
Returns the current user information
get
Create or update the current authenticated player
put
Get all available quests for the player
get
Accept quest
post
Cancel quest
post
Claim quest reward
post
Activate a perk. If perk can't be activated, potential replacements will be sent
post
Deactivate a perk
post
Level up a perk
post
Get user perks
get
Get player stats
get
Level up user
post
Get game information for user, use this for displaying game things
get
Claim daily bonus
post
Charge user tokens API
post
Get visible and enabled reward rules info
get
Get all achievements for the player
get
Claim achievement reward
post
Get player inventory activity
get
Get user inventory history grouped by event
get
Get user inventory history
get
Get player's profile
get
Get current player's profile
get
UserRewards
Choose a reward
post
Get all pending rewards
get
Polls
Get all available polls for the player
get
Submit a vote
post
Remove a vote
del
Cancel a poll
post
Get poll results
get
Assignments
Get all user assignments
get
Accept an assignment
post
Claim an assignment
post
WebSocket
WebSocket connection (Socket.IO)
get
Events
Get player inventory activity details
get
Powered by
Get all perks
Ask AI
get
https://{domain}/p2e/players/@/perks
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
domain
/p2e/players/@/perks
Response
Click
Try It!
to start a request and see the response here!