API Reference
LocalReach Rewards API
Programmatic access to campaigns, creators, tracking, and payouts.
REST API
Standard REST endpoints for all resources
API Keys
Manage keys in your dashboard
Webhooks
Real-time event notifications
Rate Limits
1000 requests per minute per key
HTTPS Only
All traffic encrypted in transit
Versioned
URL-based versioning (v1)
Authentication
Include your API key in the Authorization header:
Authorization: Bearer lr_live_xxxxxxxxxxxxx
API keys are available on Pro and Enterprise plans. Get your key from Settings → API Keys in your dashboard.
Endpoints
| Method | Path | Description | Auth |
|---|---|---|---|
| GET | /api/v1/campaigns | List all campaigns | Required |
| POST | /api/v1/campaigns | Create a campaign | Required |
| GET | /api/v1/campaigns/:id | Get campaign details | Required |
| PATCH | /api/v1/campaigns/:id | Update campaign | Required |
| POST | /api/v1/campaigns/:id/creators | Add creator to campaign | Required |
| GET | /api/v1/campaigns/:id/submissions | List submissions | Required |
| POST | /api/v1/submissions | Create submission | Required |
| PATCH | /api/v1/submissions/:id | Update submission status | Required |
| GET | /api/v1/codes/generate | Generate tracking codes | Required |
| POST | /api/v1/track | Record tracking event | Public |
| GET | /api/v1/public/:slug | Get public result page | Public |
| GET | /api/v1/leaderboard/:campaignId | Get campaign leaderboard | Required |