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.

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.

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	Subscriber Endpoints
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

Analytics Endpoints

These endpoints help you track key metrics for your waitlist.

Endpoint	Method	Description	Rate Limit Category
Log View	POST	Record a view of your waitlist	Log View Endpoint
Get Stats	GET	Read subscriber and view totals for social-proof widgets	Log View & Stats Endpoints

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:

code

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

json

{
  "success": true,
  "message": "Operation successful"
}

Additional fields are included depending on the endpoint (e.g. data, position, referral_code).

Error Response