API reference

Waitlister API

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-Key header

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": "[email protected]",
    "name": "John Doe"
  }'

Next Steps

1. Authentication
2. Rate limits
3. Code examples
4. Endpoints

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