API Reference

API Authentication

All requests to the Waitlister API must be authenticated using an API key. This document explains how to obtain, use, and manage your API keys.

API Key Authentication

API keys provide a simple way to authenticate with the Waitlister API. Each key is associated with your specific waitlist and has access to all API endpoints available for your plan.

Authentication Header

Include your API key in the X-Api-Key header with each request.

X-Api-Key: your-api-key

Example request with an API key.

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]"
  }'

Getting Your API Key

To obtain an API key for your waitlist, follow these steps.

1. Log in to your Waitlister account
2. Go to the "Overview" page for your waitlist
3. Find the "API key" section
4. Click the highlighted value to open the API key modal
5. Click "Generate API key"

API Key Security

Your API key grants full access to your waitlist via the API. To keep your waitlist secure, follow these guidelines.

Best Practices

• Never expose your API key in client-side code (like JavaScript running in a browser)
• Store your API key securely as an environment variable or in a secure secrets manager
• Use a server-side application to make API requests that require your API key
• Implement proper error handling to avoid exposing your key in error messages or logs
• Rotate your API key regularly

Regenerating Your API Key

If you believe your API key has been compromised, you should regenerate it immediately.

1. Go to the "Overview" page for your waitlist
2. Click the API key value to open the API key modal
3. Click "Regenerate API key"
4. Confirm the action

Important: Regenerating your API key will invalidate the previous key. You'll need to update any applications or services using the old key.

Authentication Errors

If you encounter authentication issues, check for these common errors.

Next Steps

Now that you understand how to authenticate with the Waitlister API, you can:

• Learn about API rate limits
• Explore the subscribers endpoints
• Check out the analytics endpoints