Tests for a sign-up form
const url = 'https://api.proxymail.qa/v1/project/signup-forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test?framework=playwright&requested=false';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/project/signup-forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test?framework=playwright&requested=false' \ --header 'Authorization: Bearer <token>'Playwright (the default) or Cypress tests for the form. Each field gets values the form should take and values it should refuse (empty, the password’s rules one at a time, someone a day too young, an ID with the wrong check digit), one at a time, with every other field filled in properly from a new test address. Fields are found by the data-testid values the code export writes; a refusal is the field’s <test id>-error message or aria-invalid. Set SIGNUP_URL to the form’s page.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”True for the change waiting for a lead.
Responses
Section titled “Responses”The tests
object
object
object
The npm packages the tests import.
How many values each kind of test tries.
object
What to know before running them, such as a value to put in.
Example
{ "form": { "status": "saved" }, "framework": "playwright", "files": [ { "path": "tests/signup.spec.ts" } ]}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.
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"}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"}The path doesn’t take this method.
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”The methods it takes, such as GET, PATCH.
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.