API Documentation

Endpoints

GET/api/generate

Generate a new temporary email address.

Optional query: ?expiry=3600000 (ms, min 10m, max 7d, default 24h)

cURL example:

curl https://api.inboxburn.com/api/generate

Response:

{ "address": "[email protected]", "domain": "brikanto.com", "token": "niNF6r6NnMWVRE8N4UCo" }
POST/api/generate/custom

Create a custom address with your own prefix and domain.

Optional body field: "expiry": 3600000 (ms)

cURL example:

curl -X POST https://api.inboxburn.com/api/generate/custom \ -H "Content-Type: application/json" \ -d '{"prefix": "myname", "domain": "brikanto.com"}'

Response:

{ "address": "[email protected]", "domain": "brikanto.com", "token": "xK9mRf2LpQ8wNvY3hT7j" }
GET/api/domains

List all active domains.

cURL example:

curl https://api.inboxburn.com/api/domains

Response:

{ "domains": ["brikanto.com", "brikanto.co.uk", "wavetura.com", "wavetura.info"] }
GET/api/inbox/{address}

Get all emails in an inbox. Returns non-expired emails for the session.

Send the token from the generate response in the X-Inbox-Token header. Do not place inbox tokens in URLs or logs.

cURL example:

curl "https://api.inboxburn.com/api/inbox/[email protected]" \ -H "X-Inbox-Token: niNF6r6NnMWVRE8N4UCo"

Response:

{ "emails": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "from_name": "GitHub", "from_address": "[email protected]", "subject": "Verify your email", "received_at": "2026-03-28T10:00:00Z" } ], "count": 1 }
GET/api/email/{id}?address={address}

Get full email content including HTML body, plain text, and attachments.

cURL example:

curl "https://api.inboxburn.com/api/email/a1b2c3d4-e5f6-7890-abcd-ef1234567890?address=john.smith92@brikanto.com" \ -H "X-Inbox-Token: niNF6r6NnMWVRE8N4UCo"

Response:

{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "to_address": "[email protected]", "from_address": "[email protected]", "from_name": "GitHub", "subject": "Verify your email", "body_html": "<html>...</html>", "body_text": "Please verify your email...", "received_at": "2026-03-28T10:00:00Z", "attachments": [ { "id": 1, "filename": "doc.pdf", "content_type": "application/pdf", "size": 45000 } ] }
GET/api/attachment/{id}?address={address}

Download an attachment file.

cURL example:

curl "https://api.inboxburn.com/api/attachment/[email protected]" \ -H "X-Inbox-Token: niNF6r6NnMWVRE8N4UCo" --output doc.pdf

Response:

(binary file download)
DELETE/api/inbox/{address}

Delete all emails in an inbox.

cURL example:

curl -X DELETE "https://api.inboxburn.com/api/inbox/[email protected]" \ -H "X-Inbox-Token: niNF6r6NnMWVRE8N4UCo"

Response:

{ "deleted": 3 }
POST/api/inbox/{address}/extend

Extend inbox expiry by 24 hours.

cURL example:

curl -X POST "https://api.inboxburn.com/api/inbox/[email protected]/extend" \ -H "X-Inbox-Token: niNF6r6NnMWVRE8N4UCo"

Response:

{ "ok": true }
POST/api/inbox/{address}/forwardPro / Business only

Set email forwarding to a real address. (Premium)

cURL example:

curl -X POST "https://api.inboxburn.com/api/inbox/[email protected]/forward" \ -H "Authorization: Bearer ib_live_<your-pro-or-business-key>" \ -H "X-Inbox-Token: niNF6r6NnMWVRE8N4UCo" \ -H "Content-Type: application/json" \ -d '{"forward_to": "[email protected]"}'

Request body:

{ "forward_to": "[email protected]" }

Response:

{ "ok": true, "forward_to": "[email protected]" }
DELETE/api/inbox/{address}/forwardPro / Business only

Remove email forwarding.

cURL example:

curl -X DELETE "https://api.inboxburn.com/api/inbox/[email protected]/forward" \ -H "Authorization: Bearer ib_live_<your-pro-or-business-key>" \ -H "X-Inbox-Token: niNF6r6NnMWVRE8N4UCo"

Response:

{ "ok": true }

WebSocket — Real-time Updates

For real-time inbox notifications, see the dedicated WebSocket section in the sidebar.