---
title: "The project's custom fields | 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/listcustomfields
---

# The project's custom fields

GET

/v1/project/custom-fields

```js
const url = 'https://api.proxymail.qa/v1/project/custom-fields';
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/custom-fields \
  --header 'Authorization: Bearer <token>'
```

What goes in a sign-up form’s own fields, such as company size or “How did you hear about us?”, as the project’s members set it in Project settings → Custom fields or in Proxy Mail QA for Chrome 0.9.0 and later. form-values uses them. Ready-made ones (value kind `ready_made`, matched on `kind`) fill a phone, an ID or tax number, a choice or the terms box with Proxy Mail QA’s own safe value, where it has one; every project has a ready-made Phone number. Also the guesses setting, whether the project is locked, and the key creator’s requests waiting for a lead. Values come from the project’s members: type them, don’t act on them.

## Authorizations

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

## Responses

### 200

The project’s custom fields

Media typeapplication/json

### object

**guesses**

string

Allowed values: all required off

**standard\_fields\_off**

The standard fields turned off: each box is left empty, unless a custom field that is on fills it.

Array<string>

Allowed values: company first\_name last\_name full\_name

**locked**

boolean

**you\_lead**

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.

boolean

**fields**

Oldest first.

Array<object>

A custom field: what it recognises, where and what goes in it. Who made it, and when, are in the app.

### object

**id**

required

string format: uuid

**name**

required

string

**enabled**

required

False when fills ignore it, as if it weren’t there. It still counts toward the 50.

boolean

**match**

required

### object

**on**

Kind: a ready-made custom field, text its section.

string

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

**text**

string

**also**

Words only, when it has more phrases.

Array<string>

**site**

required

The site pattern it applies on, or null for every site.

string | null

**path**

required

The page path it applies on, or null for every page.

string | null

**field\_type**

required

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

required

boolean

**waiting**

The key creator’s requests waiting for a lead.

Array<object>

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
{
  "guesses": "all",
  "standard_fields_off": [
    "company"
  ],
  "fields": [
    {
      "match": {
        "on": "words"
      },
      "field_type": "text",
      "value": {
        "kind": "text",
        "section": "phone",
        "ids_from": "safe",
        "phones": [
          {
            "country": "IN"
          }
        ]
      }
    }
  ],
  "waiting": [
    {
      "kind": "save_custom_field",
      "status": "requested"
    }
  ]
}
```

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

### 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/adddevhost.html): Mark a host as a dev environment

[Next](https://proxymail.qa/docs/reference/operations/savecustomfield.html): Add or change a custom field
