API Docs — StackHype

API Documentation

Authentication

Management API endpoints require authentication via:

Session cookie — automatic from the web UI
API key — Authorization: Bearer sh_your_key. Create keys in Settings.

Public Endpoints (No Auth)

These work on any active waitlist by slug. No API key needed.

GET /w/:slug — Public waitlist signup page
HTML page with signup form. Append ?ref=CODE for referral tracking.

POST /w/:slug/signup — Register a new signup

            {"email": "[email protected]", "name": "Jane", "ref": "abc123"}
          

Returns: position, referral_code, referral_count, thank_you_message. If already signed up, returns existing data.

GET /w/:slug/[email protected] — Check position

Returns current position, referral code, referral count, and status.

GET /w/:slug/stats — Public stats

Returns waitlist name and total signup count. Good for live counters.

Waitlists API (Auth Required)

GET /api/waitlists — List your waitlists

Returns all waitlists with signup counts.

POST /api/waitlists — Create waitlist

            {"name": "My Launch", "description": "...", "referral_boost": 5, "max_signups": 1000}
          

GET /api/waitlists/:id — Waitlist detail + signups

Paginated. Query: ?page=2 (50 per page, sorted by priority score).

PUT /api/waitlists/:id — Update settings

            {"name": "...", "is_active": true, "show_position": true, "show_referral_count": true, "referral_boost": 10, "redirect_url": "https://...", "thank_you_message": "...", "max_signups": null}
          

All fields optional — partial updates supported.

DELETE /api/waitlists/:id — Delete waitlist + all signups

GET /api/waitlists/:id/export — Download CSV

Returns email, name, referrals, position, score, status, joined as a downloadable CSV file.

Referral System

Every signup gets a unique referral code. When someone signs up via a referral link, the referrer's priority score increases by referral_boost points (default: 5), moving them up the list.

          Referral URL format:

          https://canterforge.com/cronsafe/w/YOUR_SLUG?ref=REFERRAL_CODE

Position is calculated by priority score (descending), then original signup order. Referrers get email notifications when someone uses their link.

Quick Start

1. Create a waitlist — from the dashboard or via API
2. Share the link — https://canterforge.com/cronsafe/w/your-slug
3. Signups roll in — each signup gets a referral link automatically
4. Track growth — dashboard shows real-time signups, referral leaderboard
5. Export when ready — download CSV to import into your email tool

Embed a Live Counter

Show real-time signup count on your landing page:

          fetch('https://canterforge.com/cronsafe/w/YOUR_SLUG/stats')

            .then(r => r.json())

            .then(d => document.getElementById('count').textContent = d.total_signups)