API v2

Getting Started API Types Create Inbox Fetch Emails Prepare Custom Domains Create Custom Domain Address Private Webhooks Standard Webhooks

API v3 NEW

v3 Overview Scoped API Keys Create & Manage Inboxes Emails & Raw .eml Wait for Email Webhooks & Deliveries Custom Domains TempMail Domains Usage & Quota

Getting Started

Welcome to the TempMail Developer API. We have some great features, such as...

No API key sign/up required (for free tier)
Custom domains for Plus and Ultra users
And loads more! Check out our pricing page for more information.

If not using a library, all POST requests must have the Content-Type header set to application/json!

Select your library

Python

NodeJS

Java

HTTP

$ pip3 install tempmail-lol

API Types

Email

An email object, which is returned when you check your inbox.

Name	Type	Description
from	string	The sender of the email
to	string	The receiver (your temp email)
subject	string	Subject of the email
body	string	Plaintext body, could be empty
html	?string	Email HTML (could be null)
date	number	The Unix timestamp of when the email was received

Inbox

An inbox object, containing the email address and access token.

Name	Type	Description
address	string	The email address which was created
token	string	The access token used to view the inbox

Inbox Lifespan

Inboxes have different lifespans depending on the tier of your subscription.

Subscription Tier	Lifespan
Free (no subscription)	One Hour
TempMail Plus	Ten Hours
TempMail Ultra	Thirty Hours

Inbox lifespans can be extended (only for custom domains) by simply re-requesting the create inbox method.

Create Inbox

The Create Inbox method can either be used with GET or POST. The POST method allows you to customize options, such as the prefix and domain of the inbox.

The GET method currently only exists for legacy reasons.

from TempMail import TempMail
tmp = TempMail("optional-api-key")

inb = tmp.createInbox()

# Or... use a prefix
inb = tmp.createInbox(prefix = "joe")

# You can use a setup custom domain here
inb = tmp.createInbox(domain = "mycustomdomain.com", prefix = "optional")

Body

Parameter	Type	Description	Default
domain	?string	The domain of the inbox, or random. Can be a custom domain.	null
prefix	?string	The prefix of the inbox, or random.	null

Response (201)

Name	Type	Description
address	string	The email address of the inbox.
token	string	The token of the inbox.

Fetch Emails

