Wait for a verification, sign-in, invite or reset link

Returns the newest such link received since since, waiting up to timeout seconds. We never open links: whoever calls decides whether to.

get/v1/addresses/{address}/link

Request

  • Base URL: https://api.proxymail.qa
  • URL: https://api.proxymail.qa/v1/addresses/{address}/link
  • Auth: HTTP bearer

Path parameters

addressstring email required

The test address, URL-encoded. A variant also works: capitals, or a +tag (k7f2x9ab12cd+o'brien@mailclub.dev). It acts on the plain address; waiting on a +tag variant, or listing its messages, only finds mail sent to that variant.

Query parameters

timeoutinteger

Seconds to wait for a match. 0 checks once.

servicestring

Only match email from this service, by name or domain (e.g. 'spotify').

sincestring date-time

Only match email received at or after this time. Default: 15 minutes before the request.

unusedboolean

true: only a code or link nobody has used yet. One counts as used once it’s returned by a wait, or opened or copied in the app.

typestring

Comma-separated: verify, magic_signin, invite, reset, or any (also other links). Default: the first four.

appboolean

true: only links that open an app (myapp://verify?…, Expo's exp://…), for mobile tests. false: only web links. Left out: either; when an email has both for the same thing, the web link comes first.

Headers

Proxy-Mail-QA-Runstring uuid

A run's id (POST /v1/runs): adds what this call saw to the run. If it can't be added (the run finished, or isn't in this project), the call still works and the Proxy-Mail-QA-Run-Warning response header says why.

Proxy-Mail-QA-Teststring

With Proxy-Mail-QA-Run: the test this call belongs to, percent-encoded (encodeURIComponent), up to 200 characters once decoded. The run's report shows it beside what the call saw.

Proxy-Mail-QA-Run-Retry'true'

true when you'll call again if nothing arrives (waits longer than 30 seconds), so only the last call's "nothing arrived" is added to the run.

Response

The link

addressstring
type'code' | 'link'
subtypestring

otp or coupon; verify, magic_signin, invite, reset or other.

valuestring

The code, or the link URL.

servicestring nullable

Who sent it, e.g. Spotify.

service_domainstring nullable
received_atstring date-time
expires_atstring date-time nullable

Only when the email says how long it lasts.

email_idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.