# social.colibri.beta.community.listBans

> 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.beta.community.listBans)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.community.listBans/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.community.listBans/examples)

## Definitions

### `social.colibri.beta.community.listBans`

**Type**: `query`

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.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of bans to return. |
| `cursor` | `string` | No | Pagination cursor from a previous response. |
| `community` | `string` (did) | Yes | The community to list bans for. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `bans` | `array` | Yes | Members currently banned, most recently banned first. |
| `cursor` | `string` | No | Pagination cursor for the next page, if more bans exist. |

#### Errors

- **AuthRequired**: The request is missing, malformed, or unverifiable service auth.
- **Forbidden**: The caller lacks the member.ban permission.
- **CommunityNotFound**: No community exists at the given DID.

## Raw Schema

```json
{
  "id": "social.colibri.beta.community.listBans",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "The request is missing, malformed, or unverifiable service auth."
        },
        {
          "name": "Forbidden",
          "description": "The caller lacks the member.ban permission."
        },
        {
          "name": "CommunityNotFound",
          "description": "No community exists at the given DID."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "bans"
          ],
          "properties": {
            "bans": {
              "type": "array",
              "items": {
                "ref": "social.colibri.beta.community.defs#bannedActorView",
                "type": "ref",
                "description": "A ban."
              },
              "description": "Members currently banned, most recently banned first."
            },
            "cursor": {
              "type": "string",
              "description": "Pagination cursor for the next page, if more bans exist."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "community"
        ],
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "description": "Maximum number of bans to return."
          },
          "cursor": {
            "type": "string",
            "description": "Pagination cursor from a previous response."
          },
          "community": {
            "type": "string",
            "format": "did",
            "description": "The community to list bans for."
          }
        }
      },
      "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```