Test addresses to clean up from your app
const url = 'https://api.proxymail.qa/v1/cleanup-list';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.proxymail.qa/v1/cleanup-list \ --header 'Authorization: Bearer <token>'Every test address the key’s project used between from and to (30 days ago to now by default; from can’t go back past 90 days): one made on or before to that was still live, or ended, on or after from. They come newest first, live, expired or deleted, so you can delete those test users from the app under test. A gone address stays on the list until 90 days after it ended, or until its project, account or organisation is deleted. Proxy Mail QA never touches your app. mail_domains lists the domains every test address ends in, to filter your users by. Up to 5,000; truncated says there were more. See https://proxymail.qa/docs/rest-api#test-users-to-delete.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Addresses still live, or ended, on or after then. Defaults to 30 days ago, and can’t go back past 90 days.
Addresses made on or before then. Defaults to now.
Only addresses used on this site, such as staging.example.com.
Responses
Section titled “Responses”The list
object
The start used: no earlier than kept_from.
The earliest from can be: 90 days ago.
How many addresses matched, including any left out.
More than 5,000 matched: narrow the range or give site.
The domains every test address ends in.
object
When it expired or was deleted.
The host it was used on.
Whether any email reached it: if so, the app very likely has a user for it.
Example
{ "addresses": [ { "status": "live" } ]}An error
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}No API key, or one that isn’t valid: it may have been revoked, or its creator no longer has access to the project.
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”Bearer realm="proxymail-qa", with error="invalid_token" when a key was sent but isn’t valid.
Too many requests. With a Retry-After header, a per-minute limit was reached: the key’s requests (60 a minute on Free, 600 on Team), password reveals (30 a minute per person), or keys that aren’t valid from one network (120 a minute). Without one, error says which longer limit: daily_limit, the space’s new addresses for today (50 on Free), until midnight UTC; account_held, 10 addresses a day while a Free account’s recent use is looked at; or rate_limited when something is full, such as a project’s 50 custom fields.
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”Seconds to wait before trying again. Sent with per-minute limits only.