# place.wisp.v2.site.getList

> Published by [wisp.place](https://lexicon.garden/identity/did:plc:7puq73yz2hkvbcpdhnsze2qw)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.site.getList)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.site.getList/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.site.getList/examples)

## Definitions

### `place.wisp.v2.site.getList`

**Type**: `query`

List owned sites and the domains currently mapped to each site.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `sites` | `array` | Yes |  |

#### Errors

- **AuthenticationRequired**

### `place.wisp.v2.site.getList#siteDomain`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `kind` | `string` | Yes |  |
| `domain` | `string` | Yes |  |
| `status` | `string` | Yes |  |
| `verified` | `boolean` | Yes |  |

### `place.wisp.v2.site.getList#siteSummary`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `domains` | `array` | Yes |  |
| `siteRkey` | `string` (record-key) | Yes |  |
| `createdAt` | `string` (datetime) | No |  |
| `updatedAt` | `string` (datetime) | No |  |
| `displayName` | `string` | No |  |

## Raw Schema

```json
{
  "id": "place.wisp.v2.site.getList",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthenticationRequired"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "sites"
          ],
          "properties": {
            "sites": {
              "type": "array",
              "items": {
                "ref": "#siteSummary",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "List owned sites and the domains currently mapped to each site."
    },
    "siteDomain": {
      "type": "object",
      "required": [
        "domain",
        "kind",
        "status",
        "verified"
      ],
      "properties": {
        "kind": {
          "enum": [
            "wisp",
            "custom"
          ],
          "type": "string"
        },
        "domain": {
          "type": "string",
          "maxLength": 253,
          "minLength": 3
        },
        "status": {
          "enum": [
            "pendingVerification",
            "verified"
          ],
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        }
      }
    },
    "siteSummary": {
      "type": "object",
      "required": [
        "siteRkey",
        "domains"
      ],
      "properties": {
        "domains": {
          "type": "array",
          "items": {
            "ref": "#siteDomain",
            "type": "ref"
          }
        },
        "siteRkey": {
          "type": "string",
          "format": "record-key"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "updatedAt": {
          "type": "string",
          "format": "datetime"
        },
        "displayName": {
          "type": "string",
          "maxLength": 200
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```