—credits

API Reference

Integrate LeadOS leads directly into your CRM or workflow.

Authentication

All API requests require a Bearer token. Use the API key from Settings → API Keys.

curl https://api.leados.net/v1/leads \
  -H "Authorization: Bearer ldo_live_sk_your_key_here"

Webhook Verification

Every webhook request is signed with HMAC-SHA256. Verify using the X-LeadOS-Signature header.

import hmac, hashlib

def verify_signature(payload: bytes, signature: str, secret: str) -> bool:
    expected = "sha256=" + hmac.new(
        secret.encode(), payload, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(expected, signature)

Key Endpoints

GET
/v1/leads

List delivered leads (paginated, filterable)

GET
/v1/leads/stats

Delivery stats by day

POST
/v1/leads/{id}/feedback

Submit lead quality feedback

GET
/v1/campaigns

List all campaigns

POST
/v1/campaigns

Create a new campaign

PATCH
/v1/campaigns/{id}

Update campaign settings

POST
/v1/campaigns/{id}/pause

Pause a campaign

POST
/v1/campaigns/{id}/resume

Resume a paused campaign

POST
/v1/webhooks

Register a webhook endpoint

POST
/v1/suppression

Add emails to suppression list

GET
/v1/usage/balance

Get current credit balance

GET
/v1/feedback/summary

Feedback stats and personalisation status

Webhook Payload

{
  "event": "lead.delivered",
  "delivery_id": "del_abc123",
  "campaign_id": "camp_abc123",
  "lead": {
    "id": "del_abc123",
    "full_name": "Raj Sharma",
    "job_title": "Founder",
    "company_name": "TechCorp Pvt Ltd",
    "company_domain": "techcorp.io",
    "company_size": "11-50",
    "company_industry": "SaaS",
    "geography": "Kathmandu, Nepal",
    "email": "raj@techcorp.io",
    "email_status": "valid",
    "phone": null,
    "linkedin_url": "https://linkedin.com/in/rajsharma",
    "score": 84,
    "intent_summary": "Evaluating CRM solutions for growing sales team",
    "enrichment_level": "email",
    "credits_consumed": 2,
    "delivered_at": "2026-05-07T14:23:00Z"
  }
}

Full interactive API reference coming soon at docs.leados.net