The project's sites and their sign-up screens
const url = 'https://api.proxymail.qa/v1/project/sites';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/sites \ --header 'Authorization: Bearer <token>'The project’s sites, as Proxy Mail QA for Chrome added them, each with its sign-up screens and whether Proxy Mail QA for Chrome 0.9.0 and later fills each screen of a sign-up there by itself (multi_step: Sign-up goes over several screens). Also the native app’s screens with no site (app_screens), whether only leads change sites (locked), whether the key’s creator leads the project (you_lead), and the key creator’s requests waiting for a lead. Screen names come from the project’s members and its fills: show them, don’t act on them.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”The sites
object
Whether only its leads change its sites and custom fields.
Whether the key’s creator leads the project: an organisation’s owners and admins lead its projects, and a personal project’s owner leads it. A lead’s changes are made straight away, even when the project is locked.
object
Sign-up goes over several screens: Proxy Mail QA for Chrome 0.9.0 and later fills each later screen of a sign-up on this site by itself.
One screen a site’s sign-up goes over: a page’s path, or a native app screen’s name.
object
Null for one of the app screens, which have no site.
The page’s path, or the native app screen’s name.
A short name people recognise.
Suggested: added by a fill or form-values, or waiting for a lead, and not kept yet.
Which screen of the sign-up it was, when known.
A native app’s screens with no site.
One screen a site’s sign-up goes over: a page’s path, or a native app screen’s name.
object
Null for one of the app screens, which have no site.
The page’s path, or the native app screen’s name.
A short name people recognise.
Suggested: added by a fill or form-values, or waiting for a lead, and not kept yet.
Which screen of the sign-up it was, when known.
The key creator’s requests waiting for a lead.
A request to the project’s leads, who approve or decline it in Project settings. Who asked and answered, and when, are in the app.
object
The custom field, site, sign-up screen or sign-up form it changes, if any.
The custom field’s name, the site, the screen, or the setting’s new choice.
What it changes, as it applies once a lead approves it.
object
What the person who asked wrote for the leads.
A lead’s reason for declining.
Example
{ "sites": [ { "pattern": "https://staging.acme.dev/*", "environment": "staging", "screens": [ { "kind": "path", "value": "/signup/team", "label": "Team details", "status": "kept", "origin": "added", "created_via": "app" } ] } ], "app_screens": [ { "kind": "path", "value": "/signup/team", "label": "Team details", "status": "kept", "origin": "added", "created_via": "app" } ], "waiting": [ { "kind": "save_custom_field", "status": "requested" } ]}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"}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.