API Documentation

Integrate ReferralLoop into your application with our REST API

Getting Started

1Generate an API Key

Go to API Keys in your dashboard and create a new API key.

2Make Your First Request

curl undefined/api/v1/waitlists \
  -H "Authorization: Bearer pk_live_YOUR_API_KEY"

Base URL

/api/v1

Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer pk_live_YOUR_API_KEY

Endpoints

List Waitlists

GET

/api/v1/waitlists

Example Request

curl undefined/api/v1/waitlists \
  -H "Authorization: Bearer pk_live_YOUR_API_KEY"

List Signups

GET

/api/v1/waitlists/:waitlistId/signups

Query Parameters

limitNumber of results (default: 100, max: 1000)
offsetPagination offset (default: 0)

Example Request

curl undefined/api/v1/waitlists/WAITLIST_ID/signups?limit=50 \
  -H "Authorization: Bearer pk_live_YOUR_API_KEY"

Create Signup

POST

/api/v1/waitlists/:waitlistId/signups

Request Body

emailRequired. Email address
nameRequired. Full name
metadataOptional. Custom data object

Example Request

curl -X POST undefined/api/v1/waitlists/WAITLIST_ID/signups \
  -H "Authorization: Bearer pk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "name": "John Doe",
    "metadata": {
      "source": "landing_page"
    }
  }'

Delete Signup

DELETE

/api/v1/waitlists/:waitlistId/signups/:signupId

Example Request

curl -X DELETE undefined/api/v1/waitlists/WAITLIST_ID/signups/SIGNUP_ID \
  -H "Authorization: Bearer pk_live_YOUR_API_KEY"

Rate Limits

Free Plan

No API access

Starter Plan

1,000 requests per hour

Growth Plan

10,000 requests per hour

Pro Plan

100,000 requests per hour

Error Codes

400Bad Request - Invalid parameters

401Unauthorized - Invalid API key

404Not Found - Resource doesn't exist

409Conflict - Resource already exists

429Too Many Requests - Rate limit exceeded

500Internal Server Error