Quick Start
1Get Your API Key
Sign up and create an API key from your dashboard. Each key can have specific scopes and permissions.
Dashboard → Settings → API Keys → Create New Key2Send Your First Email
Use our REST API to send transactional emails. Here's a simple example:
import requests
response = requests.post(
'http://localhost:8000/api/v1/emails/send/',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'to': 'user@example.com',
'subject': 'Welcome to Gclap!',
'html': '<h1>Hello!</h1><p>Thanks for joining.</p>',
'from_email': 'hello@yourdomain.com'
}
)
print(response.json())3Track Events
Monitor opens, clicks, bounces, and more through our analytics API or webhook events.
API Features
Comprehensive APIs for email delivery, analytics, automation, and more.
Email Sending
Send transactional and marketing emails via REST API or SMTP
/api/v1/emails/send/Analytics
Track opens, clicks, bounces, and engagement metrics
/api/v1/analytics/dashboard/Contact Management
Manage contacts, lists, and segments programmatically
/api/v1/contacts/Automation
Create and manage email workflows and triggers
/api/v1/automation/Webhooks
Real-time event notifications for email activities
/api/v1/webhooks/endpoints/API Keys
Secure key management with scopes and rotation
/api/v1/accounts/api-keys/Alerts
Configure alerts for metrics and anomalies
/api/v1/analytics/alert-configs/Scheduled Reports
Automated email reports on custom schedules
/api/v1/analytics/scheduled-reports/Deliverability
Monitor sender reputation and inbox placement
/api/v1/deliverability/score/Core API Endpoints
/api/v1/emails/send/Send Email
Send a single transactional or marketing email
Parameters
tostringrequiredRecipient email address
subjectstringrequiredEmail subject line
htmlstringHTML email body
textstringPlain text email body
from_emailstringSender email address
/api/v1/analytics/dashboard/Dashboard Stats
Get overview statistics for your account
Parameters
daysintegerNumber of days to include (default: 30)
/api/v1/contacts/List Contacts
Retrieve all contacts in your organization
Parameters
pageintegerPage number for pagination
searchstringSearch by email or name
listuuidFilter by list ID
/api/v1/webhooks/endpoints/Create Webhook
Register a webhook endpoint for event notifications
Parameters
urlstringrequiredWebhook URL to receive events
eventsarrayrequiredEvent types to subscribe to
descriptionstringWebhook description
/api/v1/accounts/api-keys/Create API Key
Generate a new API key with specific permissions
Parameters
namestringrequiredKey name for identification
scopesarrayPermission scopes (default: all)
expires_atdatetimeExpiration date
Authentication
API Key Authentication
All API requests require authentication using your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYSecurity: Never expose your API keys in client-side code or public repositories. Use environment variables and keep keys secure.
Webhook Events
Receive real-time notifications when email events occur. Configure webhook endpoints to get instant updates.
email.sentEmail was successfully sent to the recipient
email.deliveredEmail was delivered to recipient's inbox
email.openedRecipient opened the email
email.clickedRecipient clicked a link in the email
email.bouncedEmail bounced (hard or soft bounce)
email.unsubscribedRecipient unsubscribed from emails
email.spamEmail was marked as spam
campaign.completedCampaign finished sending to all recipients
Rate Limits & Quotas
API Rate Limits
- Free: 100 requests/minute
- Pro: 1,000 requests/minute
- Business: 5,000 requests/minute
Email Quotas
- Free: 1,000 emails/month
- Pro: 50,000 emails/month
- Business: 200,000 emails/month