API Documentation

Integrate getrandom.email into your workflow with our REST API. Requires a Pro subscription.

Full API reference

Every endpoint, every field and every response, generated from the code itself. Try them in your browser.

Generating a client? Use https://getrandom.email/api/v1/pro/openapi.json — the same schema, narrowed to the endpoints your API key can call, so everything in it is something you can do. The complete description of the service, including everything that needs a browser session, is at /api/v1/openapi.json.

Getting started

Get your API key

Create an API key from your dashboard. It is shown once, when you create it, and never again.

Send it with every request

Every Pro endpoint is authenticated with the same header, and every path below is relative to https://getrandom.email/api/v1.

curl https://getrandom.email/api/v1/pro/mailboxes/ \
  -H "X-API-Key: your-api-key-here"

Find the endpoint you need

The API reference lists every endpoint with its parameters and its exact response, and lets you call each one with your own key.