Jump to Content

Github NPM Official Website

Integration Steps API Reference Changelog Discussions

Github NPM Official Website API Reference

API Reference

Integration Steps API Reference Changelog Discussions

Admin API

Authentification
Auth
- Returns the current user informationget
- Set user propertyput
Integrations
Rewarder
- Returns information about used rewarder keyget
Feedback
- Create a feedbackpost
I18n
- Get a language bundleget

Player API

Users
Perks
System
- Get information about all game levelsget
Quests
Daily
- Claim daily bonuspost
Rewards
- Get all reward definitionsget
Achievements
Reward Rules
- Get visible and enabled reward rules infoget
Leaderboards
Inventory
- Get player inventory activityget
- Get user inventory historyget

Redeem Options API

Redeem Options
- Get redeem options available for userget
- Get transaction by idget
Redeem Providers
- Handle external eventpost
- Handle user eventpost

Admin API

Authentification
Auth
- Returns the current user informationget
- Set user propertyput
Integrations
Rewarder
- Returns information about used rewarder keyget
Feedback
- Create a feedbackpost
I18n
- Get a language bundleget

Player API

Users
Perks
System
- Get information about all game levelsget
Quests
Daily
- Claim daily bonuspost
Rewards
- Get all reward definitionsget
Achievements
Reward Rules
- Get visible and enabled reward rules infoget
Leaderboards
Inventory
- Get player inventory activityget
- Get user inventory historyget

Redeem Options API

Redeem Options
- Get redeem options available for userget
- Get transaction by idget
Redeem Providers
- Handle external eventpost
- Handle user eventpost

Level up a perk

post https://{domain}.apps.scrimmage.co/p2e/players/@me/perks/{id}/level-up

Language

Credentials

Bearer

JWT

URL

Click Try It! to start a request and see the response here!