API reference
Waitlister API
Fastest path: the complete one-page integration guide covers every option (form, embed, API, webhooks) with copy-paste code — ideal for AI agents and quick starts.
- Machine-readable spec: OpenAPI (JSON)
- Official SDK:
npm install waitlister
Waitlister provides a REST API that lets you programmatically manage your waitlist. This reference guide explains how to integrate your applications with our API.
API Overview
The Waitlister API is designed around REST principles. It uses standard HTTP methods and returns JSON responses, making it easy to integrate with any programming language or framework.
- Base URL:
https://waitlister.me/api/v1 - Content-Type: All requests and responses use JSON (
application/json) - Authentication: All endpoints require an API key passed via the
X-Api-Keyheader — either an account API key (wl_acct_…, works across all your waitlists and can create new ones) or a per-waitlist key
Example Request
Here's a simple example of how to add a subscriber using the API.
curl -X POST "https://waitlister.me/api/v1/waitlist/{waitlist-key}/sign-up" \
-H "Content-Type: application/json" \
-H "X-Api-Key: your-api-key" \
-d '{
"email": "user@example.com",
"name": "John Doe"
}'
Next Steps
Getting Help
If you encounter any issues or have questions about the API, you can:
- Check our detailed endpoint documentation
- Contact us via the public contact form
- Access the "Help" page in your account dashboard
