Unauthenticated Waitlist API
This is an unauthenticated API, meaning that there is no authentication required. All objects returned are publicly viewable and do not expose sensitive data. Only active Waitlists can be queried by this route; querying deactivated Waitlists will error.
Get Waitlist
Retrieve summary information for a given Waitlist. Only active Waitlists can be queried by this route; querying deactivated Waitlists will error
Query String Attributes
- Name
api_key
- Type
- string
- Description
The API key of your waitlist. This can be found on your dashboard.
Response
The response is a Waitlist object and contains all the information you need about your waitlist. Note that some of the returned data is mostly relevant for the no-code widget and not the API.
Request
curl --request GET \
--url https://api.getwaitlist.com/api/v1/waitlist?api_key=<API_KEY>
Response
{
"id": 213,
"api_key": "AB2jc8",
"configuration_style_json": {...},
"created_at": "2023-02-01_06-05-33",
"logo": null,
"spots_to_move_upon_referral": 3,
"uses_firstname_lastname": false,
"uses_leaderboard": true,
"uses_waiter_verification": false,
"waitlist_name": "Title",
"waitlist_url_location": "https://getwaitlist.com",
"statistics": {
'total_signups': 2200,
'current_waiters': 2200,
},
"title": null,
"required_contact_detail": "EMAIL",
"widget_shows_social_links": false,
"signup_button_title": "Sign Up",
"widget_answers": {},
"widget_questions": {},
"uses_zapier": true,
"uses_waitlist_widget_branding": self.uses_waitlist_widget_branding,
"email_configuration_json": {},
"twitter_message": "",
"send_email_congratulations_on_referral": true,
"organization_uuid_fk": "30120c24-0ddc-4f35-9bc6-f5e3c7b09257",
}
Get Waitlist Leaderboard
Use this route if you want to get the leaderboard for a Waitlist. You can find the ID for your Waitlist in your dashboard (under API key) in the "General" tab. Make sure to use the ID and not the API key.
Optional Query String Attributes
- Name
total_waiters
- Type
- string
- Description
The total number of waiters you want to return as part of the response. The default is
5
if you do not include this query string parameter.
Response
- Name
leaderboard
- Type
- array of objects
- Description
An array with all the leaders in your waitlist ordered by the total referrals they have made. The highest referrer will be first in the array.
- Name
amount_referred
- Type
- string
- Description
Total number of referrals a waiter has made
- Name
email
- Type
- string
- Description
The censored email of the waiter. For example
bani@getwaitlist.com
is censored asb***@g**************
.
- Name
first_name
- Type
- string
- Description
The first name of the waiter. We show the full name.
- Name
last_name
- Type
- string
- Description
The last name of the waiter. We only show the first letter of their last name. For example
Sawyer
is censored asS.
- Name
id
- Type
- string
- Description
The id of the waiter
- Name
phone
- Type
- string
- Description
The censored phone number of the waiter. This is helpful for mobile-only waitlists. We only show the three first digits of the phone number. For example
123 456 7891
is censored as123 *** ****
Request
curl --request GET \
--url https://api.getwaitlist.com/api/v1/waitlist/<ID>/leaderboard?total_waiters=5
Leaderboard Response Example
{
'leaderboard': [
{'amount_referred': 5, 'email': 'b***@g**************', 'first_name': 'Brittany', 'id': 1, 'last_name': 'S.', 'phone': '415 *** ****'},
{'amount_referred': 4, 'email': 'b*****@g**************', 'first_name': 'Bianca', 'id': 2, 'last_name': 'G.', 'phone': '234 *** ****'},
{'amount_referred': 1, 'email': 'b*****@g**************', 'first_name': 'Bonnie', 'id': 3, 'last_name': 'L.', 'phone': '123 *** ****'},
{'amount_referred': 1, 'email': 'b*****@g**************', 'first_name': 'Brian', 'id': 4, 'last_name': 'N.', 'phone': '117 *** ****'},
{'amount_referred': 0, 'email': 'b*****@g**************', 'first_name': 'Breanna', 'id': 5, 'last_name': 'K.', 'phone': '324 *** ****'},
]
}