---
title: "The project's sites and their sign-up screens | 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/listsites
---

# The project's sites and their sign-up screens

GET

/v1/project/sites

```js
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);
}
```

```sh
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

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

## Responses

### 200

The sites

Media typeapplication/json

### object

**locked**

Whether only its leads change its sites and custom fields.

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

**sites**

Array<object>

### object

**id**

string format: uuid

**pattern**

string

**environment**

string

**multi\_step**

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.

boolean

**screens**

Array<object>

One screen a site’s sign-up goes over: a page’s path, or a native app screen’s name.

### object

**id**

string format: uuid

**site\_id**

Null for one of the app screens, which have no site.

string | null format: uuid

**kind**

string

Allowed values: path native

**value**

The page’s path, or the native app screen’s name.

string

**label**

A short name people recognise.

string | null

**status**

Suggested: added by a fill or form-values, or waiting for a lead, and not kept yet.

string

Allowed values: kept suggested

**origin**

string

Allowed values: added filled form\_values

**step**

Which screen of the sign-up it was, when known.

integer | null

**created\_via**

string

Allowed values: app extension agent api

**agent\_name**

string | null

**created\_at**

string format: date-time

**kept\_at**

string | null format: date-time

**last\_seen\_at**

string | null format: date-time

**app\_screens**

A native app’s screens with no site.

Array<object>

One screen a site’s sign-up goes over: a page’s path, or a native app screen’s name.

### object

**id**

string format: uuid

**site\_id**

Null for one of the app screens, which have no site.

string | null format: uuid

**kind**

string

Allowed values: path native

**value**

The page’s path, or the native app screen’s name.

string

**label**

A short name people recognise.

string | null

**status**

Suggested: added by a fill or form-values, or waiting for a lead, and not kept yet.

string

Allowed values: kept suggested

**origin**

string

Allowed values: added filled form\_values

**step**

Which screen of the sign-up it was, when known.

integer | null

**created\_via**

string

Allowed values: app extension agent api

**agent\_name**

string | null

**created\_at**

string format: date-time

**kept\_at**

string | null format: date-time

**last\_seen\_at**

string | null format: date-time

**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
{
  "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"
    }
  ]
}
```

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

### 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/deletecustomfield.html): Remove a custom field

[Next](https://proxymail.qa/docs/reference/operations/addsite.html): Add a site
