API Documentation

Authorization: Bearer eyJhbG...

{ "token": "eyJhbG...", "user": { "id": "...", "name": "John", "email": "john@example.com", "role": "user" } }

{ "token": "eyJhbG...", "user": { "id": "...", "email": "john@example.com", "name": "John", "role": "user", "creditsRemaining": 100 } }

{ "id": "usr_abc", "name": "John", "email": "john@example.com", "plan": "pro", "role": "user", "creditsRemaining": 950 }

{ "stats": { "totalContacts": 150, "activeCampaigns": 3, "emailsSent": 1200, "openRate": 45.5, "replyRate": 8.2 } }

{ "campaigns": [{
 "id": "cmp_abc", "name": "Q1 Outreach", "status": "active",
 "list": { "id": "...", "name": "Prospects" },
 "sequences": [...],
 "emailStats": { "total": 100, "sent": 95, "failed": 2, "bounced": 3, "queued": 0 }
}] }

{ "campaign": { "id": "cmp_abc", "name": "Q1 Outreach", "status": "draft", "sequences": [...] } }

{ "success": true, "message": "Campaign started successfully" }

{ "success": true, "campaign_id": "cmp_xyz", "stats": { "total": 50, "queued": 50 }, "credits_remaining": 900 }

{ "lists": [{
 "id": "list_abc", "name": "Prospects", "contactCount": 150,
 "createdAt": "2026-01-01T00:00:00Z", "_count": { "contacts": 150 }
}] }

{ "list": { "id": "list_abc", "name": "Anthropic Leads", "contacts": [...] } }

{ "contacts": [...], "total": 150, "page": 1, "totalPages": 3 }

{ "action": "move", "contactIds": ["id1", "id2"], "targetListId": "list_xyz" }

{ "targetListId": "list_xyz" }

{
 "leads": [
 { "name": "John Doe", "firstName": "John", "lastName": "Doe", "title": "Engineer",
 "company": "Anthropic", "email": "john@anthropic.com", "linkedinUrl": "",
 "source": "github", "confidence": 70 }
 ],
 "total": 25,
 "sources": { "github": 10, "github_advanced": 8, "web_search": 5, "pattern": 2 },
 "verified": 18,
 "credits_used": 25,
 "credits_remaining": 49975
}

{ "created": 10, "errors": 2, "errorDetails": [{ "email": "dup@example.com", "error": "Already exists in list" }], "listId": "list_abc" }

{
 "email": "user@example.com", "is_valid": true, "syntax_valid": true,
 "mx_found": true, "is_disposable": false, "is_role_based": false,
 "is_catch_all": false, "confidence": 95, "credits_remaining": 99
}

{ "domain": "anthropic.com" }

{ "emails": [{ "subject": "...", "body": "..." }] }

{ "domain": "mail.example.com" }

{ "domain": { "id": "...", "domain": "example.com", "spfVerified": true, "dkimVerified": false, "dmarcVerified": true }, "dnsRecords": [...] }

{ "data": { "domain": "example.com", "hasMx": true, "spf": true, "dmarc": true, "mxRecords": [...], "dnsRecords": [...] } }

{ "account": { "id": "...", "email": "sender@example.com", "provider": "smtp", "dailyLimit": 50, "warmupEnabled": true, "healthScore": 100 } }

{ "provider": "smtp", "credentials": { "host": "smtp.example.com", "port": 465, "user": "user@example.com", "pass": "pass" } }

{ "accounts": [{
 "id": "...", "email": "sender@example.com", "provider": "smtp",
 "warmupEnabled": true, "warmupStartDate": "...", "healthScore": 85,
 "dailyLimit": 50, "warmupDay": 15, "warmupProgress": 50
}] }

{ "success": true, "message": "Reply detection started" }

{ "template": { "id": "tpl_abc", "name": "Welcome Email", "subject": "...", "body": "...", "variables": ["firstName", "company"] } }

{
 "summary": { "total": 100, "sent": 95, "delivered": 90, "opened": 45, "replied": 8, "bounced": 5, "failed": 0 },
 "daily": [
 { "date": "2026-01-01", "sent": 50, "delivered": 48, "opened": 20, "replied": 3, "bounced": 2 }
 ]
}

{ "test": {
 "id": "...", "name": "Subject Line Test", "status": "running", "winningMetric": "open_rate",
 "variants": [
 { "id": "...", "name": "Variant A", "subject": "Quick question", "sentCount": 50, "openCount": 20, "replyCount": 3 },
 { "id": "...", "name": "Variant B", "subject": "Hey {{firstName}}", "sentCount": 50, "openCount": 25, "replyCount": 5 }
 ]
} }

{ "event": "email.opened", "timestamp": "2026-01-01T12:00:00Z", "data": { "emailId": "...", "recipient": "john@example.com" } }

{ "logs": [{
 "id": "...", "event": "email.opened", "payload": {...}, "status": "delivered",
 "statusCode": 200, "success": true, "createdAt": "..."
}] }

{ "memberId": "member_abc" }

{ "token": "invite_token_from_email" }

{ "apiKey": { "id": "...", "name": "My Integration", "key": "cr_a1b2c3d4...", "permissions": ["read", "write"], "rateLimit": 1000 } }

{ "success": true, "message": "Contact resubscribed" }