social.colibri.beta.community.listBans

colibri.social

Documentation

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.

main 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

community string did Required

The community to list bans for.

cursor string Optional

Pagination cursor from a previous response.

limit integer Optional

Maximum number of bans to return.

Output

Encodingapplication/json
bans array Required

Members currently banned, most recently banned first.

cursor string Optional

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.
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)
Parameters
The community to list bans for.
Pagination cursor from a previous response.
Maximum number of bans to return.
View raw schema 
{
  "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."
}

Lexicon Garden

@