# social.colibri.actor.getDeletionStatus

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.getDeletionStatus)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.getDeletionStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.getDeletionStatus/examples)

## Definitions

### `social.colibri.actor.getDeletionStatus`

**Type**: `query`

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

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `counts` | `ref` → `lex:social.colibri.actor.getDeletionStatus#deletionCounts` | Yes |  |
| `pdsAccountPage` | `string` (uri) | No | The account page the caller's PDS serves at /account, when it serves one. Absent otherwise. |
| `soleOwnedCommunities` | `array` | Yes | Communities the user is the only owner of. Deletion is blocked while this is non-empty. |

#### Errors

- **AuthRequired**: Missing, malformed, or unverifiable service auth.

### `social.colibri.actor.getDeletionStatus#deletionCounts`

**Type**: `object`

Row counts the AppView holds for the authenticated user.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `records` | `integer` | Yes |  |
| `invitations` | `integer` | Yes |  |
| `notifications` | `integer` | Yes |  |
| `pushSubscriptions` | `integer` | Yes |  |

### `social.colibri.actor.getDeletionStatus#soleOwnedCommunity`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes |  |
| `name` | `string` | Yes |  |
| `picture` | `blob` | No |  |
| `memberCount` | `integer` | Yes |  |

## Raw Schema

```json
{
  "id": "social.colibri.actor.getDeletionStatus",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "Missing, malformed, or unverifiable service auth."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "soleOwnedCommunities",
            "counts"
          ],
          "properties": {
            "counts": {
              "ref": "lex:social.colibri.actor.getDeletionStatus#deletionCounts",
              "type": "ref"
            },
            "pdsAccountPage": {
              "type": "string",
              "format": "uri",
              "description": "The account page the caller's PDS serves at /account, when it serves one. Absent otherwise."
            },
            "soleOwnedCommunities": {
              "type": "array",
              "items": {
                "ref": "lex:social.colibri.actor.getDeletionStatus#soleOwnedCommunity",
                "type": "ref"
              },
              "description": "Communities the user is the only owner of. Deletion is blocked while this is non-empty."
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Reports whether the authenticated user's Colibri data can be deleted, and how much data deletion would remove."
    },
    "deletionCounts": {
      "type": "object",
      "required": [
        "records",
        "notifications",
        "pushSubscriptions",
        "invitations"
      ],
      "properties": {
        "records": {
          "type": "integer"
        },
        "invitations": {
          "type": "integer"
        },
        "notifications": {
          "type": "integer"
        },
        "pushSubscriptions": {
          "type": "integer"
        }
      },
      "description": "Row counts the AppView holds for the authenticated user."
    },
    "soleOwnedCommunity": {
      "type": "object",
      "required": [
        "uri",
        "name",
        "memberCount"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "name": {
          "type": "string"
        },
        "picture": {
          "type": "blob"
        },
        "memberCount": {
          "type": "integer"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```