API Reference
Integrate with Leadyen programmatically to fetch leads, manage configurations, and verify webhooks.
Authentication
Use API keys from your dashboard. Include the key as a Bearer token.
Authorization: Bearer YOUR_API_KEY
Retrieve leads
Fetch recent leads delivered to your account. Filter by status, category, or created date.
GET /api/leads?limit=50&status=new
Response includes id, contact details, metadata, and delivery status.
Validate webhook signatures
Verify the `x-webhook-token` or signed headers depending on integration when receiving webhooks. See the Webhooks page for examples.
Webhook guideErrors
Standard JSON errors with `error` and `message` fields. Rate limits may apply; retry with backoff.
Next steps
- Set up webhooks for real-time delivery
- Use the API to backfill or audit records
- Rotate API keys regularly and restrict access