place.wisp.v2.site.getList

wisp.place

Documentation

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

main query

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

Output

Encodingapplication/json

sites array Required

No description available.

Errors

AuthenticationRequired

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "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 object

No description available.

Properties

domain string Required

No description available.

maxLength: 253 bytesminLength: 3 bytes

kind string Required

No description available.

status string Required

No description available.

verified boolean Required

No description available.

View raw schema

{
  "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 object

No description available.

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

displayName string Optional

No description available.

maxLength: 200 bytes

domains array of ref#siteDomain Required

No description available.

siteRkey string record-key Required

A valid record key for AT Protocol repositories.

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema

{
  "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
    }
  }
}