<aside> 💡 If you want to query specific information about a user, such as their referral link and the amount of users they have referred, this is the resource for you! It's highly recommended to include a way for users to check their status at a later point — if you need it, this is your go-to resource!
Other customers of ours have typically used this route internally within their application to showcase # of referrals and the referral link for easy access. In other words, you decide what you show the user.
</aside>
POST <https://getwaitlist.com/api/v1/users/status>
api_key [string]: Your API key
email [string]: The email of the user you are querying information for
{
"api_key": "waitlist_id_123",
"email": "[email protected]"
}
current_priority [integer]: Current priority of user on the Waitlist (if you're using it for the purpose of a waitlist)
referral_link [string]: The referral link of the user who signed up
registered_email [string]: Email of the user that signed up. We return this so it's easier for you to show.
total_users [integer]: Total users on the waitlist. It gives the users an idea of how far ahead or behind on the waitlist they are.
total_referrals [integer]: Total number of successful referrals for this specific user (it will be 0 at first, but if the user signs up again by accident, we show their number of referral)
user_id [string]: A hash-value for the user on your waitlist. If you wish to create a traceable, yet unique, link for users, feel free to use this.
{
"current_priority": 42463,
"referral_link": "<https://yaywaitlist.com/sign_up?&ref_id=1234>",
"registered_email": "[email protected]",
"total_users": 842684,
"total_referrals": 3217,
"user_id": "577a68e3fbf501fda5e7959518c3bc3d"
}
400: Validation error or missing parameter. Please check that the email or waitlist_id is wrong