API Reference

API Documentation

Complete reference for the Joiner REST API. Integrate waitlist functionality directly into your applications.

Base URL

All API requests should be made to this base URL

https://api.hijoiner.com/api/v1

Authentication

How to authenticate your API requests

All authenticated endpoints require a Bearer token in the Authorization header:

Authorization: Bearer your_access_token

Public endpoints (like the subscribe endpoint) don't require authentication but are rate-limited.

Authentication

POST/api/v1/auth/loginAuthenticate user and receive access token

POST/api/v1/auth/registerCreate a new user account

POST/api/v1/auth/refreshRefresh access token using refresh token

Forms

GET/api/v1/formsList all forms for the authenticated user

POST/api/v1/formsCreate a new waitlist form

GET/api/v1/forms/:idGet details of a specific form

PUT/api/v1/forms/:idUpdate an existing form (including slug)

DELETE/api/v1/forms/:idDelete a form

GET/api/v1/public/forms/:idOrSlugGet public form data by ID or slug (no auth)

Subscribers

GET/api/v1/subscribersList all subscribers across forms

POST/api/v1/public/forms/:formId/subscribeAdd a new subscriber to a form (public, no auth)

GET/api/v1/forms/:formId/subscribersList subscribers for a specific form

DELETE/api/v1/subscribers/:idRemove a subscriber

POST/api/v1/subscribers/exportExport subscribers as CSV

Analytics

GET/api/v1/analytics/overviewGet dashboard overview statistics

GET/api/v1/analytics/forms/:idGet analytics for a specific form

Webhooks

GET/api/v1/webhooksList configured webhooks

POST/api/v1/webhooksCreate a new webhook

DELETE/api/v1/webhooks/:idDelete a webhook

Need help with the API?

Check out our guides or reach out to support for assistance.