Zealy API
  • Introduction
  • Authentication
  • Use cases
  • Rate limits
  • Pagination
  • FAQ
  • API Reference
    • Communities
      • Community lookup
      • Community member check
      • Community Secret Retrieval
      • Community Secret Creation
    • Users
      • User lookup
      • Add & Remove XP
      • Ban user
      • Referral code
      • Delete Zealy Connect for member
    • Leaderboards
      • Retrieve a leaderboard
      • List sprints
    • Reviews
      • Claimed quests lookup
      • Review a submission
      • Review events
    • Modules
    • Quests
      • Create quest
      • Update quest
      • List quests
    • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Users

Referral code

PreviousBan userNextDelete Zealy Connect for member

Last updated 1 year ago

Was this helpful?

Overview

This endpoint allows you to retrieve a user referral code. A referral code is the code used by the user to invite other users in your community.

API Reference

Get the referral code for a user

get
Path parameters
subdomainstringRequired
userIdstring ยท uuidRequired
Header parameters
x-api-keystringRequired
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
409
409
application/json
429
429
application/json
500
500
application/json
get
GET /public/communities/{subdomain}/users/{userId}/referral-code HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Accept: */*

{
  "code": "text"
}
  • Overview
  • API Reference
  • GETGet the referral code for a user