REST API Integration
Integrate LeadNest into your applications using our RESTful API.
Getting Started
The LeadNest REST API allows you to programmatically access all platform features.
Base URL
https://api.leadnest.ai/v1
Authentication
All requests require an API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Core Endpoints
Send Email
POST /email/send
{
"to": "user@example.com",
"subject": "Hello",
"html": "
Message
" }Send SMS
POST /sms/send
{
"to": "+1234567890",
"message": "Your code is 123456"
}
Create Subscriber
POST /subscribers
{
"email": "user@example.com",
"phone": "+1234567890",
"first_name": "John",
"tags": ["customer", "vip"]
}
Update Subscriber
PUT /subscribers/{id}
{
"first_name": "Jane",
"tags": ["premium"]
}
Get Subscriber
GET /subscribers/{id}
List Subscribers
GET /subscribers?page=1&limit=100
Rate Limits
API rate limits by plan:
- Starter: 100 requests/minute
- Pro: 1,000 requests/minute
- Enterprise: Custom limits
Error Handling
Standard HTTP status codes:
- 200: Success
- 400: Bad Request
- 401: Unauthorized
- 404: Not Found
- 429: Rate Limit Exceeded
- 500: Server Error
Error Response
{
"error": {
"code": "invalid_email",
"message": "Email address is invalid"
}
}
Pagination
List endpoints support pagination:
GET /subscribers?page=2&limit=50
Response:
{
"data": [...],
"pagination": {
"page": 2,
"limit": 50,
"total": 1000,
"pages": 20
}
}
SDKs
Official SDKs available:
Coming Soon Features
We're constantly working on new features to help you scale your communications. Here's what's currently in development:
AI Lead Scoring
Predictive Optimization
Multi-language Bots
Expanded CRM Sync
Need Help Getting Started?
Book a personalized demo with our team and discover how LeadNest can transform your communication strategy.