referrals

Get the referral leaderboard

get/admin/referrals

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/admin/referrals
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Query parameters

tenant_idstring

tenant_id

qstring

referrer username / email (substring) or account id (exact)

group_idstring uuid

only referrers who are members of this group; 404 group_not_found if the group is not visible to you

exclude_group_idstring uuid

drop referrers who are members of this group; 404 group_not_found if not visible

sort'referred_desc' | 'referred_asc' | 'kyc_verified_desc' | 'name_asc'

ordering

limitinteger

page size

offsetinteger

page offset

Response

OK

limitinteger
offsetinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.