API Documentation
Integrate OpenInbox.io into your applications with our powerful REST API. Create inboxes, fetch emails, and set up webhooks programmatically.
Quick Start
1. Get API Key
Upgrade to Pro/Business tier and generate your API key in Settings.
2. Make Requests
Include your API key in the X-API-Key header with each request.
3. Handle Responses
All responses are JSON formatted with consistent structure.
Base URL
https://api.openinbox.io/apiAuthentication
All API requests require authentication via the X-API-Key header.
curl -X GET "https://api.openinbox.io/api/v1/inboxes" \
-H "X-API-Key: tmp_your_api_key_here"Rate Limits & Tiers
| Tier | Price | API Access | Daily Limit |
|---|---|---|---|
| Free | $0 | ✗ No | — |
| Starter | $3/mo | ✗ No | — |
| Pro | $7/mo | ✓ Yes | 3,000 req/day |
| Business | $15/mo | ✓ Yes | 10,000 req/day |
Rate Limit Headers
Each response includes rate limit headers:X-RateLimit-Limit: 100
X-RateLimit-Remaining: 85
X-RateLimit-Reset: 1704153600
Error Handling
All errors follow a consistent format with appropriate HTTP status codes:
{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or missing API key"
}400Bad Request - Invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - API access not available on your plan404Not Found - Resource does not exist429Too Many Requests - Rate limit exceeded500Internal Server ErrorWebhook Events
Subscribe to the following events to receive real-time notifications:
email.receivedTriggered when a new email arrives in an inboxinbox.createdTriggered when a new inbox is createdinbox.expiredTriggered when an inbox expiresWebhook Payload Example
{
"event": "email.received",
"timestamp": "2024-01-01T12:00:00Z",
"data": {
"emailId": "uuid",
"inboxId": "uuid",
"from": "[email protected]",
"subject": "Hello!"
}
}API Endpoints
Inboxes
Emails
Webhooks
Account
Ready to Get Started?
Upgrade to Pro or Business to unlock API access and integrate OpenInbox.io into your applications.
View Pricing Plans