# place.wisp.v2.privateSite.listShares

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

## Definitions

### `place.wisp.v2.privateSite.listShares`

**Type**: `query`

List share links for an owned private site. Never returns share tokens, only their non-secret display prefix.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `siteId` | `string` (record-key) | Yes |  |

#### Output

**Encoding**: `application/json`

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

#### Errors

- **AuthenticationRequired**
- **NotFound**

### `place.wisp.v2.privateSite.listShares#share`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `audienceDid` | `string` (did) | No | Set when this link is restricted to a single account. |
| `createdAt` | `string` (datetime) | Yes |  |
| `expiresAt` | `string` (datetime) | No |  |
| `label` | `string` | No |  |
| `lastUsedAt` | `string` (datetime) | No |  |
| `revokedAt` | `string` (datetime) | No |  |
| `shareId` | `string` | Yes |  |
| `status` | `string` | Yes |  |
| `tokenPrefix` | `string` | Yes | Non-secret leading fragment, for identification only. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "List share links for an owned private site. Never returns share tokens, only their non-secret display prefix.",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "NotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "shares": {
              "items": {
                "ref": "#share",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "shares"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "siteId": {
            "format": "record-key",
            "type": "string"
          }
        },
        "required": [
          "siteId"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "share": {
      "properties": {
        "audienceDid": {
          "description": "Set when this link is restricted to a single account.",
          "format": "did",
          "type": "string"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "expiresAt": {
          "format": "datetime",
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "lastUsedAt": {
          "format": "datetime",
          "type": "string"
        },
        "revokedAt": {
          "format": "datetime",
          "type": "string"
        },
        "shareId": {
          "type": "string"
        },
        "status": {
          "enum": [
            "active",
            "expired",
            "revoked"
          ],
          "type": "string"
        },
        "tokenPrefix": {
          "description": "Non-secret leading fragment, for identification only.",
          "type": "string"
        }
      },
      "required": [
        "shareId",
        "tokenPrefix",
        "createdAt",
        "status"
      ],
      "type": "object"
    }
  },
  "id": "place.wisp.v2.privateSite.listShares",
  "lexicon": 1
}
```