API Reference / Endpoints
List Waitlists
The List Waitlists endpoint returns every waitlist your account owns, with signup and view totals. It requires an account API key (wl_acct_…).
Endpoint Details
- URL:
https://waitlister.me/api/v1/waitlists - Method:
GET
Request
Headers
code
X-Api-Key: wl_acct_your-account-api-key
Example Request
bash
curl "https://waitlister.me/api/v1/waitlists" \
-H "X-Api-Key: wl_acct_your-account-api-key"
Response
Success Response 200
json
{
"success": true,
"data": {
"waitlists": [
{
"id": "aBcDeFgH123",
"key": "AbC123xYz456",
"name": "My Product",
"slug": "my-product",
"subscribers": 128,
"views": 2450,
"created_at": 1751700000000
}
],
"total": 1
}
}
Waitlist Object Fields
| Field | Type | Description |
|---|---|---|
id | String | Waitlist document ID |
key | String | Waitlist key — use it in every per-waitlist API path |
name | String | Waitlist name |
slug | String | URL slug of the waitlist |
subscribers | Number | Total signups |
views | Number | Total tracked views |
created_at | Number | Creation timestamp (Unix ms) |
Waitlists are sorted by creation date, newest first.
Error Responses
| Status Code | Description |
|---|---|
401 | Missing, invalid, or revoked account API key |
429 | Rate limit exceeded |
Next Steps
- Create a waitlist
- Read stats for a single waitlist
