social.colibri.actor.getDeletionStatus

colibri.social

Documentation

Reports whether the authenticated user's Colibri data can be deleted, and how much data deletion would remove.

main query

Reports whether the authenticated user's Colibri data can be deleted, and how much data deletion would remove.

Output

Encodingapplication/json
pdsAccountPage stringuri Optional

The account page the caller's PDS serves at /account, when it serves one. Absent otherwise.

soleOwnedCommunities array Required

Communities the user is the only owner of. Deletion is blocked while this is non-empty.

Errors

AuthRequired Missing, malformed, or unverifiable service auth.
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)
View raw schema 
{
  "description": "Reports whether the authenticated user's Colibri data can be deleted, and how much data deletion would remove.",
  "errors": [
    {
      "description": "Missing, malformed, or unverifiable service auth.",
      "name": "AuthRequired"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "counts": {
          "ref": "lex:social.colibri.actor.getDeletionStatus#deletionCounts",
          "type": "ref"
        },
        "pdsAccountPage": {
          "description": "The account page the caller's PDS serves at /account, when it serves one. Absent otherwise.",
          "format": "uri",
          "type": "string"
        },
        "soleOwnedCommunities": {
          "description": "Communities the user is the only owner of. Deletion is blocked while this is non-empty.",
          "items": {
            "ref": "lex:social.colibri.actor.getDeletionStatus#soleOwnedCommunity",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "soleOwnedCommunities",
        "counts"
      ],
      "type": "object"
    }
  },
  "type": "query"
}
deletionCounts object

Row counts the AppView holds for the authenticated user.

Properties

invitations integer Required

No description available.

notifications integer Required

No description available.

pushSubscriptions integer Required

No description available.

records integer Required

No description available.

View raw schema 
{
  "description": "Row counts the AppView holds for the authenticated user.",
  "properties": {
    "invitations": {
      "type": "integer"
    },
    "notifications": {
      "type": "integer"
    },
    "pushSubscriptions": {
      "type": "integer"
    },
    "records": {
      "type": "integer"
    }
  },
  "required": [
    "records",
    "notifications",
    "pushSubscriptions",
    "invitations"
  ],
  "type": "object"
}
soleOwnedCommunity object

No description available.

Properties

memberCount integer Required

No description available.

name string Required

No description available.

picture blob Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "properties": {
    "memberCount": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "picture": {
      "type": "blob"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "name",
    "memberCount"
  ],
  "type": "object"
}

Lexicon Garden

@