com.getorbyt.community.listMembers Documentation (EN)

main query

A Community's members. Anyone may list active members; listing muted or banned members requires a moderator role.

Parameters

community string at-uri Required

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

cursor string Optional

No description available.

limit integer Optional

No description available.

role string Optional

No description available.

status string Optional

No description available.

Output

Encodingapplication/json

cursor string Optional

No description available.

members array Required

No description available.

Errors

CommunityNotFound

InsufficientRole

InvalidCursor

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

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

cursor

limit

role

status

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "CommunityNotFound"
    },
    {
      "name": "InsufficientRole"
    },
    {
      "name": "InvalidCursor"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "members"
      ],
      "properties": {
        "cursor": {
          "type": "string"
        },
        "members": {
          "type": "array",
          "items": {
            "ref": "com.getorbyt.community.defs#memberView",
            "type": "ref"
          },
          "maxLength": 50
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "community"
    ],
    "properties": {
      "role": {
        "type": "string",
        "knownValues": [
          "owner",
          "moderator",
          "member"
        ]
      },
      "limit": {
        "type": "integer",
        "default": 25,
        "maximum": 50,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      },
      "status": {
        "type": "string",
        "knownValues": [
          "active",
          "muted",
          "banned"
        ]
      },
      "community": {
        "type": "string",
        "format": "at-uri"
      }
    }
  },
  "description": "A Community's members. Anyone may list active members; listing muted or banned members requires a moderator role."
}