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.
Account Endpoints
This account-scoped endpoint verifies an account API key (wl_acct_…) and reports what it can do. It works on every plan, and is the recommended first call of any integration.
| Endpoint | Method | Description | Rate Limit Category |
|---|---|---|---|
| Get Account | GET | Verify a key and read the plan, waitlist allowance, and AI credits | Get Account |
Waitlists Endpoints
These account-scoped endpoints let you create and list waitlists programmatically. They require an account API key (wl_acct_…) and work on every plan within your plan's waitlist limit.
| Endpoint | Method | Description | Rate Limit Category |
|---|---|---|---|
| Create Waitlist | POST | Create a new waitlist with dashboard defaults | Create Waitlist |
| List Waitlists | GET | List every waitlist your account owns | List Waitlists |
Subscribers Endpoints
These endpoints allow you to manage your waitlist subscribers. Add Subscriber works on every plan with an account API key. The others require the Growth plan or higher.
| Endpoint | Method | Description | Rate Limit Category |
|---|---|---|---|
| Add Subscriber | POST | Add a new subscriber to your waitlist | Subscriber Endpoints |
| List Subscribers | GET | Retrieve a paginated list of subscribers | List Subscribers |
| Get Subscriber | GET | Retrieve information about a specific subscriber by ID or email | Subscriber Endpoints |
| Update Subscriber | PUT | Update a subscriber's information | Subscriber Endpoints |
| Delete Subscriber | DELETE | Delete a subscriber by ID or email | Subscriber Endpoints |
| List Tags | GET | List the waitlist's subscriber tags and how many subscribers have each | Subscriber Endpoints |
Analytics Endpoints
These endpoints help you track key metrics for your waitlist. Get Stats works on every plan with an account API key. Log View requires the Growth plan or higher.
| Endpoint | Method | Description | Rate Limit Category |
|---|---|---|---|
| Log View | POST | Record a view of your waitlist | Log View & Stats Endpoints |
| Get Stats | GET | Read subscriber and view totals for social-proof widgets | Log View & Stats Endpoints |
Landing Page Endpoints
These endpoints manage your waitlist's hosted landing page. They work on every plan with an account API key.
| Endpoint | Method | Description | Rate Limit Category |
|---|---|---|---|
| Get Landing Page | GET | Read the page's status, copy, and analytics | Landing Page Endpoints |
| Create Landing Page | POST | Create the page from structured fields, as a draft | Landing Page Endpoints |
| Update Landing Page | PATCH | Update any subset of the page's fields | Landing Page Endpoints |
| Publish Landing Page | POST | Publish or unpublish the page | Landing Page Endpoints |
| Generate Landing Page (AI) | POST | Generate or edit the page with the AI builder | Landing Page Endpoints |
Common Parameters
All endpoints share some common parameters.
Path Parameters
{waitlist-key}- Your unique waitlist key, shown on your waitlist's Overview page
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 fields are included depending on the endpoint (e.g. data, position, referral_code).
Error Response
{
"error": true,
"statusCode": 403,
"message": "Human-readable error message"
}
Read message for the reason. Errors also include url and statusMessage, and some add details in data, such as data.retry_after on a 429.
Response Codes
The API uses standard HTTP response codes.
| Code | Description |
|---|---|
200 | Success |
201 | Created |
400 | Bad request (invalid parameters) |
401 | Authentication error (invalid API key) |
402 | Not enough AI credits |
403 | Permission error (your plan doesn't include this endpoint or key type, or you've reached your waitlist limit) |
404 | Resource not found |
409 | Conflict (for example, the name or slug is taken, or a landing page already exists) |
422 | The landing page failed publish validation |
429 | Rate limit exceeded |
500 | Server error |
502 | AI generation failed upstream — safe to retry |
503 | The landing-page API is temporarily disabled |
504 | AI generation timed out |