Skip to main content
Coming Soon

The public API is currently in development. This documentation shows what's planned.

API Reference

Build integrations with the Suparev REST API. Manage leads, campaigns, and analytics programmatically.

Base URL: https://api.suparev.com/v1

Quick Start

1. Get your API key

Generate an API key from your dashboard at Settings → API Keys

2. Make your first request

curl -X GET "https://api.suparev.com/v1/leads" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

3. Handle the response

{
  "data": [
    {
      "id": "lead_abc123",
      "email": "customer@example.com",
      "name": "John Smith",
      "score": 85,
      "segment": "past_customer",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 1247,
    "page": 1,
    "per_page": 20
  }
}

Authentication

Bearer Token Authentication

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

Authorization: Bearer your_api_key_here

Security: Never expose your API key in client-side code. Always make API calls from your server.

Endpoints

Authentication

POST/auth/tokenGet an access token
POST/auth/refreshRefresh an expired token

Leads

GET/leadsList all leads
POST/leadsCreate a new lead
GET/leads/:idGet a specific lead
PATCH/leads/:idUpdate a lead
DELETE/leads/:idDelete a lead
POST/leads/importBulk import leads

Campaigns

GET/campaignsList all campaigns
POST/campaignsCreate a new campaign
GET/campaigns/:idGet campaign details
POST/campaigns/:id/launchLaunch a campaign
POST/campaigns/:id/pausePause a campaign

Messages

GET/messagesList sent messages
GET/messages/:idGet message details
GET/repliesList replies

Analytics

GET/analytics/overviewDashboard overview stats
GET/analytics/campaigns/:idCampaign performance
GET/analytics/revenueRevenue attribution

Webhooks

Real-time Event Notifications

Configure webhook endpoints in your dashboard to receive real-time notifications when events occur in your Suparev account.

Available Events

lead.createdA new lead was created
lead.updatedA lead was updated
campaign.launchedA campaign was launched
message.sentA message was sent
reply.receivedA reply was received
booking.createdAn appointment was booked
payment.receivedA payment was processed

Rate Limits

API requests are rate limited to ensure fair usage and platform stability.

100
requests/minute
5,000
requests/hour
50,000
requests/day

Rate limit headers are included in all responses. Need higher limits? Contact us for enterprise plans.

SDKs & Libraries

Official SDKs for popular languages coming soon. In the meantime, our REST API works great with any HTTP client.

JavaScript coming soonPython coming soonRuby coming soonPHP coming soonGo coming soon
Need help with your integration? Contact us →