---
title: "Overview | Proxy Mail QA"
description: "Developer docs for Proxy Mail QA: the MCP server for coding agents, the REST API for test suites, and the Chrome extension."
url: https://proxymail.qa/docs/reference
---

# Overview

## Proxy Mail QA API 1.0.0

Create disposable test inboxes and get the verification code or link from the email that arrives, in one call that waits for it. Every request uses an API key, created in Project settings → API keys; a key works within one project. Codes and links come back on their own: the email’s text and HTML are only returned by /messages when asked for, since they are written by the sender.

[Guide](https://proxymail.qa/docs/api)

Proxy Mail QA

- <https://proxymail.qa>
- [hello@proxymail.qa](mailto:hello@proxymail.qa)

Information

- OpenAPI version: `3.1.0`

## Operations

GET

[/v1/project](https://proxymail.qa/docs/reference/operations/getproject.html)

POST

[/v1/project/dev-hosts](https://proxymail.qa/docs/reference/operations/adddevhost.html)

GET

[/v1/addresses](https://proxymail.qa/docs/reference/operations/listaddresses.html)

POST

[/v1/addresses](https://proxymail.qa/docs/reference/operations/createaddress.html)

GET

[/v1/addresses/{address}](https://proxymail.qa/docs/reference/operations/getaddress.html)

DELETE

[/v1/addresses/{address}](https://proxymail.qa/docs/reference/operations/deleteaddress.html)

PATCH

[/v1/addresses/{address}](https://proxymail.qa/docs/reference/operations/updateaddress.html)

GET

[/v1/addresses/{address}/code](https://proxymail.qa/docs/reference/operations/waitforcode.html)

GET

[/v1/addresses/{address}/link](https://proxymail.qa/docs/reference/operations/waitforlink.html)

GET

[/v1/addresses/{address}/count](https://proxymail.qa/docs/reference/operations/countemails.html)

GET

[/v1/addresses/{address}/none](https://proxymail.qa/docs/reference/operations/expectnoemail.html)

GET

[/v1/addresses/{address}/messages](https://proxymail.qa/docs/reference/operations/listmessages.html)

GET

[/v1/addresses/{address}/variants](https://proxymail.qa/docs/reference/operations/getvariants.html)

GET

[/v1/addresses/{address}/checks](https://proxymail.qa/docs/reference/operations/checkemail.html)

GET

[/v1/addresses/{address}/delivery](https://proxymail.qa/docs/reference/operations/checkdelivery.html)

GET

[/v1/addresses/{address}/password](https://proxymail.qa/docs/reference/operations/revealpassword.html)

PUT

[/v1/addresses/{address}/password](https://proxymail.qa/docs/reference/operations/setpassword.html)

POST

[/v1/form-values](https://proxymail.qa/docs/reference/operations/formvalues.html)

POST

[/v1/addresses/checkout](https://proxymail.qa/docs/reference/operations/checkoutaccount.html)

POST

[/v1/addresses/sign-in](https://proxymail.qa/docs/reference/operations/signinaccount.html)

POST

[/v1/addresses/{address}/extend](https://proxymail.qa/docs/reference/operations/extendcheckout.html)

POST

[/v1/addresses/{address}/return](https://proxymail.qa/docs/reference/operations/returnaccount.html)

GET

[/v1/runs](https://proxymail.qa/docs/reference/operations/listruns.html)

POST

[/v1/runs](https://proxymail.qa/docs/reference/operations/startrun.html)

GET

[/v1/runs/{run}](https://proxymail.qa/docs/reference/operations/getrun.html)

POST

[/v1/runs/{run}/notes](https://proxymail.qa/docs/reference/operations/addrunnote.html)

POST

[/v1/runs/{run}/tests](https://proxymail.qa/docs/reference/operations/addtestresult.html)

POST

[/v1/runs/{run}/finish](https://proxymail.qa/docs/reference/operations/finishrun.html)

## Authentication

### apiKey

An API key: qa\_…

**Security scheme type:** http

[Previous With a coding agent (iOS)](https://proxymail.qa/docs/ios-agents.html) [Next The key's project, its mail domains and limits](https://proxymail.qa/docs/reference/operations/getproject.html)