# place.wisp.v2.privateSite.list

> 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.privateSite.list)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.privateSite.list/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.privateSite.list/examples)

## Definitions

### `place.wisp.v2.privateSite.list`

**Type**: `query`

List private sites owned by the authenticated account. Only ever returns the caller's own sites.

#### Output

**Encoding**: `application/json`

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

#### Errors

- **AuthenticationRequired**

### `place.wisp.v2.privateSite.list#privateSiteSummary`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes |  |
| `expired` | `boolean` | Yes |  |
| `expiresAt` | `string` (datetime) | No |  |
| `fileCount` | `integer` | Yes |  |
| `name` | `string` | Yes |  |
| `shareCount` | `integer` | Yes | Number of share links that currently grant access. |
| `siteId` | `string` (record-key) | Yes |  |
| `totalBytes` | `integer` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "List private sites owned by the authenticated account. Only ever returns the caller's own sites.",
      "errors": [
        {
          "name": "AuthenticationRequired"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "sites": {
              "items": {
                "ref": "#privateSiteSummary",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "sites"
          ],
          "type": "object"
        }
      },
      "type": "query"
    },
    "privateSiteSummary": {
      "properties": {
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "expired": {
          "type": "boolean"
        },
        "expiresAt": {
          "format": "datetime",
          "type": "string"
        },
        "fileCount": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "shareCount": {
          "description": "Number of share links that currently grant access.",
          "type": "integer"
        },
        "siteId": {
          "format": "record-key",
          "type": "string"
        },
        "totalBytes": {
          "type": "integer"
        }
      },
      "required": [
        "siteId",
        "name",
        "fileCount",
        "totalBytes",
        "createdAt",
        "shareCount",
        "expired"
      ],
      "type": "object"
    }
  },
  "id": "place.wisp.v2.privateSite.list",
  "lexicon": 1
}
```