API Reference
API Endpoints
The Waitlister API provides several endpoints for managing your waitlist programmatically. This page gives an overview of all available endpoints organized by category.
Endpoint Categories
Waitlister API endpoints are organized into categories based on their functionality.
Subscribers Endpoints
These endpoints allow you to manage your waitlist subscribers.
| Endpoint | Method | Description |
|---|---|---|
| Add Subscriber | POST | Add a new subscriber to your waitlist |
Analytics Endpoints
These endpoints help you track key metrics for your waitlist.
| Endpoint | Method | Description |
|---|---|---|
| Log View | POST | Record a view of your waitlist |
Common Parameters
All endpoints share some common parameters.
Path Parameters
{waitlist-key}- Your unique waitlist key, found in your waitlist settings
Headers
All API requests require these headers:
Content-Type: application/json
X-Api-Key: your-api-key
Response Format
All API endpoints return responses in JSON format with a consistent structure:
Success Response
{
"success": true,
"message": "Operation successful",
// Additional data specific to the endpoint
}
Error Response
{
"success": false,
"error": {
"code": "error_code",
"message": "Human-readable error message"
}
}
Response Codes
The API uses standard HTTP response codes.
| Code | Description |
|---|---|
200 | Success |
400 | Bad request (invalid parameters) |
401 | Authentication error (invalid API key) |
403 | Permission error (insufficient plan level) |
404 | Resource not found |
429 | Rate limit exceeded |
500 | Server error |
Coming Soon
We're continuously improving our API. Here are some endpoints we plan to add in the future.
- Get Subscriber - Retrieve information about a specific subscriber
- Update Subscriber - Update a subscriber's information
- Get Subscribers - List all subscribers with filtering options
- Delete Subscriber - Remove a subscriber from your waitlist
Stay tuned for updates to our API documentation as we add these new features.