place.wisp.v2.privateSite.listShares

wisp.place

Documentation

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

main query

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

Parameters

siteId string record-key Required

A valid record key for AT Protocol repositories.

Output

Encodingapplication/json
shares array Required

No description available.

Errors

AuthenticationRequired
NotFound
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
A valid record key for AT Protocol repositories.
View raw schema 
{
  "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 object

No description available.

Properties

audienceDid string did Optional

Set when this link is restricted to a single account.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

expiresAt string datetime Optional

An RFC 3339 formatted timestamp.

label string Optional

No description available.

lastUsedAt string datetime Optional

An RFC 3339 formatted timestamp.

revokedAt string datetime Optional

An RFC 3339 formatted timestamp.

shareId string Required

No description available.

status string Required

No description available.

tokenPrefix string Required

Non-secret leading fragment, for identification only.

View raw schema 
{
  "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"
}

Lexicon Garden

@