โ† Back to App

Overview

This API lets you generate temporary email addresses and receive messages. No complex tokens or session management needed - just use the email address.

Base URL
https://inboxapi.email
API Key Required for Generation:
Endpoint API Key Rate Limit
POST /api/email/generate โœ… Required Customer's configured limit

All message endpoints work with just the email address (no token needed after generation).

Session Expiry: Generated emails typically expire after 60 minutes. After expiry, you must generate a new email.

๐Ÿงช Test the API Right Now

No need for Postman or curl. Test all endpoints directly in your browser.

1
Enter Your API Key
This key authenticates your requests. Contact your admin if you don't have one.
2
Choose Endpoint
Select which API endpoint you want to test.
๐Ÿ“ง Test: Generate Email ๐Ÿ“ฉ Test: Get Latest Message โค๏ธ Test: Health Check
3
Fill in Parameters
The fields below depend on which endpoint you selected.
Response

API Endpoints

POST /api/email/generate โ–ผ

API KEY REQUIRED. Generates a new temporary email address.

Authentication

Requires X-API-Key header with a valid API key.

Request

POST /api/email/generate
Content-Type: application/json
X-API-Key: tmk_abc123xyz789

{}

Response

{
  "success": true,
  "email": "[email protected]",
  "domain": "domain.com",
  "ttlMinutes": 60,
  "expiresAt": "2026-09-30T22:35:09.418Z"
}
GET /api/email/:email/messages/latest โ–ผ

RECOMMENDED. Get the most recent message with FULL body.

Request

GET /api/email/[email protected]/messages/latest

Response

{
  "success": true,
  "message": {
    "id": 1,
    "subject": "Welcome",
    "text": "Hello! Your verification code is 847291."
  }
}
GET /api/email/:email/messages โ–ผ

List all messages with subjects only. Use this for polling.

Request

GET /api/email/[email protected]/messages
GET /api/email/:email/messages/:id โ–ผ

Get a specific message by ID with full body.

Request

GET /api/email/[email protected]/messages/1
POST /api/email/access โ–ผ

Access a previously generated email if you lost your session.

Request

POST /api/email/access
Content-Type: application/json

{
  "email": "[email protected]"
}
GET /api/email/:email โ–ผ

Check if an email session is still valid.

DELETE /api/email/:email โ–ผ

Delete/clear a session when done. Optional but good for privacy.

GET /api/health โ–ผ

Check if the API is running. No authentication required.

Quick Start (curl Examples)

1. Generate email (API Key required)

curl -X POST https://inboxapi.email/api/email/generate \
  -H "X-API-Key: tmk_your_api_key_here"

2. Get the latest message (simplest)

curl https://inboxapi.email/api/email/[email protected]/messages/latest

Error Handling

All error responses follow this format:

{
  "success": false,
  "error": "Human-readable error message"
}

HTTP Status Codes

Code Meaning Cause
200 OK Success Everything worked
401 Unauthorized Invalid API key Missing or invalid X-API-Key header
429 Too Many Requests Rate limit exceeded Exceeded your API key's email limit
404 Not Found Session not found Email never generated, or session expired
Important: When you get a 404 or 410 error, the session is no longer valid. You must call POST /api/email/generate to get a new email address.