← Back to Home

API Reference

Complete API documentation for integrating with FusionFlock's AI-powered platform

Authentication

All API requests require authentication using your API key. Include it in the Authorization header.

API Key Authentication

Include your API key in the Authorization header with the "Bearer" prefix.

Authorization: Bearer your_api_key_here

OAuth 2.0

For advanced integrations, use OAuth 2.0 for secure authentication and authorization.

Authorization: Bearer oauth_access_token

Campaigns API

GET /api/v1/campaigns

Retrieve a list of all campaigns for your account.

Query Parameters

Parameter Type Required Description
limit integer Optional Number of campaigns to return (default: 20, max: 100)
offset integer Optional Number of campaigns to skip (default: 0)
status string Optional Filter by campaign status (active, paused, completed) 
curl -X GET "https://api.fusionflock.net/v1/campaigns?limit=10&status=active" \
  -H "Authorization: Bearer your_api_key_here"

Response

200Success

{
  "data": [
    {
      "id": "camp_123",
      "name": "Q1 Lead Generation",
      "status": "active",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z",
      "leads_count": 150,
      "conversion_rate": 12.5
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1
  }
}
POST /api/v1/campaigns

Create a new campaign.

Request Body

Parameter Type Required Description
name string Required Campaign name
description string Optional Campaign description
target_audience object Required Target audience criteria
email_template string Required Email template ID 
curl -X POST "https://api.fusionflock.net/v1/campaigns" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q1 Lead Generation",
    "description": "Targeting tech companies for Q1",
    "target_audience": {
      "industry": "technology",
      "company_size": "50-500",
      "location": "United States"
    },
    "email_template": "template_123"
  }'

Response

201Created

{
  "data": {
    "id": "camp_123",
    "name": "Q1 Lead Generation",
    "status": "draft",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  }
}

Leads API

GET /api/v1/leads

Retrieve leads from your campaigns.

Query Parameters

Parameter Type Required Description
campaign_id string Optional Filter by campaign ID
status string Optional Filter by lead status (new, contacted, qualified, converted)
limit integer Optional Number of leads to return (default: 20, max: 100) 
curl -X GET "https://api.fusionflock.net/v1/leads?campaign_id=camp_123&status=new" \
  -H "Authorization: Bearer your_api_key_here"

Response

200Success

{
  "data": [
    {
      "id": "lead_123",
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "company": "Example Corp",
      "title": "VP of Sales",
      "status": "new",
      "created_at": "2025-01-15T10:30:00Z",
      "campaign_id": "camp_123"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 1
  }
}

Analytics API

GET /api/v1/analytics/campaigns/{campaign_id}

Get detailed analytics for a specific campaign.

Path Parameters

Parameter Type Required Description
campaign_id string Required Campaign ID 
curl -X GET "https://api.fusionflock.net/v1/analytics/campaigns/camp_123" \
  -H "Authorization: Bearer your_api_key_here"

Response

200Success

{
  "data": {
    "campaign_id": "camp_123",
    "name": "Q1 Lead Generation",
    "metrics": {
      "total_leads": 150,
      "emails_sent": 500,
      "open_rate": 25.5,
      "click_rate": 8.2,
      "response_rate": 12.5,
      "conversion_rate": 3.2
    },
    "period": {
      "start_date": "2025-01-01",
      "end_date": "2025-01-31"
    }
  }
}

SDK Downloads

Get started quickly with our official SDKs for popular programming languages

Python SDK Node.js SDK PHP SDK Ruby SDK Java SDK