Comment on page
Endpoints
Our public API is rate limited at 100 requests per seconds.
To get faster response time, higher rate limits, priority support, or SLA, reach out to [email protected] and get more details about our premium plans.
To generate an API Key, go to settings, tab "API Key". Keep it secret. Only requests including this API Key can access the data of your community.
get
https://api.zealy.io
/communities/:subdomain/users
Find user by social IDs
get
https://api.zealy.io
/communities/:subdomain/users/:id
Find user by ID
post
https://api.zealy.io
/communities/:subdomain/users/:userId/xp
Give XP to a specific user
delete
https://api.zealy.io/communities/:subdomain/users/:userId
/xp
Remove XP from a specific user
get
https://api.zealy.io
/communities/:subdomain/leaderboard
Return the current community leaderboard
get
https://api.zealy.io
/communities/:subdomain/leaderboard/sprint
Return the current leaderboard sprint
get
https://api.zealy.io
/communities/:subdomain/claimed-quests
Return the list of claimed-quests
post
https://api.zealy.io
/communities/:subdomain/claimed-quests/review
Review the specified claimed quests
get
https://api.zealy.io
/communities/:subdomain/users/:userId/invites
Retrieves the list of invites sent by a user within a community
post
https://api.zealy.io
/communities/:subdomain/users/:userId/ban
Ban a user from a community
Last modified 4d ago