API Reference / Endpoints
Get Stats
The Get Stats endpoint returns your waitlist's headline numbers — total subscribers and total views — straight from the waitlist's analytics counters. It's designed to be cheap and fast, so you can poll it for "X people waiting" social-proof widgets on your site.
With an account API key (wl_acct_…) this endpoint works on every plan. Per-waitlist API keys work on the Growth plan or higher.
Never expose an API key in client-side code — fetch stats from your server (or at build time) and render the number into the page.
Endpoint Details
- URL:
https://waitlister.me/api/v1/waitlist/{waitlist-key}/stats - Method:
GET
Request
Headers
X-Api-Key: your-api-key
Path Parameters
| Parameter | Description |
|---|---|
waitlist-key | Your unique waitlist key, found in your waitlist settings |
Example Request
curl "https://waitlister.me/api/v1/waitlist/your-waitlist-key/stats" \
-H "X-Api-Key: your-api-key"
Response
Success Response 200
{
"success": true,
"data": {
"subscribers_total": 128,
"views_total": 2450,
"referral_program_enabled": true
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
subscribers_total | Number | Total signups — the "X people waiting" number |
views_total | Number | Total tracked views across your form and landing page |
referral_program_enabled | Boolean | Whether the referral program is enabled for this waitlist |
Error Responses
| Status Code | Description |
|---|---|
401 | Invalid API key or waitlist key |
429 | Rate limit exceeded |
Example: Social-Proof Widget
Fetch the count server-side and render it into your page:
const res = await fetch(
`https://waitlister.me/api/v1/waitlist/${process.env.WAITLISTER_WAITLIST_KEY}/stats`,
{ headers: { 'X-Api-Key': process.env.WAITLISTER_API_KEY } }
)
const { data } = await res.json()
// → `Join ${data.subscribers_total} people on the waitlist`
Next Steps
- Log views to feed the
views_totalcounter - Add subscribers via the API
