social.colibri.beta.community.listBans

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Lists the members currently banned from a community. Being banned means the community declines to issue them space credentials, so they cannot read it. Their existing messages stay in their own repos.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The caller lacks the member.ban permission.",
          "name": "Forbidden"
        },
        {
          "description": "No community exists at the given DID.",
          "name": "CommunityNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "bans": {
              "description": "Members currently banned, most recently banned first.",
              "items": {
                "description": "A ban.",
                "ref": "social.colibri.beta.community.defs#bannedActorView",
                "type": "ref"
              },
              "type": "array"
            },
            "cursor": {
              "description": "Pagination cursor for the next page, if more bans exist.",
              "type": "string"
            }
          },
          "required": [
            "bans"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "community": {
            "description": "The community to list bans for.",
            "format": "did",
            "type": "string"
          },
          "cursor": {
            "description": "Pagination cursor from a previous response.",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "description": "Maximum number of bans to return.",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "community"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "social.colibri.beta.community.listBans",
  "lexicon": 1
}