Skip to main content
Referrals.com
REST API v1

Referrals.com Developer Portal

Build and automate referral programs with our REST API. Create brands, launch campaigns, track participants, and process rewards programmatically.

Quick Start

1

Create an account & generate an API key

Sign up at referrals.com/signup, then go to API Keys in your dashboard. Each key is scoped to your account.

2

Add your domain as a brand

curl -X POST https://referrals.com/api/v1/brands \
  -H "X-API-Key: ref_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://yourdomain.com", "description": "My Brand"}'
3

Launch a campaign

curl -X POST https://referrals.com/api/v1/campaigns \
  -H "X-API-Key: ref_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"name": "Summer Referral Program", "url_id": 1}'
4

Register participants & track referrals

curl -X POST https://referrals.com/api/v1/signups \
  -H "X-API-Key: ref_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"campaign_id": 1, "email": "[email protected]", "name": "Jane"}'

Explore the Portal

API Reference

Complete REST API documentation with request/response examples for every endpoint.

API Playground

Test API calls live in your browser. Enter your API key and explore endpoints interactively.

Knowledgebase

Guides, tutorials, and best practices for integrating referral programs into your product.

Support

Get help with your integration. FAQs, troubleshooting, and contact our developer support team.

API Highlights

API Key Auth

Generate API keys from your dashboard. One key gives access to all your brands and campaigns.

Webhooks

Get notified in real-time when participants sign up. Integrates with Zapier and custom endpoints.

Reward Processing

Automatic reward allocation — coupons, cash, and custom messages — when referral goals are met.

Base URL

https://referrals.com/api/v1

Authentication

X-API-Key: ref_your_api_key_here