List or find addresses in the project, newest first

Every filter given must match, so an agent or test can find a test account it made earlier, such as an under-18 in GB with a saved password: ?tag=age-gate&country=GB&max_age=17&has_password=true.

get/v1/addresses

Request

  • Base URL: https://api.proxymail.qa
  • URL: https://api.proxymail.qa/v1/addresses
  • Auth: HTTP bearer

Query parameters

limitinteger
beforestring date-time

Addresses created before this time (paging).

tagstring[]

Addresses with this tag. Repeat it, or separate tags with commas, to need all of them.

countrystring

The persona's country, an ISO 3166-1 alpha-2 code such as GB.

min_ageinteger

At least this age today, in whole years, from the persona's date of birth.

max_ageinteger

At most this age today: max_age=17 finds under-18s.

has_passwordboolean

Whether a password is saved on the address.

searchstring

Part of the address, label, notes, name or username.

sitestring

Used on this site: a host or page URL, such as staging.example.com.

environmentstring

Used in this environment, such as staging.

Response

Addresses

addressstring
labelstring nullable
created_atstring date-time
expires_atstring date-time
notesstring nullable
tagsstring[]
has_passwordboolean
passwordstring

Only in the response to creating it with password: true.

sitestring

Where it is used: the host of the app under test. Present only when set.

environmentstring

Which environment it is used in, such as staging. Present only when set.

email_countinteger
latestobject nullable

The newest code or link, like Match.

checked_out_untilstring date-time

Only while someone has it checked out of the pool.

Changes

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