Fetch emails using the token received when the email was created. If you lose your token, you will no longer be able to access the email, unless it is custom domain (please don't contact support about this, we cannot give you the email address for legal reasons).

from TempMail import TempMail
tmp = TempMail("optional-api-key")

inb = tmp.createInbox()

emails = tmp.getEmails(inb.token)

print("Emails:")

for email in emails:
    print("\tSender: " + email.sender)
    print("\tRecipient: " + email.recipient)
    print("\tSubject: " + email.subject)
    print("\tBody: " + email.body)
    print("\tHTML: " + str(email.html)) # may be None
    print("\tDate: " + str(email.date)) # Unix timestamp in milliseconds

Query

Parameter	Type	Description	Default
token	string	The token used to access the inbox	null

Response (200)

Name	Type	Description
emails	Email[]	The array of emails received from the server
expired	boolean	True if the inbox is expired (see inbox lifespan)

Prepare Custom Domain

Before a custom domain can be used on TempMail, you must set a few records. It is recommended to do this on the Accounts Page, however you can do it through the API as well.

Custom domains require a TempMail Plus or Ultra subscription to use.

Body

Parameter	Type	Description	Default
domain	string	The domain to register on TempMail	null

Response (200)

Name	Type	Description
uuid	string	The UUID to set for your domain record (see below)

Add this record to your domain under [uuid].yourdomain.com and set the value to tm-custom-domain-verification.

If you are using a sub-domain instead, set it to [uuid].subdomain.yourdomain.com.

Response (4xx)

Name	Type	Description
error	string	The error explaining why the domain could not be set.

Create custom domain address

Create a custom domain inbox the same way you create normal inboxes, but with your domain!

Notes:

You must use the same account which was used to create the UUID for the domain
The prefix parameter will set the normal prefix with no leading numbers

from TempMail import TempMail
tmp = TempMail("API Key required for custom domains")

inb = tmp.createInbox()

inb = tmp.createInbox(domain = "mycustomdomain.com", prefix = "optional")

Body

Parameter	Type	Description	Default
domain	string	Your custom domain.	null
prefix	?string	The email address (before the @) of the inbox, or random.	null

Response (201)

Name	Type	Description
address	string	The email address of the inbox.
token	string	The token of the inbox.

If you lose the token of the inbox, call the method again with the same prefix. The inbox lifespan will be extended based on your subscription. You can extend infinite times.

Check the inbox using the method in Fetch Emails.

Private Webhooks

Set private webhooks so that all emails for your domain direct to your webhook.

Requires an active TempMail Ultra subscription.

You must have your domain already set up for custom domains ([uuid].domain.com).

Body

Parameter	Type	Description	Default
domain	string	The domain to set your webhook on	null
url	string	The webhook URL emails will forward to	null

Response (200)

Name	Type	Description
success	true	Always true
message	string	Success information message

Response (4xx)

Name	Type	Description
error	string	Message containing details on the error

You can also DELETE /private_webhook with the domain as the query parameter to remove it.

Standard Webhooks

Set standard webhooks on every standard email you create. Emails will forward to your webhook.

Requires an active TempMail Ultra subscription.

This will not retroactively apply to existing emails.

Body

Parameter	Type	Description	Default
url	string	The webhook URL emails will be forwarded to	null

Response (200)

Name	Type	Description
success	true	Always true

Response (4xx)

Name	Type	Description
error	string	Message containing details on the error

You can also DELETE /webhook to remove it from your account.

API v3 Overview NEW

API v3 is the new, consistent TempMail API. It adds account-level inbox management, a wait-for-email long poll, raw .eml downloads, per-inbox webhooks with automatic retries and delivery logs, custom domain management, a list of TempMail's own domains, scoped API keys, and a usage endpoint.

What changed from v2:

Fetches consume exactly what they return. Emails you receive in a response are deleted; emails excluded by your filters (since, from, limit) stay in the inbox. v2 wipes the whole inbox on every read.
Errors are consistent. Every error is { "error": { "code", "message" } } with a matching HTTP status-never a 200.
Rate limits are visible. Responses carry x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-reset headers (reset is a unix timestamp in seconds). 429 responses include retry-after.
v2 stays supported. Inboxes are shared between versions; v3 has its own create and fetch endpoints, but tokens work on both.

Base URL:  https://api.tempmail.lol/v3

# account endpoints accept either key type:
Authorization: Bearer tempmail.20260101.abcdef...   # primary key
Authorization: Bearer tempmail.sk.abcdef...          # scoped key

# error envelope (here: HTTP 403)
{
  "error": {
    "code": "insufficient_scope",
    "message": "This API key does not have the required scope: domains:read",
    "required_scope": "domains:read"
  }
}

Scoped API Keys

Create additional API keys that can only do specific things, so your CI pipeline or a third-party integration never holds your full account credential. The key secret is returned once on creation and only a hash is stored.

Keys are managed with your primary API key (or the website), a scoped key can never manage keys.

Scopes

Scope	Grants
inboxes:create	Create inboxes (works on v1/v2 create endpoints too)
inboxes:read	List your inboxes
webhooks:read	Read webhook config and delivery logs
webhooks:write	Set/remove per-inbox webhooks
domains:read	List/inspect custom domains
domains:write	Register/verify/remove custom domains
usage:read	Read usage & quota

GET/v3/keyslist keys

POST/v3/keyscreate a key

PATCH/v3/keys/:idrename / re-scope / revoke

DELETE/v3/keys/:iddelete a key

curl -X POST https://api.tempmail.lol/v3/keys \
  -H "Authorization: Bearer $PRIMARY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "ci key", "scopes": ["inboxes:create", "inboxes:read"]}'

# 201 -> { "key": "tempmail.sk....", "id": "...", "scopes": [...], ... }
#        the "key" field is shown ONCE. store it now

Create & Manage Inboxes

Create inboxes anonymously (free tier, per-IP limits) or with an API key (per-account limits, longer lifespans, account ownership). Inboxes created with a key belong to your account and can be listed with the inboxes:read scope; per-inbox endpoints are authorized by the inbox token itself.

POST /v3/inboxes - body (all optional)

Parameter	Type	Description	Default
prefix	?string	Local part prefix (a-z, 0-9, _, -)	random
domain	?string	A TempMail domain (see TempMail Domains), or a custom domain verified to your account. Plus/Ultra accounts draw random domains from their own premium pool.	random
community	?boolean	Prefer a community domain	false

GET /v3/inboxes - query

Parameter	Type	Description	Default
limit	?number	Page size (max 200)	50
cursor	?string	`next_cursor` from the previous page	null
include_expired	?boolean	Also return expired inboxes	false

POST/v3/inboxescreate an inbox

GET/v3/inboxeslist your inboxes

GET/v3/inboxes/:tokenmetadata + email count

DELETE/v3/inboxes/:tokendelete inbox + its emails

curl -X POST https://api.tempmail.lol/v3/inboxes \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"prefix": "ci-run-42"}'

# 201
{
  "address": "[email protected]",
  "token": "...",
  "created_at": "2026-07-16T00:22:22.000Z",
  "expires_at": 1784269342568,
  "expired": false,
  "webhook_configured": false
}

Fetch Emails & Raw .eml

Fetching emails consumes what it returns: emails in the response are deleted, while emails excluded by since or limit stay in the inbox (v2 deletes everything on read).

Raw RFC822 source is a TempMail Ultra feature. For Ultra-owned inboxes each fetched email includes a raw field with the exact MIME source received over SMTP (null if it was not captured). The standalone /raw endpoint downloads a .eml for an email that has NOT been consumed yet - useful with the email_id from webhook delivery logs. If the verbatim source is unavailable, a reconstructed .eml is served (marked with x-tempmail-reconstructed: true).

GET /v3/inboxes/:token/emails - query

Parameter	Type	Description	Default
since	?number	Only emails with `date >=` this unix ms timestamp	0
limit	?number	Max emails returned (max 200)	100

GET/v3/inboxes/:token/emailsfetch + consume

DELETE/v3/inboxes/:token/emails/:iddelete without reading

GET/v3/inboxes/:token/emails/:id/rawdownload .eml (Ultra)

curl -OJ https://api.tempmail.lol/v3/inboxes/$TOKEN/emails/$ID/raw

# -> Content-Type: message/rfc822
#    Content-Disposition: attachment; filename="<id>.eml"
#    x-tempmail-reconstructed: false

# without Ultra -> 403
# { "error": { "code": "tier_required", "required_tier": "ultra", ... } }

Wait for Email (long poll)

Blocks until an email matching your filters arrives, or the timeout passes - one request instead of a polling loop. Perfect for signup flows and CI: request the OTP, then wait for it.

Matched emails are returned and consumed; emails that do not match the from/since filters stay in the inbox untouched.

Query

Parameter	Type	Description	Default
timeout	?number	Seconds to wait (max 60)	30
from	?string	Sender filter, wildcards allowed (`*@example.com`)	null
since	?number	Ignore emails older than this unix ms timestamp	0

At most 2 concurrent /wait requests per inbox. A timeout is still HTTP 200, with "timed_out": true and an empty emails array.

curl "https://api.tempmail.lol/v3/inboxes/$TOKEN/wait?\
from=*@example.com&timeout=30"

# matched emails are consumed on return
{
  "emails": [{
    "id": "6a58244f...",
    "from": "[email protected]",
    "subject": "Your verification code is 482913",
    "body": "Code: 482913",
    "raw": "From: [email protected]\r\n...",  // Ultra only
    ...
  }],
  "timed_out": false,
  "waited_ms": 2311
}

Per-Inbox Webhooks & Delivery Logs

Attach a webhook to a single inbox (TempMail Ultra): new mail to that inbox is POSTed to your URL. Failed deliveries are retried automatically with backoff - 30s, 5m, 30m, 2h after the initial attempt (5 attempts total).

Every delivery and each attempt (status code, error, duration) is logged for 7 days and queryable - this covers account-wide (v2) webhooks, private domain webhooks, and per-inbox webhooks alike.

GET /v3/webhooks/deliveries - query

Parameter	Type	Description
status	?string	`pending` \| `success` \| `failed`
address / domain	?string	Filter by recipient inbox or domain
limit / cursor	?number / ?string	Pagination (max 200)

PUT/v3/inboxes/:token/webhookset webhook (Ultra)

GET/v3/inboxes/:token/webhookread webhook

DELETE/v3/inboxes/:token/webhookremove webhook

GET/v3/webhooks/deliveriesdelivery log

{
  "deliveries": [{
    "url": "https://example.com/hook",
    "event": "email.received",
    "address": "[email protected]",
    "status": "success",
    "attempt_count": 2,
    "attempts": [
      { "at": "...", "status_code": 500, "error": "HTTP 500", "duration_ms": 12 },
      { "at": "...", "status_code": 200, "error": null, "duration_ms": 45 }
    ],
    "created_at": "..."
  }],
  "next_cursor": null
}

Custom Domains

Register a custom domain to your account, get the exact DNS records to create, and re-run verification whenever you like - with structured per-record results instead of a single pass/fail. Requires TempMail Plus or Ultra.

DNS records returned by the API

Type	Name	Value
TXT	`<hash>.yourdomain.com`	`tm-custom-domain-verification`
A	`mx.yourdomain.com`	(returned by the API)
MX	`yourdomain.com`	`mx.yourdomain.com` (priority 10, must be the only MX)

The exact TXT name/value pair is account-specific - always read it from the API response.

POST /v3/domains/verify re-checks up to 100 of your domains in one call, least recently checked first, and returns the same per-domain results. It can run once every 10 minutes per account; calling it sooner returns 429 rate_limited with a retry-after header.

GET/v3/domainslist your domains

POST/v3/domainsregister + verify

GET/v3/domains/:domaindetails + DNS records

POST/v3/domains/:domain/verifyre-run verification

POST/v3/domains/verifyre-verify all (once per 10 min)

DELETE/v3/domains/:domainunregister

{
  "domain": { "domain": "yourdomain.com", "verified": true, ... },
  "checks": {
    "txt": { "pass": true,  "detail": "Ownership TXT record found." },
    "mx":  { "pass": false, "records": [...],
             "expected": "mx.yourdomain.com",
             "detail": "Expected a single MX record..." }
  },
  "dns": { "ownership_txt_options": [...], "mail_records": [...] }
}

TempMail Domains

List every domain TempMail itself serves, split into the premium pool that only Plus/Ultra accounts can create inboxes on and the free pool that any tier can use. Pass any of them as domain when creating an inbox. Requires TempMail Plus or Ultra and the domains:read scope; free accounts get a tier_required error.

Response fields

Field	Type	Description
domains_premium	string[]	The premium pool. Random Plus/Ultra inboxes are drawn from here.
domains_free	string[]	The free pool, including community domains. Usable by every tier.

An entry starting with *. is a wildcard: both the bare domain and any subdomain of it are accepted, so *.example.com lets you create [email protected] or [email protected]. The lists change over time as domains are rotated in and out, so re-fetch them rather than caching them for long.

GET/v3/domains/poollist TempMail domains (Plus/Ultra)

curl https://api.tempmail.lol/v3/domains/pool \
  -H "Authorization: Bearer tempmail.sk...."

{
  "domains_premium": [
    "*.plusonly.example",
    "premium.example"
  ],
  "domains_free": [
    "*.free.example",
    "community.example"
  ]
}

Usage & Quota

See your tier, how much of the inbox-creation window you have used, and counts of your active inboxes, keys, and domains. Requires the usage:read scope.

{
  "tier": "ultra",
  "inbox_creation": {
    "window_seconds": 300,
    "limit": 5000,
    "used": 2,
    "remaining": 4998,
    "resets_at": 1784161500000,
    "limited_by": "account"
  },
  "inboxes_active": 2,
  "api_keys_active": 1,
  "custom_domains": 0,
  "webhook_deliveries_last_7d": 14
}

API Assistance

Need help with the API? Join our Discord Server! We're happy to help, so let us know if you have a problem, or if you just need help figuring something out with our API.