HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference

Get a user by a referral code

Looks up a user based upon their ReferralCode and returns their personal information. This method is useful for retrieving the user when only the Referral Code is available, for example when a referred friend enters a Referral Code during checkout and you want to find out who this Referral Code belongs to.

This is an Open Endpoint and disabled by default. Contact support to enable the open endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

Query Params
string
required

The code with which to lookup the user, E.g. "BOBTESTERSON". This can be a user's primary or non primary referral code.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json