---
title: "A sign-up form | Proxy Mail QA"
description: "Developer docs for Proxy Mail QA: the MCP server for coding agents, the REST API for test suites, and the Chrome extension."
url: https://proxymail.qa/docs/reference/operations/getsignupform
---

# A sign-up form

GET

/v1/project/signup-forms/{id}

```js
const url = 'https://api.proxymail.qa/v1/project/signup-forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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);
}
```

```sh
curl --request GET \
  --url https://api.proxymail.qa/v1/project/signup-forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'
```

One form in full: its spec, the custom fields it needs, and how each field gets its value (`built_in`, `custom_field`, a ready-made one for a phone, an ID or tax number, a choice or the terms box, or `never`). While a lead hasn’t answered, `requested` is what was asked and `request` the request.

## Authorizations

- **[apiKey](https://proxymail.qa/docs/reference.html#apikey)**
- **[apiKeyHeader](https://proxymail.qa/docs/reference.html#apikeyheader)**

## Parameters

### Path Parameters

**id**

required

string format: uuid

<= 36 characters

## Responses

### 200

The form

Media typeapplication/json

### object

**id**

string format: uuid

**name**

string

**status**

Requested: a lead hasn’t answered yet; draft: asked for and never approved.

string

Allowed values: saved requested draft

**site**

string | null

**screens**

integer

**fields**

integer

**created\_via**

string

Allowed values: app extension agent api

**agent\_name**

string | null

**created\_at**

string format: date-time

**updated\_at**

string format: date-time

**spec**

The form. Only name and screens are required.

### object

**version**

integer

Allowed values: 1

**name**

required

What the form is called, such as Main sign-up.

string

<= 80 characters

**site**

The site it’s on, as the project lists it, such as <https://staging.example.com/>\*. Leave out to match on every site.

string

<= 300 characters

**language**

The form’s language, for its default labels: en (the default), de, fr, es, it, pt, nl, zh or ja.

string

**country**

A two-letter country code for the fields that depend on one (IDs, VAT numbers, phones, addresses).

string

**screens**

required

The screens in order, up to 10, with up to 60 fields in all.

Array<object>

\>= 1 items <= 10 items

### object

**title**

The screen’s heading.

string

<= 80 characters

**path**

The page’s path, such as /signup.

string

**screen\_id**

A sign-up screen the project keeps, from list\_sites.

string format: uuid

**fields**

required

The fields in order. Each section once in the form.

Array<object>

\>= 1 items <= 30 items

### object

**section**

required

A section id from list\_form\_sections, such as email, password or business.team\_size; or custom, with custom\_field, for a question one of the project’s own custom fields answers.

string

**custom\_field**

Section custom only: the custom field that fills it, by its id from list\_custom\_fields. It keeps deciding the value; the form puts the field in its code, tests and preview. Give the field the test id or label that custom field looks for.

string format: uuid

**required**

Defaults to true.

boolean

**label**

The field’s label; defaults to the section’s label in the form’s language. Needed for section custom.

string

<= 80 characters

**testid**

Its data-testid; defaults to signup- and the section id with dashes, such as signup-business-team-size, or for section custom signup- and the label, such as signup-team-size.

string

<= 100 characters

**options**

Only what the section takes.

### object

**type**

Section custom only: a text box, a drop-down (with choices) or a tick box. Defaults to select with choices, else text.

string

Allowed values: text select checkbox

**country**

A two-letter country code, for a country-dependent section.

string

**min\_length**

Password only.

integer

**max\_length**

Password only.

integer

**classes**

Password only: the kinds of character it must have.

Array<string>

Allowed values: lower upper digit symbol

**min\_age**

Date of birth only: the youngest age the form accepts.

integer

**choices**

The options of a drop-down or radio group (gender, language, how someone heard, role, team size, or a section custom drop-down).

Array<string>

**custom\_fields**

The custom fields the form needs.

Array<object>

### object

**id**

The custom field to change.

string format: uuid

<= 36 characters

**enabled**

Ignored here, and allowed so a custom field can be sent back as listed. PATCH this path to turn one on or off.

boolean

**name**

required

string

<= 80 characters

**match**

required

How to recognise the field: words its label or name contains (3 to 100 characters, or 2 in Chinese, Japanese or Korean), with up to 9 more phrases in also, such as its label in other languages; or its exact test ID, name or id attribute; or, for a ready-made custom field, kind with its section as text. Saving replaces the custom field, so send every phrase to keep.

### object

**on**

required

string

Allowed values: words test\_id name html\_id kind

**text**

required

string

<= 100 characters

**also**

Words only: more phrases that recognise the same field, such as its label in the site’s other languages.

Array<string>

<= 9 items

**site**

Its host or a site pattern, such as staging.acme.dev or https://_.acme.dev/_, or null for every site. It needn’t be one of the project’s sites yet; a blocked site is refused.

string | null

<= 300 characters

**path**

A page path such as /signup. It covers /signup, /signup/business and the same page under a language, such as /de/signup. Leave it out, or send null, for every page of the site.

string | null

<= 200 characters

**field\_type**

string | null

Allowed values: text textarea number select checkbox radio

**value**

required

What goes in the field. text: { text }. template: { template } with {first\_name}, {last\_name}, {full\_name}, {username}, {email}, {company}, {country} or {digits:N} (N from 1 to 12). option: { option }, the option to pick. list: { items }, 2 to 20, one picked for each account. options: { options }, 1 to 20, every one for every account: ticks the boxes of a group (matched by their shared name or words in the question they answer) or selects them in a drop-down that takes several answers, and boxes not listed are unticked, though a consent box, a marketing box or a box with its own custom field is left as it is. Never a radio group. checkbox: { checked }. generate: Proxy Mail QA makes up a value that suits the field (the same for the same account), on any field but a checkbox, never a personal ID field. leave: leave the field as it is. ready\_made: { section }, matched on kind (or test\_id when a sign-up form made it), Proxy Mail QA’s own safe value, where it has one: phone (a number set aside for fiction, or `phones`: the team’s own test number per country), id.national, id.tax, id.passport, business.vat and business.tax (a fake value only where one can never be a real person’s, or `ids_from`: a KYC vendor’s sandbox values), gender, referral\_source, language, business.role, business.team\_size and business.type (one of the field’s options) and consent.terms (ticked unless `checked` is false).

### object

**kind**

required

string

Allowed values: text template option list options checkbox generate leave ready\_made

**text**

string

<= 200 characters

**template**

string

<= 200 characters

**option**

string

<= 100 characters

**items**

Array<string>

\>= 2 items <= 20 items

**options**

Array<string>

\>= 1 items <= 20 items

**checked**

Checkbox, or ready\_made consent.terms (true by default).

boolean

**section**

Ready\_made only: the field catalogue section it fills.

string

Allowed values: phone id.national id.tax id.passport business.vat business.tax gender referral\_source language business.role business.team\_size business.type consent.terms

**ids\_from**

Ready\_made ID and tax numbers only: safe (the default) or a KYC vendor’s sandbox values.

string

Allowed values: safe stripe plaid onfido veriff didit cashfree setu

**phones**

Ready\_made phone only: the team’s own test numbers, one per country, for accounts in countries with no numbers set aside for fiction. Never a real person’s number.

Array<object>

<= 20 items

### object

**country**

required

string

/^\[A-Za-z\]{2}$/

**number**

required

4 to 30 digits, spaces, brackets or dashes, with an optional leading +.

string

<= 30 characters

**tag\_answer**

An option or one of a list only: tag the account with the answer.

boolean

**fills**

How each field gets its value.

Array<object>

### object

**testid**

string

**section**

string

**fill**

string

Allowed values: built\_in custom\_field never

**requested**

What a member asked the leads for, while a request waits.

### object

**name**

string

**spec**

The form. Only name and screens are required.

### object

**version**

integer

Allowed values: 1

**name**

required

What the form is called, such as Main sign-up.

string

<= 80 characters

**site**

The site it’s on, as the project lists it, such as <https://staging.example.com/>\*. Leave out to match on every site.

string

<= 300 characters

**language**

The form’s language, for its default labels: en (the default), de, fr, es, it, pt, nl, zh or ja.

string

**country**

A two-letter country code for the fields that depend on one (IDs, VAT numbers, phones, addresses).

string

**screens**

required

The screens in order, up to 10, with up to 60 fields in all.

Array<object>

\>= 1 items <= 10 items

### object

**title**

The screen’s heading.

string

<= 80 characters

**path**

The page’s path, such as /signup.

string

**screen\_id**

A sign-up screen the project keeps, from list\_sites.

string format: uuid

**fields**

required

The fields in order. Each section once in the form.

Array<object>

\>= 1 items <= 30 items

### object

**section**

required

A section id from list\_form\_sections, such as email, password or business.team\_size; or custom, with custom\_field, for a question one of the project’s own custom fields answers.

string

**custom\_field**

Section custom only: the custom field that fills it, by its id from list\_custom\_fields. It keeps deciding the value; the form puts the field in its code, tests and preview. Give the field the test id or label that custom field looks for.

string format: uuid

**required**

Defaults to true.

boolean

**label**

The field’s label; defaults to the section’s label in the form’s language. Needed for section custom.

string

<= 80 characters

**testid**

Its data-testid; defaults to signup- and the section id with dashes, such as signup-business-team-size, or for section custom signup- and the label, such as signup-team-size.

string

<= 100 characters

**options**

Only what the section takes.

### object

**type**

Section custom only: a text box, a drop-down (with choices) or a tick box. Defaults to select with choices, else text.

string

Allowed values: text select checkbox

**country**

A two-letter country code, for a country-dependent section.

string

**min\_length**

Password only.

integer

**max\_length**

Password only.

integer

**classes**

Password only: the kinds of character it must have.

Array<string>

Allowed values: lower upper digit symbol

**min\_age**

Date of birth only: the youngest age the form accepts.

integer

**choices**

The options of a drop-down or radio group (gender, language, how someone heard, role, team size, or a section custom drop-down).

Array<string>

**custom\_fields**

Array<object>

### object

**id**

The custom field to change.

string format: uuid

<= 36 characters

**enabled**

Ignored here, and allowed so a custom field can be sent back as listed. PATCH this path to turn one on or off.

boolean

**name**

required

string

<= 80 characters

**match**

required

How to recognise the field: words its label or name contains (3 to 100 characters, or 2 in Chinese, Japanese or Korean), with up to 9 more phrases in also, such as its label in other languages; or its exact test ID, name or id attribute; or, for a ready-made custom field, kind with its section as text. Saving replaces the custom field, so send every phrase to keep.

### object

**on**

required

string

Allowed values: words test\_id name html\_id kind

**text**

required

string

<= 100 characters

**also**

Words only: more phrases that recognise the same field, such as its label in the site’s other languages.

Array<string>

<= 9 items

**site**

Its host or a site pattern, such as staging.acme.dev or https://_.acme.dev/_, or null for every site. It needn’t be one of the project’s sites yet; a blocked site is refused.

string | null

<= 300 characters

**path**

A page path such as /signup. It covers /signup, /signup/business and the same page under a language, such as /de/signup. Leave it out, or send null, for every page of the site.

string | null

<= 200 characters

**field\_type**

string | null

Allowed values: text textarea number select checkbox radio

**value**

required

What goes in the field. text: { text }. template: { template } with {first\_name}, {last\_name}, {full\_name}, {username}, {email}, {company}, {country} or {digits:N} (N from 1 to 12). option: { option }, the option to pick. list: { items }, 2 to 20, one picked for each account. options: { options }, 1 to 20, every one for every account: ticks the boxes of a group (matched by their shared name or words in the question they answer) or selects them in a drop-down that takes several answers, and boxes not listed are unticked, though a consent box, a marketing box or a box with its own custom field is left as it is. Never a radio group. checkbox: { checked }. generate: Proxy Mail QA makes up a value that suits the field (the same for the same account), on any field but a checkbox, never a personal ID field. leave: leave the field as it is. ready\_made: { section }, matched on kind (or test\_id when a sign-up form made it), Proxy Mail QA’s own safe value, where it has one: phone (a number set aside for fiction, or `phones`: the team’s own test number per country), id.national, id.tax, id.passport, business.vat and business.tax (a fake value only where one can never be a real person’s, or `ids_from`: a KYC vendor’s sandbox values), gender, referral\_source, language, business.role, business.team\_size and business.type (one of the field’s options) and consent.terms (ticked unless `checked` is false).

### object

**kind**

required

string

Allowed values: text template option list options checkbox generate leave ready\_made

**text**

string

<= 200 characters

**template**

string

<= 200 characters

**option**

string

<= 100 characters

**items**

Array<string>

\>= 2 items <= 20 items

**options**

Array<string>

\>= 1 items <= 20 items

**checked**

Checkbox, or ready\_made consent.terms (true by default).

boolean

**section**

Ready\_made only: the field catalogue section it fills.

string

Allowed values: phone id.national id.tax id.passport business.vat business.tax gender referral\_source language business.role business.team\_size business.type consent.terms

**ids\_from**

Ready\_made ID and tax numbers only: safe (the default) or a KYC vendor’s sandbox values.

string

Allowed values: safe stripe plaid onfido veriff didit cashfree setu

**phones**

Ready\_made phone only: the team’s own test numbers, one per country, for accounts in countries with no numbers set aside for fiction. Never a real person’s number.

Array<object>

<= 20 items

### object

**country**

required

string

/^\[A-Za-z\]{2}$/

**number**

required

4 to 30 digits, spaces, brackets or dashes, with an optional leading +.

string

<= 30 characters

**tag\_answer**

An option or one of a list only: tag the account with the answer.

boolean

**request**

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

**id**

required

string format: uuid

**kind**

required

string

Allowed values: save\_custom\_field delete\_custom\_field add\_site remove\_site set\_guesses set\_multi\_step save\_signup\_screen remove\_signup\_screen set\_custom\_field\_enabled set\_standard\_field save\_signup\_form

**target\_id**

required

The custom field, site, sign-up screen or sign-up form it changes, if any.

string | null format: uuid

**summary**

required

The custom field’s name, the site, the screen, or the setting’s new choice.

string

**change**

required

What it changes, as it applies once a lead approves it.

### object

**note**

required

What the person who asked wrote for the leads.

string | null

**status**

required

string

Allowed values: requested approved declined withdrawn expired unlocked

**reason**

required

A lead’s reason for declining.

string | null

#### Example 

```json
{
  "status": "saved",
  "created_via": "app",
  "spec": {
    "version": 1,
    "screens": [
      {
        "fields": [
          {
            "options": {
              "type": "text",
              "classes": [
                "lower"
              ]
            }
          }
        ]
      }
    ]
  },
  "custom_fields": [
    {
      "name": "Company size",
      "match": {
        "on": "words"
      },
      "site": "https://staging.acme.dev/*",
      "path": "/signup",
      "field_type": "text",
      "value": {
        "kind": "text",
        "section": "phone",
        "ids_from": "safe",
        "phones": [
          {
            "country": "IN"
          }
        ]
      }
    }
  ],
  "fills": [
    {
      "fill": "built_in"
    }
  ],
  "requested": {
    "spec": {
      "version": 1,
      "screens": [
        {
          "fields": [
            {
              "options": {
                "type": "text",
                "classes": [
                  "lower"
                ]
              }
            }
          ]
        }
      ]
    },
    "custom_fields": [
      {
        "name": "Company size",
        "match": {
          "on": "words"
        },
        "site": "https://staging.acme.dev/*",
        "path": "/signup",
        "field_type": "text",
        "value": {
          "kind": "text",
          "section": "phone",
          "ids_from": "safe",
          "phones": [
            {
              "country": "IN"
            }
          ]
        }
      }
    ]
  },
  "request": {
    "kind": "save_custom_field",
    "status": "requested"
  }
}
```

### 400

An error

Media typeapplication/json

### object

**error**

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).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

```json
{
  "error": "example",
  "message": "example"
}
```

### 401

No API key, or one that isn’t valid: it may have been revoked, or its creator no longer has access to the project.

Media typeapplication/json

### object

**error**

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).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

```json
{
  "error": "example",
  "message": "example"
}
```

#### Headers

**WWW-Authenticate**

string

`Bearer realm="proxymail-qa"`, with `error="invalid_token"` when a key was sent but isn’t valid.

### 403

An error

Media typeapplication/json

### object

**error**

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).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

```json
{
  "error": "example",
  "message": "example"
}
```

### 404

An error

Media typeapplication/json

### object

**error**

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).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

```json
{
  "error": "example",
  "message": "example"
}
```

### 429

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.

Media typeapplication/json

### object

**error**

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).

string

**message**

What went wrong and what to do, in words.

string

#### Example generated

```json
{
  "error": "example",
  "message": "example"
}
```

#### Headers

**Retry-After**

integer

\>= 1

Seconds to wait before trying again. Sent with per-minute limits only.

[Previous](https://proxymail.qa/docs/reference/operations/savesignupform.html): Save a sign-up form

[Next](https://proxymail.qa/docs/reference/operations/deletesignupform.html): Remove a sign-up form
