---
title: "A sign-up form as code | 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/getsignupformcode
---

# A sign-up form as code

GET

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

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

```sh
curl --request GET \
  --url 'https://api.proxymail.qa/v1/project/signup-forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/code?format=react-hook-form&requested=false' \
  --header 'Authorization: Bearer <token>'
```

The form as code to put in your app: React with react-hook-form and zod (the default), React with plain state, or one HTML page. Each field checks what the spec asks for (the password’s rules, an age, an ID’s format and check digit), with messages in the form’s language and the `data-testid` its custom fields match.

## 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

### Query Parameters

**format**

string

default: react-hook-form

Allowed values: react-hook-form react html

**requested**

boolean

True for the change waiting for a lead.

## Responses

### 200

The code

Media typeapplication/json

### object

**form**

### object

**id**

string format: uuid

**name**

string

**status**

string

Allowed values: saved requested draft

**format**

string

Allowed values: react-hook-form react html

**files**

Array<object>

### object

**path**

string

**contents**

string

**dependencies**

The npm packages the code imports.

Array<string>

**notes**

What to know before putting it in, such as answers to set.

Array<string>

#### Example 

```json
{
  "form": {
    "status": "saved"
  },
  "format": "react-hook-form",
  "files": [
    {
      "path": "SignupForm.tsx"
    }
  ]
}
```

### 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"
}
```

### 405

The path doesn’t take this method.

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

**Allow**

string

The methods it takes, such as `GET, PATCH`.

### 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/deletesignupform.html): Remove a sign-up form

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