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.

EndpointMethodDescriptionRate Limit Category
Add SubscriberPOSTAdd a new subscriber to your waitlistSubscriber Endpoints
List SubscribersGETRetrieve a paginated list of subscribersSubscriber Endpoints
Get SubscriberGETRetrieve information about a specific subscriber by ID or emailSubscriber Endpoints
Update SubscriberPUTUpdate a subscriber's informationSubscriber Endpoints

Analytics Endpoints

These endpoints help you track key metrics for your waitlist.

EndpointMethodDescriptionRate Limit Category
Log ViewPOSTRecord a view of your waitlistLog View Endpoint

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.

CodeDescription
200Success
400Bad request (invalid parameters)
401Authentication error (invalid API key)
403Permission error (insufficient plan level)
404Resource not found
429Rate limit exceeded
500Server error

Rate Limits

Different endpoint categories have different rate limits. See the Rate Limits page for details.

PlanSubscriber EndpointsLog View Endpoint
Pro60 RPM200 RPM
Scale120 RPM400 RPM

Get started for free

Start collecting sign ups for your product launch in minutes — no coding required.